Function PutTransferAreaMunicipalities
ΛΕΞΙΚΟ : Ενημέρωση Συσχέτισης Περιοχής Μετάθεσης με Δήμο
Η συνάρτηση ενημερώνει Συσχέτιση
Περιοχής Μετάθεσης με Δήμο σύμφωνα με τις
παραμέτρους που έγινε η κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο PUT και
route_api_name = transfer_area_municipalities :
https://mm.sch.gr/api/transfer_area_municipalities
Ορισμός Μοναδικών Τιμών
Παραμέτρων
Παρακάτω ορίζονται οι παραμέτροι που έχουν
μοναδικές τιμές και πραγματοποιειται
ελεγχος πριν κάθε καταχώρηση:
- transfer_area_municipality_id
Πίνακας Παραμέτρων
- Στον Πίνακα Παραμέτρων Parameters summary εμφανίζονται όλοι οι παράμετροι με τους οποίους μπορεί να γίνει η κλήση της συνάρτησης.
- Όλοι οι παράμετροι είναι προαιρετικοί εκτός από αυτές που έχουν χαρακτηριστεί ως υποχρεωτικοί.
- Οι παράμετροι μπορούν να χρησιμοποιηθούν με οποιαδήποτε σειρά.
Πίνακας Αποτελεσμάτων
- Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση.
- Όλες οι μεταβλητές επιστρέφονται σε JSON objects.
- Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα.
Πίνακας Σφαλμάτων
- Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης.
- Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (
ExceptionMessages
) και Κωδικοί Σφαλμάτων (ExceptionCodes
) αντίστοιχα.
Παραδείγματα Κλήσης
- Υπάρχουν διαθέσιμα παραδείγματα κλήσης
της συνάρτησης με διάφορους τρόπους (
ApiRequestExamples
).
Μηνύματα Authentication/Authorization
- Υπάρχουν αναλυτικές πληροφορίες για τα
μηνύματα Authentication/Authorization (
AuthMessages
).
Δεδομένα Επιστροφής
Παρακάτω εμφανίζονται τα
αποτελέσματα σε μορφή JSON :
{ "controller": "PutTransferAreaMunicipalities", "function": "transfer_area_municipalities", "method": "PUT", "parameters": { "transfer_area_municipality_id": ``,"transfer_area": ``,"municipality": `` }, "transfer_area_municipality_id": ``, "status": 200, "message": "[PUT][transfer_area_municipalities]:success" }
integer |
$transfer_area_municipality_id |
ID Συσχέτισης Περιοχής Μετάθεσης με Δήμο Ο Κωδικός ID της Συσχέτισης Περιοχής Μετάθεσης με Δήμο Η παράμετρος είναι υποχρεωτική ID Συσχέτισης Περιοχής Μετάθεσης με Δήμο : GetTransferAreaMunicipalities() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
integer|string |
$transfer_area |
Όνομα ή ID Περιοχής Μετάθεσης Το Όνομα ή ο Κωδικός ID της Περιοχής Μετάθεσης Η παράμετρος είναι υποχρεωτική Όνομα ή ID Περιοχής Μετάθεσης : GetTransferAreas() Η τιμή της παραμέτρου μπορεί να είναι : integer|string
|
integer|string |
$municipality |
Όνομα ή ID Δήμου ΟΤΑ Το Όνομα ή ο Κωδικός ID του Δήμου ΟΤΑ Η παράμετρος είναι υποχρεωτική Όνομα ή ID Δήμου ΟΤΑ : GetMunicipalities() Η τιμή της παραμέτρου μπορεί να είναι : integer|string
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης array : parameters : Οι παράμετροι που δίνει ο χρήστης integer : transfer_area_municipality_id : Ο Κωδικός ID της Συσχέτισης Περιοχής Μετάθεσης με Δήμο που ενημερώθηκε integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |