Overview

Packages

  • DELETE
  • DEPRECATED
  • GET
  • POST
  • PUT
  • SYSTEM

Functions

  • CheckRequiredValues
  • GetCategories
  • GetCpes
  • GetCrmData
  • GetEduAdmins
  • GetEducationLevels
  • GetExtLogEntries
  • GetImplementationEntities
  • GetLdapEntries
  • GetLdaps
  • GetLegalCharacters
  • GetMunicipalities
  • GetMunicipalityCommunities
  • GetOperationShifts
  • GetOrientationTypes
  • GetPrefectures
  • GetRegionEduAdmins
  • GetRelations
  • GetRelationTypes
  • GetSchoolCommittees
  • GetSources
  • GetSpecialTypes
  • GetStates
  • GetTaxOffices
  • GetTransferAreaMunicipalities
  • GetTransferAreas
  • GetUnitDns
  • GetUnits
  • GetUnitTypes
  • GetUnitWorkers
  • GetWorkerPositions
  • GetWorkers
  • GetWorkerSpecializations
  • StatisticUnits
  • Overview
  • Package
  • Function

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

Package: GET
Author: ΤΕΙ Αθήνας
Located at api/get/CheckRequiredValues.php
Parameters summary
integer $selection Επιλογή Διαδικασίας

Επιλογή διαδικασίας
Η τιμή της παραμέτρου μπορεί να είναι : integer
  • integer
    Αριθμητική :Η Επιλογή Διαδικασίας μπορεί να είναι αριθμητική μεταξύ των 1-10
boolean $all_data Περισσοότερα Αποτελέσματα

Επιλογή για επιστροφή περισσότερων αποτελεσμάτων
Η τιμή της παραμέτρου μπορεί να είναι : boolean(true)
  • boolean
    Boolean : Είναι αποδεκτή μόνο η τιμή true για επιστροφή αποτελεσμάτων
mixed $category Κατηγορία

Το Όνομα ή ο Κωδικός ID της Κατηγορίας της Μονάδας
Λεξικό : GetCategories()
Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ID της Κατηγορίας
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα της Κατηγορίας
    Η αναζήτηση στον Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
  • null
    Null : Η αναζήτηση γίνεται με την επιλογή κενή τιμής
  • array[integer|string|null]
    Σύνολο από Αριθμητικές ή Αλφαριθμητικές ή Null τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
mixed $unit_type Τύπος Μονάδας

Το Όνομα ή ο Κωδικός ID του Τύπου Μονάδας
Λεξικό : GetUnitTypes()
Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ID του Τύπου Μονάδας
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα του Τύπου Μονάδας
    Η αναζήτηση στον Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
  • null
    Null : Η αναζήτηση γίνεται με την επιλογή κενή τιμής
  • array[integer|string|null]
    Σύνολο από Αριθμητικές ή Αλφαριθμητικές ή Null τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
mixed $state Λειτουργική Καταστάση

Το Όνομα ή ο Κωδικός ID της Λειτουργικής Καταστάσης της Μονάδας
Λεξικό : GetStates()
Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ID της Λειτουργικής Καταστάσης
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα της Λειτουργικής Καταστάσης
    Η αναζήτηση στον Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
  • null
    Null : Η αναζήτηση γίνεται με την επιλογή κενή τιμής
  • array[integer|string|null]
    Σύνολο από Αριθμητικές ή Αλφαριθμητικές ή Null τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
mixed $source Πρωτογενής Πηγή

Το Όνομα ή ο Κωδικός ID της Πρωτογενής Πηγής της Μονάδας
Λεξικό : GetSources()
Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|null|array[integer|string|null]}
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ID της Πρωτογενής Πηγής
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα της Πρωτογενής Πηγής
    Η αναζήτηση στον Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
  • null
    Null : Η αναζήτηση γίνεται με την επιλογή κενή τιμής
  • array[integer|string|null]
    Σύνολο από Αριθμητικές ή Αλφαριθμητικές ή Null τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
string $export Τύπος Εξαγωγής Δεδομένων

Ο Τύπος Εξαγωγής Δεδομένων με τον οποίο θα γίνει η εξαγωγή σε συγκεκριμένη μορφή τών δεδομένων
Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε η εξαγωγή δεδομένων γίνεται με τον Τύπο ExportDataEnumTypes::JSON
Λίστα Τύπων Εξαγωγής Δεδομένων : ExportDataEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : string
  • string
    Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι ένας από τους Tύπους ExportDataEnumTypes
Return value summary
Objects<JSON> Επιστρέφει τα παρακάτω JSON objects :

array : data : Ο Πίνακας με τα αποτελέσματα
  • string : mm_id : Ο Κωδικός ΜΜ
  • string : registry_no : Ο κωδικός ΥΠΕΠΘ της Μονάδας
  • integer : name : Το Όνομα της Μονάδας

string : controller : Ο controller που χρησιμοποιείται
string : function : Η συνάρτηση που υλοποιείται από το σύστημα
string : method : Η μέθοδος κλήσης της συνάρτησης
integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης
integer : status : Ο Κωδικός του αποτελέσματος της κλήσης
string : message : Το Μήνυμα του αποτελέσματος της κλήσης
Thrown exceptions summary
InvalidCategoryType ExceptionMessages::InvalidCategoryType
ExceptionCodes::InvalidCategoryType
InvalidUnitTypeType ExceptionMessages::InvalidUnitTypeType
ExceptionCodes::InvalidUnitTypeType
InvalidStateType ExceptionMessages::InvalidStateType
ExceptionCodes::InvalidStateType
InvalidSourceType ExceptionMessages::InvalidSourceType
ExceptionCodes::InvalidSourceType
MissingSelectionCheckRequiredParam ExceptionMessages::MissingSelectionCheckRequiredParam
ExceptionCodes::MissingSelectionCheckRequiredParam
MissingSelectionCheckRequiredValue ExceptionMessages::MissingSelectionCheckRequiredValue
ExceptionCodes::MissingSelectionCheckRequiredValue
InvalidSelectionCheckRequiredArray ExceptionMessages::InvalidSelectionCheckRequiredArray
ExceptionCodes::InvalidSelectionCheckRequiredArray
InvalidRegionEduAdminType ExceptionMessages::InvalidRegionEduAdminType
ExceptionCodes::InvalidRegionEduAdminType
InvalidEduAdminType ExceptionMessages::InvalidEduAdminType
ExceptionCodes::InvalidEduAdminType
InvalidTransferAreaType ExceptionMessages::InvalidTransferAreaType
ExceptionCodes::InvalidTransferAreaType
InvalidPrefectureType ExceptionMessages::InvalidPrefectureType
ExceptionCodes::InvalidPrefectureType
InvalidMunicipalityType ExceptionMessages::InvalidMunicipalityType
ExceptionCodes::InvalidMunicipalityType
InvalidOperationShiftType ExceptionMessages::InvalidOperationShiftType
ExceptionCodes::InvalidOperationShiftType
InvalidLegalCharacterType ExceptionMessages::InvalidLegalCharacterType
ExceptionCodes::InvalidLegalCharacterType
InvalidImplementationEntityType ExceptionMessages::InvalidImplementationEntityType
ExceptionCodes::InvalidImplementationEntityType
InvalidUnitType ExceptionMessages::InvalidUnitType
ExceptionCodes::InvalidUnitType
InvalidCategoryType ExceptionMessages::InvalidCategoryType
ExceptionCodes::InvalidCategoryType
InvalidSelectionCheckRequiredValue ExceptionMessages::InvalidSelectionCheckRequiredValue
ExceptionCodes::InvalidSelectionCheckRequiredValue
InvalidSelectionCheckRequiredType ExceptionMessages::InvalidSelectionCheckRequiredType
ExceptionCodes::InvalidSelectionCheckRequiredType
InvalidAllDataSelectionCheckRequiredValue ExceptionMessages::InvalidAllDataSelectionCheckRequiredValue
ExceptionCodes::InvalidAllDataSelectionCheckRequiredValue
NoErrors ExceptionMessages::NoErrors
ExceptionCodes::NoErrors
mm.sch.gr API documentation generated by ApiGen 2.8.0