Function CheckRequiredValues
Εύρεση Κενών Τιμών σε Μονάδες
Η συνάρτηση αυτή επιστρέφει τις Μονάδες
με κενές τιμές σε "υποχρεωτικά" πεδία των
στοιχείων τους, σύμφωνα με τις παραμέτρους
που έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο GET και
route_api_name = check_required_values :
https://mm.sch.gr/api/check_required_values
Πίνακας Παραμέτρων
- Στον Πίνακα Παραμέτρων Parameters summary εμφανίζονται όλοι οι παράμετροι με τους οποίους μπορεί να γίνει η κλήση της συνάρτησης.
- Όλοι οι παράμετροι είναι προαιρετικοί εκτός από αυτές που έχουν χαρακτηριστεί ως υποχρεωτικοί.
- Οι παράμετροι μπορούν να χρησιμοποιηθούν με οποιαδήποτε σειρά.
- Οι παράμετροι οι οποίοι έχουν το χαρακτηριστικό (Συνδυάζεται με την παράμετρο searchtype) σημαίνει ότι η συγκεκριμένη παράμετρος συνδυάζεται με την παράμετρο searchtype.
- Οι παράμετροι μπορούν να πάρουν τιμή "NULL" για να αναζητήσουν τις κενές εγγραφές στα αντίστοιχα πεδία
Πίνακας Αποτελεσμάτων
- Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση.
- Όλες οι μεταβλητές επιστρέφονται σε JSON objects.
- Η μεταβλητή data είναι ο πίνακας με τα δεδομένα.
- Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα.
Πίνακας Σφαλμάτων
- Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης.
- Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (
ExceptionMessages
) και Κωδικοί Σφαλμάτων (ExceptionCodes
) αντίστοιχα.
Παραδείγματα Κλήσης
- Υπάρχουν διαθέσιμα παραδείγματα κλήσης
της συνάρτησης με διάφορους τρόπους (
ApiRequestExamples
).
Μηνύματα Authentication/Authorization
- Υπάρχουν αναλυτικές πληροφορίες για τα
μηνύματα Authentication/Authorization (
AuthMessages
).
Δεδομένα Επιστροφής
Παρακάτω εμφανίζονται τα
αποτελέσματα σε μορφή JSON :
{ "results": [{}], "controller": "CheckRequiredValues", "function": "check_required_values", "method": "GET", "total": ``, "status": 200, "message": "[GET][check_required_values]:success" }
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα
από τον πίνακα data με τα αποτελέσματα σε
μορφή JSON :
{"data": [{ "mm_id":``, "registry_no":``, "name":`` }] }
INFOS : Δέχεται τις παρακάτω
παραμέτρους:
1) Επιλογή διαδικασίας (Η οποία μπορεί
να δεχτεί αριθμητικές τιμές από το 1-10 και
κάθε μία αντιστοιχεί σε συγκεκριμένο
ερώτημα στην β.δ.)
"selection" ->
1 : null region_edu_admin (χωρίς περιφέρεια)
2 : null edu_admin (χωρίς διεύθυνση εκπαίδευσης)
3 : null transfer_area (χωρίς περιοχή μετάθεσης)
4 : null prefecture (χωρίς νομό)
5 : null municipality (χωρίς δήμο)
6 : null operation_shift (χωρίς ωράριο λειτουργίας)
7 : null legal_character (χωρίς νομικό χαρακτήρα)
8 : null implementation_entity (χωρίς φορέα υλοποίησης)
9 : null unit_type (χωρίς τύπο μονάδας)
10 : null category (χωρίς κατηγορία)
2) Φίλτρα αναζήτησης (μπορούν
προστεθούν επιπλέον φίλτρα αναζήτησης σε
κάθε επιλογή διαδικασίας για πιο αναλυτικά
αποτελέσματα)
"category" -> Κατηγορία Μονάδων
"unit_type" -> Τύποι Μονάδων
"state" -> Λειτουργική Κατάσταση Μονάδων
"source" -> Πρωτογενής Πηγή Μονάδων
3) Τύπος εξαγωγής δεδομένων
"export" -> Υποστηρίζεται η εξαγωγή δεδομένων
σε format JSON και PHP_ARRAY, με χρήση της αντίστοιχης
τιμής.
4) Επιστροφή περισσότερων
αποτελεσμάτων
"all_data" -> Επιστρέφει εκτός από τον συνολικό
αριθμό μονάδων και όνομα μονάδας, κωδικο
ΥΠΑΙΠΘ, κωδικό MM
integer |
$selection |
Επιλογή Διαδικασίας Επιλογή διαδικασίας Η τιμή της παραμέτρου μπορεί να είναι : integer
|
boolean |
$all_data |
Περισσοότερα Αποτελέσματα Επιλογή για επιστροφή περισσότερων αποτελεσμάτων Η τιμή της παραμέτρου μπορεί να είναι : boolean(true)
|
mixed |
$category |
Κατηγορία Το Όνομα ή ο Κωδικός ID της Κατηγορίας της Μονάδας Λεξικό : GetCategories() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$unit_type |
Τύπος Μονάδας Το Όνομα ή ο Κωδικός ID του Τύπου Μονάδας Λεξικό : GetUnitTypes() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$state |
Λειτουργική Καταστάση Το Όνομα ή ο Κωδικός ID της Λειτουργικής Καταστάσης της Μονάδας Λεξικό : GetStates() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$source |
Πρωτογενής Πηγή Το Όνομα ή ο Κωδικός ID της Πρωτογενής Πηγής της Μονάδας Λεξικό : GetSources() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
string |
$export |
Τύπος Εξαγωγής Δεδομένων Ο Τύπος Εξαγωγής Δεδομένων με τον οποίο θα γίνει η εξαγωγή σε συγκεκριμένη μορφή τών δεδομένων Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η εξαγωγή δεδομένων γίνεται με τον Τύπο ExportDataEnumTypes::JSON Λίστα Τύπων Εξαγωγής Δεδομένων : ExportDataEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : array : data : Ο Πίνακας με τα αποτελέσματα
string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |