Function PutWorkers
Ενημέρωση Στοιχείων Εργαζόμενου
Η συνάρτηση ενημερώνει Στοιχεία
Εργαζόμενου σύμφωνα με τις παραμέτρους που
έγινε η κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο PUT και
route_api_name = workers :
https://mm.sch.gr/api/workers
Ορισμός Μοναδικών Τιμών
Παραμέτρων
Παρακάτω ορίζονται οι παραμέτροι που έχουν
μοναδικές τιμές και πραγματοποιειται
ελεγχος πριν κάθε καταχώρηση:
- worker_id
- registry_no
Πίνακας Παραμέτρων
- Στον Πίνακα Παραμέτρων Parameters summary εμφανίζονται όλοι οι παράμετροι με τους οποίους μπορεί να γίνει η κλήση της συνάρτησης.
- Όλοι οι παράμετροι είναι προαιρετικοί εκτός από αυτές που έχουν χαρακτηριστεί ως υποχρεωτικοί.
- Οι παράμετροι μπορούν να χρησιμοποιηθούν με οποιαδήποτε σειρά.
Πίνακας Αποτελεσμάτων
- Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση.
- Όλες οι μεταβλητές επιστρέφονται σε JSON objects.
- Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα.
Πίνακας Σφαλμάτων
- Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης.
- Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (
ExceptionMessages) και Κωδικοί Σφαλμάτων (ExceptionCodes) αντίστοιχα.
Παραδείγματα Κλήσης
- Υπάρχουν διαθέσιμα παραδείγματα κλήσης
της συνάρτησης με διάφορους τρόπους (
ApiRequestExamples).
Μηνύματα Authentication/Authorization
- Υπάρχουν αναλυτικές πληροφορίες για τα
μηνύματα Authentication/Authorization (
AuthMessages).
Δεδομένα Επιστροφής
Παρακάτω εμφανίζονται τα
αποτελέσματα σε μορφή JSON :
{
"controller": "PutWorkers",
"function": "workers",
"method": "PUT",
"parameters": { "worker_id": ``, "registry_no": ``, "lastname": ``,
"firstname": ``, "fathername": ``, "sex": ``,
"tax_number": ``, "worker_specialization": ``, "source": `` },
"worker_id": ``,
"status": 200,
"message": "[PUT][workers]:success"
}
integer |
$worker_id |
ID Εργαζόμενου Ο Κωδικός ID του Εργαζόμενου Η παράμετρος είναι υποχρεωτική ID Εργαζόμενου : GetWorkers()Η τιμή της παραμέτρου μπορεί να είναι : integer
|
date |
$registry_no |
Αριθμός Μητρώου Ο Αριθμός Μητρώου του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$lastname |
Επώνυμο Το Επώνυμο του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$firstname |
Όνομα Το Όνομα του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$fathername |
Πατρώνυμο Το Πατρώνυμο του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$sex |
Φύλο Το Φύλο του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$tax_number |
Αριθμός Φορολογικού Μητρώου Ο Αριθμός Φορολογικού Μητρώου του Εργαζόμενου Η τιμή της παραμέτρου μπορεί να είναι : string |
integer|string |
$worker_specialization |
Όνομα ή ID Ειδικότητας Το Όνομα ή ο Κωδικός ID της Ειδικότητας Εργαζόμενου Όνομα ή ID Ειδικότητας Εργαζόμενου : GetWorkerSpecializations()Η τιμή της παραμέτρου μπορεί να είναι : integer|string
|
integer|string |
$source |
Όνομα ή ID Πρωτογενής Πηγή Το Όνομα ή ο Κωδικός ID της Πρωτογενής Πηγής Η παράμετρος είναι υποχρεωτική Όνομα ή ID Ειδικότητας Εργαζόμενου : GetSources()Η τιμή της παραμέτρου μπορεί να είναι : integer|string
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης array : parameters : Οι παράμετροι που δίνει ο χρήστης integer : worker_id : Ο Κωδικός ID του Εργαζόμενου που ενημερώθηκε integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |