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