Function GetPrefectures

ΛΕΞΙΚΟ : Περιφερειακές Ενότητες

Η συνάρτηση αυτή επιστρέφει Περιφερειακές Ενότητες σύμφωνα με τις παραμέτρους που έγινε η κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω διεύθυνσης με τη μέθοδο GET και route_api_name = prefectures :
https://mm.sch.gr/api/prefectures

Ορισμός Τύπου και Πεδίου Ταξινόμησης Αποτελεσμάτων

Μέσω των παραμέτρων Πεδίο Ταξινόμησης ($orderby) και Τύπος Ταξινόμησης ($ordertype) μπορεί να καθοριστεί το πεδίο και η σειρά ταξινόμησης.
Προκαθορισμένη τιμή πεδίου ταξινόμησης είναι η αύξουσα σειρά ASC.
Προκαθορισμένη τιμή τύπου ταξινόμησης είναι το Όνομα.

Ορισμός Αριθμού Σελίδας και Εγγραφών/Σελίδα της Επιστροφής Αποτελεσμάτων

Μέσω των παραμέτρων Αριθμός Σελίδας ($page) και Αριθμός Εγγραφών/Σελίδα ($pagesize) μπορεί να καθοριστεί ο αριθμός Σελίδας και Εγγραφών/Σελίδα της επιστροφής αποτελεσμάτων.
Ο προκαθορισμένος αριθμός Εγγραφών/Σελίδα που επιστρέφονται ανά κλήση είναι 0.
Ο προκαθορισμένος αριθμός Σελίδας που επιστρέφεται ανά κλήση είναι 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": "GetPrefectures",
 "function": "prefectures",
 "method": "GET",
 "total": ``,
 "count": ``,
 "pagination": { "page": 1, "maxPage": 1, "pagesize": 0},
 "status": 200,
 "message": "[GET][prefectures]:success"
}

Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα από τον πίνακα data με τα αποτελέσματα σε μορφή JSON :

{"data": [{
             "prefecture_id": ``,
        "prefecture": ``
         }]
}

Package: GET
Author: ΤΕΙ Αθήνας
Located at api/get/GetPrefectures.php

Parameters summary
`mixed`	`$prefecture`	Περιφερειακή Ενότητα Το Όνομα ή ο Κωδικός ID της Περιφερειακής Ενότητας Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer\|string\|array[integer\|string]} integer Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ID της Περιφερειακής Ενότητας Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο `SearchEnumTypes::Exact` string Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα της Περιφερειακής Ενότητας Η αναζήτηση στον Όνομα γίνεται με τον Τύπο `SearchEnumTypes::Exact` array[integer\|string] Σύνολο από Αριθμητικές ή Αλφαριθμητικές τιμές διαχωρισμένες με κόμμα Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
`integer`	`$pagesize`	Αριθμός Εγγραφών/Σελίδα Ο αριθμός των εγγραφών που θα επιστρέψουν ανα σελίδα Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφούν όλες οι προκαθορισμένες εγγραφές (`Parameters::DefaultPageSize`) Λίστα Παραμέτρων Σελιδοποίησης : `Parameters` Η τιμή της παραμέτρου μπορεί να είναι : integer integer Αριθμητική : Η τιμή της παραμέτρου πρέπει να είναι μεγαλύτερη από 0
`integer`	`$page`	Αριθμός Σελίδας Ο αριθμός της σελίδας με τις $pagesize εγγραφές που βρέθηκαν σύμφωμα με τις παραμέτρους Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφεί η πρώτη σελίδα Λίστα Παραμέτρων Σελίδας : `Parameters` Η τιμή της παραμέτρου μπορεί να είναι : integer integer Αριθμητική : Η τιμή της παραμέτρου πρέπει να είναι μεγαλύτερη από 0
`string`	`$orderby`	Πεδίο Ταξινόμησης Το όνομα του πεδίου με το οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με το Όνομα Η τιμή της παραμέτρου μπορεί να είναι : string string Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι οποιοδήποτε όνομα πεδίου επιστρέφεται στον πίνακα data
`string`	`$ordertype`	Τύπος Ταξινόμησης Ο τύπος ταξινόμησης με τον οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με Αύξουσα Σειρά (`OrderEnumTypes::ASC`) Λίστα Τύπων Ταξινόμησης : `OrderEnumTypes` Η τιμή της παραμέτρου μπορεί να είναι : string string Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι ένας από τους Tύπους `OrderEnumTypes`
`string`	`$searchtype`	Τύπος Αναζήτησης Ο Τύπος Αναζήτησης με τον οποίο γίνεται η αναζήτηση στα πεδία Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στα πεδία αυτά γίνεται με τον Τύπο `SearchEnumTypes::ContainAll` Λίστα Τύπων Αναζήτησης : `SearchEnumTypes` Η τιμή της παραμέτρου μπορεί να είναι : string string Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι ένας από τους Tύπους `SearchEnumTypes`

Return value summary
`Objects<JSON>`	Επιστρέφει τα παρακάτω JSON objects : array : data : Ο Πίνακας με τα δεδομένα integer : prefecture_id : Ο Κωδικός ID της Περιφερειακής Ενότητας string : prefecture : Το Όνομα της Περιφερειακής Ενότητας string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης integer : count : Το πλήθος των εγγραφών της κλήσης σύμφωνα με τις παραμέτρους σελιδοποίησης array : pagination : Οι παράμετροι σελιδοποίησης των εγγραφών της κλήσης integer : page : Ο αριθμός της σελίδας των αποτελεσμάτων integer : maxPage : Ο μέγιστος αριθμός της σελίδας των αποτελεσμάτων integer : pagesize : Ο αριθμός των εγγραφών προς επιστροφή integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης

Thrown exceptions summary
`InvalidPrefectureType`	`ExceptionMessages::InvalidPrefectureType` `ExceptionCodes::InvalidPrefectureType`
`NoErrors`	`ExceptionMessages::NoErrors` `ExceptionCodes::NoErrors`

Packages

Functions

Function GetPrefectures