Function DeleteUnitNetworkObjects
Διαγραφή Δικτυακών Αντικειμένων Μονάδας
Η συνάρτηση αυτή διαγράφει τα Δικτυακά Αντικείμενα Μονάδας σύμφωνα με τις παραμέτρους που έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο DELETE :
https://mm.sch.gr/api/unit_network_objects
Πίνακας Παραμέτρων
Στον Πίνακα Παραμέτρων Parameters
summary εμφανίζονται όλοι οι παράμετροι με
τους οποίους μπορεί να γίνει η κλήση της
συνάρτησης
Όλοι οι παράμετροι είναι προαιρετικοί
εκτός από αυτές που έχουν χαρακτηριστεί ως
υποχρεωτικοί
Οι παράμετροι μπορούν να χρησιμοποιηθούν
με οποιαδήποτε σειρά
Πίνακας Αποτελεσμάτων
Στον Πίνακα Αποτελεσμάτων Return value
summary εμφανίζονται οι μεταβλητές που
επιστρέφει η συνάρτηση
Όλες οι μεταβλητές επιστρέφονται σε ένα
πίνακα σε JSON μορφή
Η μεταβλητή data είναι ο πίνακας με το
λεξικό
Η μεταβλητή status καθορίζει αν η εκτέλεση της
συνάρτησης ήταν επιτυχής (κωδικός 200) ή
προέκυψε κάποιο σφάλμα
Πίνακας Σφαλμάτων
Στον Πίνακα Σφαλμάτων Thrown exceptions
summary εμφανίζονται τα Μηνύματα Σφαλμάτων
που μπορεί να προκύψουν κατά την κλήση της
συνάρτησης
Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (ExceptionMessages
)
και Κωδικοί Σφαλμάτων (ExceptionCodes
)
αντίστοιχα
Παραδείγματα Κλήσης
Παρακάτω εμφανίζεται μια σειρά από
παραδείγματα κλήσης της συνάρτησης με
διάφορους τρόπους :
cURL | JavaScript | PHP | Ajax
Παράδειγμα κλήσης της μεθόδου με cURL (console) :
curl -X DELETE https://mm.sch.gr/api/unit_network_objects \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -u username:password \ -d { "unit_network_object_id" : "" }'
Παράδειγμα κλήσης της μεθόδου με JavaScript :
<script> var params = JSON.stringify({"unit_network_object_id" : ""}); var http = new XMLHttpRequest(); http.open("DELETE", "https://mm.sch.gr/api/unit_network_objects"); http.setRequestHeader("Accept", "application/json"); http.setRequestHeader("Content-type", "application/json; charset=utf-8"); http.setRequestHeader("Content-length", params.length); http.setRequestHeader("Authorization", "Basic " + btoa('username' + ':' + 'password') ); http.onreadystatechange = function() { if(http.readyState == 4 && http.status == 200) { var result = JSON.parse(http.responseText); document.write(result.status + " : " + result.message); } } http.send(params); </script>
Παράδειγμα κλήσης της μεθόδου με PHP :
<?php header("Content-Type: text/html; charset=utf-8"); $params = array("unit_network_object_id" => ""); $curl = curl_init("https://mm.sch.gr/api/unit_network_objects"); curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($curl, CURLOPT_USERPWD, "username:password"); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE"); curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode( $params )); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $data = curl_exec($curl); $data = json_decode($data); echo "<pre>"; var_dump( $data ); echo "</pre>"; ?>
Παράδειγμα κλήσης της συνάρτησης με Ajax :
<script> $.ajax({ type: 'DELETE', url: 'https://mm.sch.gr/api/unit_network_objects', dataType: "json", data: { "unit_network_object_id" : "" }, beforeSend: function(req) { req.setRequestHeader('Authorization', btoa('username' + ":" + 'password')); }, success: function(data){ console.log(data); } }); </script>
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται πίνακας σε
μορφή JSON :
{ "method": "DeleteUnitNetworkObjects", "unit_network_object_id": , "status": 200, "message": "success" }
integer |
$unit_network_object_id |
Κωδικός Δικτυακού Αντικειμένου Ο Κωδικός του Δικτυακού Αντικειμένου Η παράμετρος είναι υποχρεωτική Δικτυακά Αντικειμένα : GetUnitNetworkObjects() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
Array<JSON>
|
Επιστρέφει ένα πίνακα σε JSON μορφή με πεδία
: string : method : Η μέθοδος κλήσης της συνάρτησης integer : status : Ο Κωδικός ExceptionCodes του
αποτελέσματος της κλήσηςstring : message : Το Μήνυμα ExceptionMessages του
αποτελέσματος της κλήσηςinteger : unit_network_object_id : Ο Κωδικός του Δικτυακού Αντικειμένου |
Unauthorized
|
ExceptionMessages::Unauthorized ExceptionCodes::Unauthorized Έλεγχος αν ο χρήστης υπάρχει και έχει δικαιώματα να χρησιμοποιείσει τη μέθοδο |
MissingUnitNetworkObjectIDValue
|
ExceptionMessages::MissingUnitNetworkObjectIDValue ExceptionCodes::MissingUnitNetworkObjectIDValue Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας πρέπει να έχει τιμή |
InvalidUnitNetworkObjectIDArray
|
ExceptionMessages::InvalidUnitNetworkObjectIDArray ExceptionCodes::InvalidUnitNetworkObjectIDArray Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας δεν μπορεί να έχει πολλαπλές τιμές |
InvalidUnitNetworkObjectValue
|
ExceptionMessages::InvalidUnitNetworkObjectValue ExceptionCodes::InvalidUnitNetworkObjectValue Τα Δικτυακά Αντικείμενα της Μονάδας δεν βρέθηκαν |
InvalidUnitNetworkObjectIDType
|
ExceptionMessages::InvalidUnitNetworkObjectIDType ExceptionCodes::InvalidUnitNetworkObjectIDType Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας πρέπει να είναι αριθμητικός |
MissingUnitNetworkObjectIDParam
|
ExceptionMessages::MissingUnitNetworkObjectIDParam ExceptionCodes::MissingUnitNetworkObjectIDParam Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας είναι υποχρεωτικό πεδίο |