Overview

Packages

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

Functions

  • PostCategories
  • PostEduAdmins
  • PostEducationLevels
  • PostImplementationEntities
  • PostLegalCharacters
  • PostMunicipalities
  • PostMunicipalityCommunities
  • PostOperationShifts
  • PostOrientationTypes
  • PostPrefectures
  • PostRegionEduAdmins
  • PostRelations
  • PostRelationTypes
  • PostSources
  • PostSpecialTypes
  • PostStates
  • PostTaxOffices
  • PostTransferAreaMunicipalities
  • PostTransferAreas
  • PostUnitDns
  • PostUnits
  • PostUnitTypes
  • PostUnitWorkers
  • PostWorkerPositions
  • PostWorkers
  • PostWorkerSpecializations
  • Overview
  • Package
  • Function

Function PostUnitDns

Καταχώρηση DNS Μονάδας

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

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

  • unit_ext_dns
  • mm_id

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

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

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

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

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

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

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

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

Μηνύματα Authentication/Authorization

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

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

{
"controller": "PostUnitDns",
"function": "unit_dns",
"method": "POST",
"parameters": { "unit_dns": ``,"unit_ext_dns": ``,"mm_id": `` },
"unit_dns_id": ``,
"status": 200,
"message": "[POST][unit_dns]:success"
}
Package: POST
Author: ΤΕΙ Αθήνας
Located at api/post/PostUnitDns.php
Parameters summary
string $unit_dns DNS Μονάδας

Το Όνομα του DNS της Μονάδας
Η παράμετρος είναι υποχρεωτική
Η τιμή της παραμέτρου μπορεί να είναι : string
string $unit_ext_dns ExtDNS Μονάδας

Το ExtDNS της Μονάδας
Η παράμετρος είναι υποχρεωτική
Η τιμή της παραμέτρου μπορεί να είναι : string
integer $mm_id Κωδικός ΜΜ

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

string : controller : Ο controller που χρησιμοποιείται
string : function : Η συνάρτηση που υλοποιείται από το σύστημα
string : method : Η μέθοδος κλήσης της συνάρτησης
array : parameters : Οι παράμετροι που δίνει ο χρήστης
integer : unit_dns_id : Ο Κωδικός ID του DNS Μονάδας που δημιουργήθηκε
integer : status : Ο Κωδικός του αποτελέσματος της κλήσης
string : message : Το Μήνυμα του αποτελέσματος της κλήσης
Thrown exceptions summary
MissingUnitDnsParam ExceptionMessages::MissingUnitDnsParam
ExceptionCodes::MissingUnitDnsParam
MissingUnitDnsValue ExceptionMessages::MissingUnitDnsValue
ExceptionCodes::MissingUnitDnsValue
InvalidUnitDnsType ExceptionMessages::InvalidUnitDnsType
ExceptionCodes::InvalidUnitDnsType
MissingUnitExtDnsParam ExceptionMessages::MissingUnitExtDnsParam
ExceptionCodes::MissingUnitExtDnsParam
MissingUnitExtDnsValue ExceptionMessages::MissingUnitExtDnsValue
ExceptionCodes::MissingUnitExtDnsValue
InvalidUnitExtDnsType ExceptionMessages::InvalidUnitExtDnsType
ExceptionCodes::InvalidUnitExtDnsType
DuplicatedUnitExtDnsValue ExceptionMessages::DuplicatedUnitExtDnsValue
ExceptionCodes::DuplicatedUnitExtDnsValue
MissingUnitMMIDParam ExceptionMessages::MissingUnitMMIDParam
ExceptionCodes::MissingUnitMMIDParam
MissingUnitMMIDValue ExceptionMessages::MissingUnitMMIDValue
ExceptionCodes::MissingUnitMMIDValue
InvalidUnitMMIDType ExceptionMessages::InvalidUnitMMIDType
ExceptionCodes::InvalidUnitMMIDType
InvalidUnitMMIDArray ExceptionMessages::InvalidUnitMMIDArray
ExceptionCodes::InvalidUnitMMIDArray
DuplicatedUnitMMIDUniqueValue ExceptionMessages::DuplicatedUnitMMIDUniqueValue
ExceptionCodes::DuplicatedUnitMMIDUniqueValue
DuplicatedUnitDnsValue ExceptionMessages::DuplicatedUnitDnsValue
ExceptionCodes::DuplicatedUnitDnsValue
NoErrors ExceptionMessages::NoErrors
ExceptionCodes::NoErrors
mm.sch.gr API documentation generated by ApiGen 2.8.0