Overview

Packages

  • DELETE
  • DEPRECATED
  • GET
  • POST
  • PUT
  • SYSTEM

Functions

  • DeleteCategories
  • DeleteEduAdmins
  • DeleteEducationLevels
  • DeleteImplementationEntities
  • DeleteLegalCharacters
  • DeleteMunicipalities
  • DeleteMunicipalityCommunities
  • DeleteOperationShifts
  • DeleteOrientationTypes
  • DeletePrefectures
  • DeleteRegionEduAdmins
  • DeleteRelations
  • DeleteRelationTypes
  • DeleteSources
  • DeleteSpecialTypes
  • DeleteStates
  • DeleteTaxOffices
  • DeleteTransferAreaMunicipalities
  • DeleteTransferAreas
  • DeleteUnitDns
  • DeleteUnits
  • DeleteUnitTypes
  • DeleteUnitWorkers
  • DeleteWorkerPositions
  • DeleteWorkers
  • DeleteWorkerSpecializations
  • Overview
  • Package
  • Function

Function DeleteUnits

Διαγραφή Μονάδας

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

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

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

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

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

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

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

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

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

Μηνύματα Authentication/Authorization

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

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

{
"controller": "DeleteUnits",
"function": "units",
"method": "DELETE",
"parameters": { "mm_id": `` },
"mm_id": ``,
"status": 200,
"message": "[DELETE][units]:success"
}
Package: DELETE
Author: ΤΕΙ Αθήνας
Located at api/delete/DeleteUnits.php
Parameters summary
integer $mm_id Κωδικός ΜΜ

Ο Κωδικός ΜΜ
Η παράμετρος είναι υποχρεωτική
Κωδικός ΜΜ : GetUnits()
Η τιμή της παραμέτρου μπορεί να είναι : integer
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με το Κωδικό ΜΜ
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
Return value summary
Objects<JSON> Επιστρέφει τα παρακάτω JSON objects :

string : controller : Ο controller που χρησιμοποιείται
string : function : Η συνάρτηση που υλοποιείται από το σύστημα
string : method : Η μέθοδος κλήσης της συνάρτησης
array : parameters : Οι παράμετροι που δίνει ο χρήστης
integer : mm_id : Ο Κωδικός ΜΜ που διαγράφηκε
integer : status : Ο Κωδικός του αποτελέσματος της κλήσης
string : message : Το Μήνυμα του αποτελέσματος της κλήσης
Thrown exceptions summary
MissingUnitMMIDParam ExceptionMessages::MissingUnitMMIDParam
ExceptionCodes::MissingUnitMMIDParam
MissingUnitMMIDValue ExceptionMessages::MissingUnitMMIDValue
ExceptionCodes::MissingUnitMMIDValue
InvalidUnitMMIDArray ExceptionMessages::InvalidUnitMMIDArray
ExceptionCodes::InvalidUnitMMIDArray
InvalidUnitMMIDType ExceptionMessages::InvalidUnitMMIDType
ExceptionCodes::InvalidUnitMMIDType
NotFoundDelUnitValue ExceptionMessages::NotFoundDelUnitValue
ExceptionCodes::NotFoundDelUnitValue
DuplicateDelUnitValue ExceptionMessages::DuplicateDelUnitValue
ExceptionCodes::DuplicateDelUnitValue
ReferencesUnitUnitWorkers ExceptionMessages::ReferencesUnitUnitWorkers
ExceptionCodes::ReferencesUnitUnitWorkers
ReferencesUnitGuestRelations ExceptionMessages::ReferencesUnitGuestRelations
ExceptionCodes::ReferencesUnitGuestRelations
ReferencesUnitHostRelations ExceptionMessages::ReferencesUnitHostRelations
ExceptionCodes::ReferencesUnitHostRelations
ReferencesUnitLevels ExceptionMessages::ReferencesUnitLevels
ExceptionCodes::ReferencesUnitLevels
ReferencesUnitGroups ExceptionMessages::ReferencesUnitGroups
ExceptionCodes::ReferencesUnitGroups
ReferencesUnitUnitDns ExceptionMessages::ReferencesUnitUnitDns
ExceptionCodes::ReferencesUnitUnitDns
NoErrors ExceptionMessages::NoErrors
ExceptionCodes::NoErrors
mm.sch.gr API documentation generated by ApiGen 2.8.0