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