Function PutMunicipalities

ΛΕΞΙΚΟ : Ενημέρωση Δήμου ΟΤΑ

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

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

municipality_id
name

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

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

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

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

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

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

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

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

Μηνύματα Authentication/Authorization

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

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

{
"controller": "PutMunicipalities",
"function": "municipalities",
"method": "PUT",
"parameters": { "municipality_id": ``,"name": ``,"prefecture": `` },
"municipality_id": ``,
"status": 200,
"message": "[PUT][municipalities]:success"
}

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

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

Thrown exceptions summary
`MissingMunicipalityIDParam`	`ExceptionMessages::MissingMunicipalityIDParam` `ExceptionCodes::MissingMunicipalityIDParam`
`MissingMunicipalityIDValue`	`ExceptionMessages::MissingMunicipalityIDValue` `ExceptionCodes::MissingMunicipalityIDValue`
`InvalidMunicipalityIDArray`	`ExceptionMessages::InvalidMunicipalityIDArray` `ExceptionCodes::InvalidMunicipalityIDArray`
`InvalidMunicipalityIDType`	`ExceptionMessages::InvalidMunicipalityIDType` `ExceptionCodes::InvalidMunicipalityIDType`
`InvalidMunicipalityValue`	`ExceptionMessages::InvalidMunicipalityValue` `ExceptionCodes::InvalidMunicipalityValue`
`DuplicatedMunicipalityUniqueValue`	`ExceptionMessages::DuplicatedMunicipalityUniqueValue` `ExceptionCodes::DuplicatedMunicipalityUniqueValue`
`MissingMunicipalityNameParam`	`ExceptionMessages::MissingMunicipalityNameParam` `ExceptionCodes::MissingMunicipalityNameParam`
`MissingMunicipalityNameValue`	`ExceptionMessages::MissingMunicipalityNameValue` `ExceptionCodes::MissingMunicipalityNameValue`
`InvalidMunicipalityNameType`	`ExceptionMessages::InvalidMunicipalityNameType` `ExceptionCodes::InvalidMunicipalityNameType`
`MissingPrefectureParam`	`ExceptionMessages::MissingPrefectureParam` `ExceptionCodes::MissingPrefectureParam`
`MissingPrefectureValue`	`ExceptionMessages::MissingPrefectureValue` `ExceptionCodes::MissingPrefectureValue`
`InvalidPrefectureArray`	`ExceptionMessages::InvalidPrefectureArray` `ExceptionCodes::InvalidPrefectureArray`
`InvalidPrefectureType`	`ExceptionMessages::InvalidPrefectureType` `ExceptionCodes::InvalidPrefectureType`
`DuplicatedPrefectureUniqueValue`	`ExceptionMessages::DuplicatedPrefectureUniqueValue` `ExceptionCodes::DuplicatedPrefectureUniqueValue`
`DuplicatedMunicipalityValue`	`ExceptionMessages::DuplicatedMunicipalityValue` `ExceptionCodes::DuplicatedMunicipalityValue`
`NoErrors`	`ExceptionMessages::NoErrors` `ExceptionCodes::NoErrors`

Packages

Functions

Function PutMunicipalities