Function GetUnits
Μονάδες
Η συνάρτηση αυτή επιστρέφει Μονάδες
σύμφωνα με τις παραμέτρους που έγινε η
κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο GET και
route_api_name = units :
https://mm.sch.gr/api/units
Ορισμός Τύπου και Πεδίου Ταξινόμησης Αποτελεσμάτων
- Μέσω των παραμέτρων Πεδίο Ταξινόμησης ($orderby) και Τύπος Ταξινόμησης ($ordertype) μπορεί να καθοριστεί το πεδίο και η σειρά ταξινόμησης.
- Προκαθορισμένη τιμή πεδίου ταξινόμησης είναι η αύξουσα σειρά ASC.
- Προκαθορισμένη τιμή τύπου ταξινόμησης είναι το Όνομα Μονάδας.
Ορισμός Τύπου Εξαγωγής Δεδομένων
- Μέσω του παραμέτρου Τύπος Εξαγωγής Δεδομένων ($export) μπορεί να καθοριστεί ο τύπος εξαγωγής δεδομένων.
- Προκαθορισμένη τιμή Τύπου Εξαγωγής Δεδομένων είναι JSON.
- Όταν ο Τύπος Επιστροφής Εξαγωγής έχει τιμή XLSX ή CSV τότε η τιμή του pagesize αυτόματα από το σύστημα είναι 1000 και δεν μπορεί να αλλάξει.
- Σε κάθε περιπτωση που η τιμή του count είναι 1000 για την επιστροφή όλων δεδομένων, πρέπει να υλοποιηθεί κληση του ιδίου api request με αυξημένη κατα 1 την τιμή του page καθε φορά. Επίσης είναι διακριτό το μέγεθος της σελιδοποίησης από τις τιμές του pagination.
Ορισμός Αριθμού Σελίδας και Εγγραφών/Σελίδα της Επιστροφής Αποτελεσμάτων
- Μέσω των παραμέτρων Αριθμός Σελίδας ($page) και Αριθμός Εγγραφών/Σελίδα ($pagesize) μπορεί να καθοριστεί ο αριθμός Σελίδας και Εγγραφών/Σελίδα της επιστροφής αποτελεσμάτων.
- Ο προκαθορισμένος αριθμός Εγγραφών/Σελίδα που επιστρέφονται ανά κλήση είναι 200.
- Ο προκαθορισμένος αριθμός Σελίδας που επιστρέφεται ανά κλήση είναι 1.
Ορισμός Τύπου Αναζήτησης Αποτελεσμάτων
- Μέσω των παραμέτρων Τύπου Αναζήτησης ($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
).
Μηνύματα Προκαθορισμένων Παραμέτρων
- Υπάρχουν αναλυτικές πληροφορίες για τα
μηνύματα Προκαθορισμένων Παραμέτρων (
StandarParamsMessages
).
Δεδομένα Επιστροφής
Παρακάτω εμφανίζονται τα
αποτελέσματα σε μορφή JSON :
{ "data": [{}], "controller": "GetUnits", "function": "units", "method": "GET", "total": ``, "count": ``, "pagination": { "page": 1, "maxPage": 1, "pagesize": 200}, "status": 200, "message": "[GET][units]:success" }
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα
από τον πίνακα data με τα αποτελέσματα σε
μορφή JSON :
{"data": [{ "mm_id": ``, "registry_no": ``, "name": ``, "special_name": ``, "source_id": ``, "source": ``, "category_id": ``, "category": ``, "state_id": ``, "state": ``, "street_address": ``, "postal_code": ``, "fax_number": ``, "phone_number": ``, "email": ``, "tax_number": ``, "region_edu_admin_id": ``, "region_edu_admin": ``, "edu_admin_id": ``, "edu_admin": ``, "transfer_area_id": ``, "transfer_area": ``, "prefecture_id": ``, "prefecture": ``, "municipality_id": ``, "municipality": ``, "municipality_community_id": ``, "municipality_community": ``, "education_level_id": ``, "education_level": ``, "unit_type_id": ``, "unit_type": ``, "orientation_type_id": ``, "orientation_type": ``, "operation_shift_id": ``, "operation_shift": ``, "legal_character_id": ``, "legal_character": ``, "implementation_entity_id": ``, "implementation_entity": ``, "implementation_entity_initials": ``, "tax_office_id": ``, "tax_office": ``, "special_type_id": ``, "special_type": ``, "latitude": ``, "longitude": ``, "positioning": ``, "creation_fek": ``, "inaccessible": `` "studentsSum": `` "last_sync": ``, "last_update": ``, "comments": ``, "version": ``, "host_relations": [{ "relation_id": ``, "guest_mm_id": ``, "guest_registry_no": ``, "guest_name": ``, "guest_special_name": ``, "relation_state": ``, "true_date": ``, "true_fek": ``, "false_date": ``, "false_fek": ``, "relation_type_id": ``, "relation_type": `` }], "guest_relations": [{ "relation_id": ``, "host_mm_id": ``, "host_registry_no": ``, "host_name": ``, "host_special_name": ``, "relation_state": ``, "true_date": ``, "true_fek": ``, "false_date": ``, "false_fek": ``, "relation_type_id": ``, "relation_type": `` }], "workers": [{ "unit_worker_id": ``, "worker_id": ``, "registry_no": ``, "tax_number": ``, "lastname": ``, "firstname": ``, "fathername": ``, "fullname": ``, "sex": ``, "worker_specialization_id": ``, "worker_specialization": ``, "worker_position_id": ``, "worker_position": ``, "worker_source_id": ``, "worker_source": `` }], "unit_dns": [{ "unit_dns_id": ``, "unit_dns": ``, "unit_ext_dns": `` }] }] }
integer |
$mm_id |
Κωδικός ΜΜ Μονάδας Ο Κωδικός ΜΜ της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : integer|array[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 |
$municipality_community |
Δημοτική Ενότητα Το Όνομα ή ο Κωδικός ID της Δημοτικής Ενότητας της Μονάδας Λεξικό : GetMunicipalityCommunities() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$education_level |
Βαθμίδα Εκπαίδευσης Το Όνομα ή ο Κωδικός ID της Βαθμίδας Εκπαίδευσης της Μονάδας Λεξικό : GetEducationLevels() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
string |
$phone_number |
Τηλέφωνο Επικοινωνίας Το Τηλέφωνο Επικοινωνίας της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
mixed |
$email |
Ηλεκτρονική Αλληλογραφία Η Ηλεκτρονική Αλληλογραφία της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$fax_number |
Αριθμός Τηλεομοιοτυπίας (FAX) O Αριθμός Τηλεομοιοτυπίας (FAX) της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
string |
$street_address |
Διεύθυνση (Οδός,Αριθμός) Η Διεύθυνση (Οδός,Αριθμός) της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
mixed |
$postal_code |
Ταχυδρομικός Κώδικας O Ταχυδρομικός Κώδικας της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$tax_number |
Αριθμός Φορολογικού Μητρώου (Α.Φ.Μ.) O Αριθμός Φορολογικού Μητρώου (Α.Φ.Μ.) της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$tax_office |
Δ.Ο.Υ (Εφορία) Το Όνομα ή ο Κωδικός ID της Δ.Ο.Υ (Εφορία) της Μονάδας Λεξικό : GetTaxOffices() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
|
mixed |
$area_team_number |
Ομάδα Σχολείων Η Ομάδα Σχολείων της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[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]}
|
mixed |
$levels_count |
Πλήθος Τάξεων Το Πλήθος των Τάξεων της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$groups_count |
Πλήθος Τμημάτων Το Πλήθος των Τμημάτων της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$latitude |
Γεωγραφικό Πλάτος Το Γεωγραφικό Πλάτος της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$longitude |
Γεωγραφικό Μήκος Το Γεωγραφικό Μήκος της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
mixed |
$positioning |
Κτηριακή Θέση Η Κτηριακή Θέση της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : mixed{string|null|array[string|null]}
|
string |
$creation_fek |
Φ.Ε.Κ. (Δημιουργίας) Το Φ.Ε.Κ. (Δημιουργίας) της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$inaccessible |
Ορίζει αν η Μονάδα είναι δυσπρόσιτη |
string |
$studentsSum |
Σύνολο μαθητών της Μονάδας |
string |
$last_update |
Ημερομηνία Τελευταίας Ενημέρωσης Η Ημερομηνία Τελευταίας Ενημέρωσης της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$last_sync |
Ημερομηνία Τελευταίου Συγχρονισμού Η Ημερομηνία Τελευταίου Συγχρονισμού της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$comments |
Παρατηρήσεις-Σχόλια Παρατηρήσεις-Σχόλια της Μονάδας Συνδυάζεται με την παράμετρο searchtype Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
integer |
$pagesize |
Αριθμός Εγγραφών/Σελίδα Ο αριθμός των εγγραφών που θα επιστρέψουν ανα σελίδα Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφούν όλες οι προκαθορισμένες εγγραφές ( Parameters::DefaultPageSize )Λίστα Παραμέτρων Σελιδοποίησης : Parameters Η τιμή της παραμέτρου μπορεί να είναι : integer
|
integer |
$page |
Αριθμός Σελίδας Ο αριθμός της σελίδας με τις $pagesize εγγραφές που βρέθηκαν σύμφωμα με τις παραμέτρους Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφεί η πρώτη σελίδα Λίστα Παραμέτρων Σελίδας : Parameters Η τιμή της παραμέτρου μπορεί να είναι : integer
|
string |
$orderby |
Πεδίο Ταξινόμησης Το όνομα του πεδίου με το οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με το Όνομα Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$ordertype |
Τύπος Ταξινόμησης Ο τύπος ταξινόμησης με τον οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με Αύξουσα Σειρά ( OrderEnumTypes::ASC )Λίστα Τύπων Ταξινόμησης : OrderEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$searchtype |
Τύπος Αναζήτησης Ο Τύπος Αναζήτησης με τον οποίο γίνεται η αναζήτηση στα πεδία
Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στα πεδία αυτά γίνεται με τον Τύπο SearchEnumTypes::ContainAll Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$export |
Τύπος Εξαγωγής Δεδομένων Ο Τύπος Εξαγωγής Δεδομένων με τον οποίο θα γίνει η εξαγωγή σε συγκεκριμένη μορφή τών δεδομένων Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η εξαγωγή δεδομένων γίνεται με τον Τύπο ExportDataEnumTypes::JSON Λίστα Τύπων Εξαγωγής Δεδομένων : ExportDataEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : array : data : Ο Πίνακας με τα δεδομένα
string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης integer : count : Το πλήθος των εγγραφών της κλήσης σύμφωνα με τις παραμέτρους σελιδοποίησης array : pagination : Οι παράμετροι σελιδοποίησης των εγγραφών της κλήσης
integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |