Function PutUnitDns
Ενημέρωση DNS Μονάδας
Η συνάρτηση ενημερώνει DNS Μονάδας σύμφωνα
με τις παραμέτρους που έγινε η κλήση.
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο PUT και
route_api_name = unit_dns :
https://mm.sch.gr/api/unit_dns
Ορισμός Μοναδικών Τιμών
Παραμέτρων
Παρακάτω ορίζονται οι παραμέτροι που έχουν
μοναδικές τιμές και πραγματοποιειται
ελεγχος πριν κάθε καταχώρηση:
- unit_dns_id
- 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": "PutUnitDns", "function": "unit_dns", "method": "PUT", "parameters": { "unit_dns_id": ``,"unit_dns": ``,"unit_ext_dns": ``,"mm_id": `` }, "unit_dns_id": ``, "status": 200, "message": "[PUT][unit_dns]:success" }
integer |
$unit_dns_id |
ID DNS Μονάδας Ο Κωδικός ID του DNS Μονάδας Η παράμετρος είναι υποχρεωτική ID DNS Μονάδας : GetUnitDns() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
string |
$unit_dns |
DNS Μονάδας Το Όνομα του DNS της Μονάδας Η παράμετρος είναι υποχρεωτική Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$unit_ext_dns |
ExtDNS Μονάδας Το ExtDNS της Μονάδας Η παράμετρος είναι υποχρεωτική Η τιμή της παραμέτρου μπορεί να είναι : string |
integer |
$mm_id |
Κωδικός ΜΜ Ο Κωδικός ΜΜ της Μονάδας Η παράμετρος είναι υποχρεωτική DNS Μονάδας : GetUnits() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
Objects<JSON>
|
Επιστρέφει τα παρακάτω JSON objects : string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης array : parameters : Οι παράμετροι που δίνει ο χρήστης integer : unit_dns_id : Ο Κωδικός ID του DNS Μονάδας που ενημερώθηκε integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης |