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