Overview

Packages

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

Functions

  • PutCategories
  • PutEduAdmins
  • PutEducationLevels
  • PutImplementationEntities
  • PutLegalCharacters
  • PutMunicipalities
  • PutMunicipalityCommunities
  • PutOperationShifts
  • PutOrientationTypes
  • PutPrefectures
  • PutRegionEduAdmins
  • PutRelations
  • PutRelationTypes
  • PutSources
  • PutSpecialTypes
  • PutStates
  • PutTaxOffices
  • PutTransferAreaMunicipalities
  • PutTransferAreas
  • PutUnitDns
  • PutUnits
  • PutUnitTypes
  • PutUnitWorkers
  • PutWorkerPositions
  • PutWorkers
  • PutWorkerSpecializations
  • Overview
  • Package
  • Function

Function PutUnitTypes

ΛΕΞΙΚΟ : Ενημέρωση Τύπου Μονάδας

Η συνάρτηση ενημερώνει Τύπο Μονάδας σύμφωνα με τις παραμέτρους που έγινε η κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω διεύθυνσης με τη μέθοδο PUT και route_api_name = unit_types :
https://mm.sch.gr/api/unit_types

Ορισμός Μοναδικών Τιμών Παραμέτρων
Παρακάτω ορίζονται οι παραμέτροι που έχουν μοναδικές τιμές και πραγματοποιειται ελεγχος πριν κάθε καταχώρηση:

  • unit_type_id
  • name
  • initials

Πίνακας Παραμέτρων

  • Στον Πίνακα Παραμέτρων Parameters summary εμφανίζονται όλοι οι παράμετροι με τους οποίους μπορεί να γίνει η κλήση της συνάρτησης.
  • Όλοι οι παράμετροι είναι προαιρετικοί εκτός από αυτές που έχουν χαρακτηριστεί ως υποχρεωτικοί.
  • Οι παράμετροι μπορούν να χρησιμοποιηθούν με οποιαδήποτε σειρά.

Πίνακας Αποτελεσμάτων

  • Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση.
  • Όλες οι μεταβλητές επιστρέφονται σε JSON objects.
  • Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα.

Πίνακας Σφαλμάτων

  • Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης.
  • Οι περιγραφές των Σφαλμάτων καθώς και οι Κωδικοί τους είναι διαθέσιμες μέσω του πίνακα Μηνύματα Σφαλμάτων (ExceptionMessages) και Κωδικοί Σφαλμάτων (ExceptionCodes) αντίστοιχα.

Παραδείγματα Κλήσης

  • Υπάρχουν διαθέσιμα παραδείγματα κλήσης της συνάρτησης με διάφορους τρόπους (ApiRequestExamples).

Μηνύματα Authentication/Authorization

  • Υπάρχουν αναλυτικές πληροφορίες για τα μηνύματα Authentication/Authorization (AuthMessages).

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

{
"controller": "PutUnitTypes",
"function": "unit_types",
"method": "PUT",
"parameters": { "unit_type_id": ``,"name": ``,"initials": ``,"category": ``,
                "education_level": `` },
"unit_type_id": ``,
"status": 200,
"message": "[PUT][unit_types]:success"
}
Package: PUT
Author: ΤΕΙ Αθήνας
Located at api/put/PutUnitTypes.php
Parameters summary
integer $unit_type_id ID Τύπου Μονάδας

Ο Κωδικός ID του Τύπου Μονάδας
Η παράμετρος είναι υποχρεωτική
ID Τύπου Μονάδας : GetUnitTypes()
Η τιμή της παραμέτρου μπορεί να είναι : integer
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με το Κωδικό ID Τύπου Μονάδας
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
string $name Όνομα

Το Όνομα του Τύπου Μονάδας
Η παράμετρος είναι υποχρεωτική
Η τιμή της παραμέτρου μπορεί να είναι : string
string $initials Αρχικά Ονόματος

Τα Αρχικά Ονόματος του Τύπου Μονάδας
Η παράμετρος είναι υποχρεωτική
Η τιμή της παραμέτρου μπορεί να είναι : string
integer|string $category Όνομα ή ID Κατηγορίας

Το Όνομα ή ο Κωδικός ID της Κατηγορίας
Η παράμετρος είναι υποχρεωτική
Όνομα ή ID Κατηγορίας : GetCategories()
Η τιμή της παραμέτρου μπορεί να είναι : integer|string
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με το Κωδικό ID Κατηγορίας
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα Κατηγορίας
    Η αναζήτηση στο Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
integer|string $education_level Όνομα ή ID Επίπεδου Εκπαίδευσης

Το Όνομα ή ο Κωδικός ID του Επίπεδου Εκπαίδευσης
Η παράμετρος είναι υποχρεωτική
Όνομα ή ID Επίπεδου Εκπαίδευσης : GetEducationLevels()
Η τιμή της παραμέτρου μπορεί να είναι : integer|string
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με το Κωδικό ID Επίπεδου Εκπαίδευσης
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα Επίπεδου Εκπαίδευσης
    Η αναζήτηση στο Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
Return value summary
Objects<JSON> Επιστρέφει τα παρακάτω JSON objects :

string : controller : Ο controller που χρησιμοποιείται
string : function : Η συνάρτηση που υλοποιείται από το σύστημα
string : method : Η μέθοδος κλήσης της συνάρτησης
array : parameters : Οι παράμετροι που δίνει ο χρήστης
integer : unit_type_id : Ο Κωδικός ID του Τύπου Μονάδας που ενημερώθηκε
integer : status : Ο Κωδικός του αποτελέσματος της κλήσης
string : message : Το Μήνυμα του αποτελέσματος της κλήσης
Thrown exceptions summary
MissingUnitTypeIDParam ExceptionMessages::MissingUnitTypeIDParam
ExceptionCodes::MissingUnitTypeIDParam
MissingUnitTypeIDValue ExceptionMessages::MissingUnitTypeIDValue
ExceptionCodes::MissingUnitTypeIDValue
InvalidUnitTypeIDArray ExceptionMessages::InvalidUnitTypeIDArray
ExceptionCodes::InvalidUnitTypeIDArray
InvalidUnitTypeIDType ExceptionMessages::InvalidUnitTypeIDType
ExceptionCodes::InvalidUnitTypeIDType
InvalidUnitTypeValue ExceptionMessages::InvalidUnitTypeValue
ExceptionCodes::InvalidUnitTypeValue
DuplicatedUnitTypeUniqueValue ExceptionMessages::DuplicatedUnitTypeUniqueValue
ExceptionCodes::DuplicatedUnitTypeUniqueValue
MissingUnitTypeNameParam ExceptionMessages::MissingUnitTypeNameParam
ExceptionCodes::MissingUnitTypeNameParam
MissingUnitTypeNameValue ExceptionMessages::MissingUnitTypeNameValue
ExceptionCodes::MissingUnitTypeNameValue
InvalidUnitTypeNameType ExceptionMessages::InvalidUnitTypeNameType
ExceptionCodes::InvalidUnitTypeNameType
MissingUnitTypeInitialParam ExceptionMessages::MissingUnitTypeInitialParam
ExceptionCodes::MissingUnitTypeInitialParam
MissingUnitTypeInitialValue ExceptionMessages::MissingUnitTypeInitialValue
ExceptionCodes::MissingUnitTypeInitialValue
InvalidUnitTypeInitialType ExceptionMessages::InvalidUnitTypeInitialType
ExceptionCodes::InvalidUnitTypeInitialType
MissingCategoryParam ExceptionMessages::MissingCategoryParam
ExceptionCodes::MissingCategoryParam
MissingCategoryValue ExceptionMessages::MissingCategoryValue
ExceptionCodes::MissingCategoryValue
InvalidCategoryArray ExceptionMessages::InvalidCategoryArray
ExceptionCodes::InvalidCategoryArray
InvalidCategoryType ExceptionMessages::InvalidCategoryType
ExceptionCodes::InvalidCategoryType
DuplicatedCategoryUniqueValue ExceptionMessages::DuplicatedCategoryUniqueValue
ExceptionCodes::DuplicatedCategoryUniqueValue
MissingEducationLevelParam ExceptionMessages::MissingEducationLevelParam
ExceptionCodes::MissingEducationLevelParam
MissingEducationLevelValue ExceptionMessages::MissingEducationLevelValue
ExceptionCodes::MissingEducationLevelValue
InvalidEducationLevelArray ExceptionMessages::InvalidEducationLevelArray
ExceptionCodes::InvalidEducationLevelArray
InvalidEducationLevelType ExceptionMessages::InvalidEducationLevelType
ExceptionCodes::InvalidEducationLevelType
DuplicatedEducationLevelUniqueValue ExceptionMessages::DuplicatedEducationLevelUniqueValue
ExceptionCodes::DuplicatedEducationLevelUniqueValue
DuplicatedUnitTypeNameValue ExceptionMessages::DuplicatedUnitTypeNameValue
ExceptionCodes::DuplicatedUnitTypeNameValue
DuplicatedUnitTypeInitialValue ExceptionMessages::DuplicatedUnitTypeInitialValue
ExceptionCodes::DuplicatedUnitTypeInitialValue
NoErrors ExceptionMessages::NoErrors
ExceptionCodes::NoErrors
mm.sch.gr API documentation generated by ApiGen 2.8.0