Function DeleteLegalCharacters

ΛΕΞΙΚΟ : Διαγραφή Νομικού Χαρακτήρα Μονάδων

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

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

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

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

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

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

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

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

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

Μηνύματα Authentication/Authorization

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

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

{
"controller": "DeleteLegalCharacters",
"function": "legal_characters",
"method": "DELETE",
"parameters": { "legal_character_id": `` },
"legal_character_id": ``,
"status": 200,
"message": "[DELETE][legal_characters]:success"
}