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