Function PutLegalCharacters

ΛΕΞΙΚΟ : Ενημέρωση Νομικού Χαρακτήρα Μονάδας

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

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

legal_character_id
name

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

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

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

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

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

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

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

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

Μηνύματα Authentication/Authorization

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

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

{
"controller": "PutLegalCharacters",
"function": "legal_characters",
"method": "PUT",
"parameters": { "legal_character_id": ``,"name": ``,"category": `` },
"legal_character_id": ``,
"status": 200,
"message": "[PUT][legal_characters]:success"
}

Package: PUT
Author: ΤΕΙ Αθήνας
Located at api/put/PutLegalCharacters.php

Parameters summary
`integer`	`$legal_character_id`	ID Νομικού Χαρακτήρα Μονάδων Ο Κωδικός ID του Νομικού Χαρακτήρα Μονάδων Η παράμετρος είναι *υποχρεωτική* ID Νομικού Χαρακτήρα Μονάδων : `GetLegalCharacters()` Η τιμή της παραμέτρου μπορεί να είναι : integer integer Αριθμητική : Η αναζήτηση γίνεται με το Κωδικό ID Νομικού Χαρακτήρα Μονάδων Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο `SearchEnumTypes::Exact`
`string`	`$name`	Όνομα Το Όνομα του Νομικού Χαρακτήρα Μονάδας Η παράμετρος είναι *υποχρεωτική* Η τιμή της παραμέτρου μπορεί να είναι : string
`integer\|string`	`$category`	Όνομα ή ID Κατηγορίας Το Όνομα ή ο Κωδικός ID της Κατηγορίας Η παράμετρος είναι *υποχρεωτική* Όνομα ή ID Κατηγορίας : `GetCategories()` Η τιμή της παραμέτρου μπορεί να είναι : 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 : legal_character_id : Ο Κωδικός ID του Νομικού Χαρακτήρα Μονάδας που ενημερώθηκε integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης

Thrown exceptions summary
`MissingLegalCharacterIDParam`	`ExceptionMessages::MissingLegalCharacterIDParam` `ExceptionCodes::MissingLegalCharacterIDParam`
`MissingLegalCharacterIDValue`	`ExceptionMessages::MissingLegalCharacterIDValue` `ExceptionCodes::MissingLegalCharacterIDValue`
`InvalidLegalCharacterIDArray`	`ExceptionMessages::InvalidLegalCharacterIDArray` `ExceptionCodes::InvalidLegalCharacterIDArray`
`InvalidLegalCharacterIDType`	`ExceptionMessages::InvalidLegalCharacterIDType` `ExceptionCodes::InvalidLegalCharacterIDType`
`InvalidLegalCharacterValue`	`ExceptionMessages::InvalidLegalCharacterValue` `ExceptionCodes::InvalidLegalCharacterValue`
`DuplicatedLegalCharacterUniqueValue`	`ExceptionMessages::DuplicatedLegalCharacterUniqueValue` `ExceptionCodes::DuplicatedLegalCharacterUniqueValue`
`MissingLegalCharacterNameParam`	`ExceptionMessages::MissingLegalCharacterNameParam` `ExceptionCodes::MissingLegalCharacterNameParam`
`MissingLegalCharacterNameValue`	`ExceptionMessages::MissingLegalCharacterNameValue` `ExceptionCodes::MissingLegalCharacterNameValue`
`InvalidLegalCharacterNameType`	`ExceptionMessages::InvalidLegalCharacterNameType` `ExceptionCodes::InvalidLegalCharacterNameType`
`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`
`DuplicatedLegalCharacterValue`	`ExceptionMessages::DuplicatedLegalCharacterValue` `ExceptionCodes::DuplicatedLegalCharacterValue`
`NoErrors`	`ExceptionMessages::NoErrors` `ExceptionCodes::NoErrors`

Packages

Functions

Function PutLegalCharacters