Function DeleteTaxOffices
ΛΕΞΙΚΟ : Διαγραφή Δ.Ο.Υ (Εφορίας)
Η συνάρτηση διαγράφει Δ.Ο.Υ (Εφορία)
σύμφωνα με τις παραμέτρους που έγινε η
κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο DELETE και
route_api_name = tax_offices :
https://mm.sch.gr/api/tax_offices
Πίνακας Παραμέτρων
- Στον Πίνακα Παραμέτρων Parameters summary εμφανίζονται όλοι οι παράμετροι με τους οποίους μπορεί να γίνει η κλήση της συνάρτησης.
- Όλοι οι παράμετροι είναι προαιρετικοί εκτός από αυτές που έχουν χαρακτηριστεί ως υποχρεωτικοί.
- Οι παράμετροι μπορούν να χρησιμοποιηθούν με οποιαδήποτε σειρά.
Πίνακας Αποτελεσμάτων
- Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση.
- Όλες οι μεταβλητές επιστρέφονται σε JSON objects.
- Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα.
Πίνακας Σφαλμάτων
- Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης.
- Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (
ExceptionMessages
) και Κωδικοί Σφαλμάτων (ExceptionCodes
) αντίστοιχα.
Παραδείγματα Κλήσης
- Υπάρχουν διαθέσιμα παραδείγματα κλήσης
της συνάρτησης με διάφορους τρόπους (
ApiRequestExamples
).
Μηνύματα Authentication/Authorization
- Υπάρχουν αναλυτικές πληροφορίες για τα
μηνύματα Authentication/Authorization (
AuthMessages
).
Δεδομένα Επιστροφής
Παρακάτω εμφανίζονται τα
αποτελέσματα σε μορφή JSON :
{ "controller": "DeleteTaxOffices", "function": "tax_offices", "method": "DELETE", "parameters": { "tax_office_id": `` }, "tax_office_id": ``, "status": 200, "message": "[DELETE][tax_offices]:success" }
integer |
$tax_office_id |
ID Δ.Ο.Υ (Εφορίας) Ο Κωδικός ID της Δ.Ο.Υ (Εφορίας) Η παράμετρος είναι υποχρεωτική ID Δ.Ο.Υ (Εφορίας) : GetTaxOffices() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης array : parameters : Οι παράμετροι που δίνει ο χρήστης integer : tax_office_id : Ο Κωδικός ID της Δ.Ο.Υ (Εφορίας) που διαγράφηκε integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |
MissingTaxOfficeIDParam
|
ExceptionMessages::MissingTaxOfficeIDParam ExceptionCodes::MissingTaxOfficeIDParam
|
MissingTaxOfficeIDValue
|
ExceptionMessages::MissingTaxOfficeIDValue ExceptionCodes::MissingTaxOfficeIDValue
|
InvalidTaxOfficeIDArray
|
ExceptionMessages::InvalidTaxOfficeIDArray ExceptionCodes::InvalidTaxOfficeIDArray
|
InvalidTaxOfficeIDΤype
|
ExceptionMessages::InvalidTaxOfficeIDΤype ExceptionCodes::InvalidTaxOfficeIDΤype |
NotFoundDelStateValue
|
ExceptionMessages::NotFoundDelStateValue ExceptionCodes::NotFoundDelStateValue
|
DuplicateDelTaxOfficeValue
|
ExceptionMessages::DuplicateDelTaxOfficeValue ExceptionCodes::DuplicateDelTaxOfficeValue
|
ReferencesTaxOfficeUnits
|
ExceptionMessages::ReferencesTaxOfficeUnits ExceptionCodes::ReferencesTaxOfficeUnits
|
ReferencesTaxOfficeSchoolCommittees
|
ExceptionMessages::ReferencesTaxOfficeSchoolCommittees ExceptionCodes::ReferencesTaxOfficeSchoolCommittees
|
NoErrors
|
ExceptionMessages::NoErrors ExceptionCodes::NoErrors
|