Function StatisticUnits
Στατιστικά Μονάδων
Η συνάρτηση αυτή επιστρέφει Στατιστικά
Μονάδων, σύμφωνα με τις παραμέτρους που
έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο GET και
route_api_name = statistic_units :
https://mm.sch.gr/api/statistic_units
Πίνακας Axis
- Στον Πίνακα Axis περιέχονται τα ονόματα των παραμέτρων με τα οποία ο χρήστης μπορεί δημιουργήσει
δισδιαστατο πίνακα αποτελεσματων με άξονες x,y για την προβολή στατιστικων αποτελεσμάτων.
- Αποδεκτές τιμές
- "source"
- "category"
- "state"
- "region_edu_admin"
- "edu_admin"
- "transfer_area"
- "prefecture"
- "municipality"
- "education_level"
- "unit_type"
- "orientation_type"
- "operation_shift"
- "legal_character"
- "implementation_entity"
- "special_type"
Ορισμός Τύπου Αναζήτησης Αποτελεσμάτων
- Μέσω των παραμέτρων Τύπου Αναζήτησης ($searchtype) μπορεί να καθοριστεί μπορεί να καθοριστεί ο τρόπος με τον οποίο θα αναζητηθεί η τιμή της παραμέτρου στο DNS της Μονάδας.
- Ισχύει για όσες παραμέτρους το υποστηρίζουν το συνδυασμό με την παράμετρο searchtype.
- Προκαθορισμένη τιμή τύπου αναζήτησης είναι CONTAINALL.
Πίνακας Παραμέτρων
- Στον Πίνακα Παραμέτρων 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": "StatisticUnits", "function": "statistic_units", "method": "GET", "filters": ``, "status": 200, "message": "[GET][statistic_units]:success" }
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα
από τον πίνακα results με τα αποτελέσματα σε
μορφή JSON :
{"results": [{ "x_axis_name":``, "y_axis_name":``, "total_units":`` }] }
string |
$x_axis |
Άξονας x του πίνακα Η παράμετρος μπορεί να είναι οποιαδήποτε τιμή από τον πίνακα Axis Axis Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$y_axis |
Άξονας y του πίνακα Η παράμετρος μπορεί να είναι οποιαδήποτε τιμή από τον πίνακα Axis Axis Η τιμή της παραμέτρου μπορεί να είναι : string
|
integer |
$mm_id |
Κωδικός ΜΜ Μονάδας Ο Κωδικός ΜΜ της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : integer
|
mixed |
$registry_no |
Κωδικός ΥΠΕΠΘ O Κωδικός ΥΠΕΠΘ της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$source |
Πρωτογενής Πηγή Το Όνομα ή ο Κωδικός ID της Πρωτογενής Πηγής της Μονάδας Λεξικό : GetSources() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
string |
$name |
Ονομασία Η Ονομασία της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$special_name |
Προσωνύμιο Το Προσωνύμιο της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
mixed |
$state |
Λειτουργική Καταστάση Το Όνομα ή ο Κωδικός ID της Λειτουργικής Καταστάσης της Μονάδας Λεξικό : GetStates() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$region_edu_admin |
Περιφέρεια Το Όνομα ή ο Κωδικός ID της Περιφέρειας της Μονάδας Λεξικό : GetRegionEduAdmins() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$edu_admin |
Διεύθυνση Εκπαίδευσης Το Όνομα ή ο Κωδικός ID της Διευθύνσης Εκπαίδευσης της Μονάδας Λεξικό : GetEduAdmins() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$implementation_entity |
Φορέας Υλοποίησης Το Όνομα ή ο Κωδικός ID του Φορέα Υλοποίησης της Μονάδας Λεξικό : GetImplementationEntities() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$transfer_area |
Περιοχή Μετάθεσης Το Όνομα ή ο Κωδικός ID της Περιοχής Μετάθεσης της Μονάδας Λεξικό : GetTransferAreas() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$prefecture |
Περιφερειακή Ενότητα Το Όνομα ή ο Κωδικός ID της Περιφερειακή Ενότητα της Μονάδας Λεξικό : GetPrefectures() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$municipality |
Δήμος ΟΤΑ Το Όνομα ή ο Κωδικός ID του Δήμου ΟΤΑ της Μονάδας Λεξικό : GetMunicipalities() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$education_level |
Βαθμίδα Εκπαίδευσης Το Όνομα ή ο Κωδικός ID της Βαθμίδας Εκπαίδευσης της Μονάδας Λεξικό : GetEducationLevels() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
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 |
$operation_shift |
Ωράριο Λειτουργίας Το Όνομα ή ο Κωδικός ID του Ωράριου Λειτουργίας της Μονάδας Λεξικό : GetOperationShifts() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$legal_character |
Νομικός Χαρακτήρας Το Όνομα ή ο Κωδικός ID του Νομικού Χαρακτήρα της Μονάδας Λεξικό : GetLegalCharacters() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$orientation_type |
Προσανατολισμός Το Όνομα ή ο Κωδικός ID του Προσανατολισμού της Μονάδας Λεξικό : GetOrientationTypes() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$special_type |
Ειδικός Χαρακτηρισμός Το Όνομα ή ο Κωδικός ID του Ειδικού Χαρακτηρισμού της Μονάδας Λεξικό : GetSpecialTypes() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
string |
$searchtype |
Τύπος Αναζήτησης Ο Τύπος Αναζήτησης με τον οποίο γίνεται η αναζήτηση στα πεδία
Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στα πεδία αυτά γίνεται με τον Τύπο SearchEnumTypes::ContainAll Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : array : results : Ο Πίνακας με τα αποτελέσματα
string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης string : filters : Τα φίλτρα που καταχώρησε ο χρήστης integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |