Function PutUnitNetworkObjects
Ενημέρωση Δικτυακών Αντικειμένων Μονάδας
Η συνάρτηση αυτή ενημερώνει Δικτυακά Αντικείμενα Μονάδας σύμφωνα με τις παραμέτρους που έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο PUT :
https://mm.sch.gr/api/unit_network_objects
Πίνακας Παραμέτρων
Στον Πίνακα Παραμέτρων Parameters
summary εμφανίζονται όλοι οι παράμετροι με
τους οποίους μπορεί να γίνει η κλήση της
συνάρτησης
Όλοι οι παράμετροι είναι προαιρετικοί
εκτός από αυτές που έχουν χαρακτηριστεί ως
υποχρεωτικοί
Οι παράμετροι μπορούν να χρησιμοποιηθούν
με οποιαδήποτε σειρά
Ορισμός Μοναδικών Τιμών Παραμέτρων
Παρακάτω ορίζονται οι παραμέτροι που έχουν μοναδικές τιμές και πραγματοποιειται ελεγχος:
- unit_network_object_idGetUnitNetworkObjects με search_type=EXACT & unit_network_object_id="value"
- ipGetUnitNetworkObjects με search_type=EXACT & ip="value"
- object_dns_name
GetUnitNetworkObjects με search_type=EXACT & object_dns_name="value"
Πίνακας Αποτελεσμάτων
Στον Πίνακα Αποτελεσμάτων Return value
summary εμφανίζονται οι μεταβλητές που
επιστρέφει η συνάρτηση
Όλες οι μεταβλητές επιστρέφονται σε ένα
πίνακα σε JSON μορφή
Η μεταβλητή data είναι ο πίνακας με το
λεξικό
Η μεταβλητή status καθορίζει αν η εκτέλεση της
συνάρτησης ήταν επιτυχής (κωδικός 200) ή
προέκυψε κάποιο σφάλμα
Πίνακας Σφαλμάτων
Στον Πίνακα Σφαλμάτων Thrown exceptions
summary εμφανίζονται τα Μηνύματα Σφαλμάτων
που μπορεί να προκύψουν κατά την κλήση της
συνάρτησης
Οι περιγραφές των Σφαλμάτων καθώς και οι
Κωδικοί τους είναι διαθέσιμες μέσω του
πίνακα Μηνύματα Σφαλμάτων (ExceptionMessages
)
και Κωδικοί Σφαλμάτων (ExceptionCodes
)
αντίστοιχα
Παραδείγματα Κλήσης
Παρακάτω εμφανίζεται μια σειρά από
παραδείγματα κλήσης της συνάρτησης με
διάφορους τρόπους :
cURL | JavaScript | PHP | Ajax
Παράδειγμα κλήσης της συνάρτησης με cURL (console) :
curl -X PUT 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": , \ "ip": "", \ "object_dns_name": "", \ "description": "", \ "unit_network_subnet_id": }'
Παράδειγμα κλήσης της συνάρτησης με JavaScript :
<script> var params = JSON.stringify({ "unit_network_object_id": "", "ip": "", "object_dns_name": "", "description": "", "unit_network_subnet_id": }); var http = new XMLHttpRequest(); http.open("PUT", "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.onreadystatechange = function() { if(http.readyState == 4 && http.status == 200) { alert(http.responseText); } } http.send(params); </script>
Παράδειγμα κλήσης της συνάρτησης με PHP :
<?php header("Content-Type: text/html; charset=utf-8"); $params = array( "unit_network_object_id" => "", "ip" => "", "object_dns_name" => "", "description" => "", "unit_network_subnet_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, "PUT"); curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode( $params )); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $data = json_decode( curl_exec($curl) ); echo "<pre>"; var_dump( $data ); echo "</pre>"; ?>
Παράδειγμα κλήσης της συνάρτησης με Ajax :
<script> $.ajax({ type: 'PUT', url: 'https://mm.sch.gr/api/unit_network_objects', dataType: "json", data: { "unit_network_object_id": "", "ip": "", "object_dns_name": "", "description": "", "unit_network_subnet_id": }, beforeSend: function(req) { req.setRequestHeader('Authorization', btoa('username' + ":" + 'password')); }, success: function(data){ console.log(data); } }); </script>
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται πίνακας σε
μορφή JSON :
{ "method": "PutUnitNetworkObjects", "unit_network_object_id": "", "status": 200, "message": "success" }
integer |
$unit_network_object_id |
Κωδικός Δικτυακού Αντικειμένου Ο Κωδικός του Δικτυακού Αντικειμένου Η παράμετρος είναι υποχρεωτική Δικτυακά Αντικειμένα : GetUnitNetworkObjects() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
integer |
$ip |
$unit_network_subnet_id Υποδίκτυο Μονάδας Ο Κωδικός του Υποδικτύου Μονάδας Η παράμετρος είναι υποχρεωτική Υποδίκτυα Μονάδας : GetUnitNetworkSubnets() Η τιμή της παραμέτρου μπορεί να είναι : integer
|
string |
$object_dns_name |
$ip Όνομα Υποδικτύου Μονάδας Η Διεύθυνση IP του Δικτυακού Αντικειμένου Η παράμετρος είναι υποχρεωτική Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$description |
$object_dns_name Όνομα Υποδικτύου Μονάδας Το DNS Όνομα του Δικτυακού Αντικειμένου Η παράμετρος είναι υποχρεωτική Η τιμή της παραμέτρου μπορεί να είναι : string |
string |
$unit_network_subnet_id |
$description Όνομα Υποδικτύου Μονάδας H Περιγραφή του Δικτυακού Αντικειμένου Η παράμετρος είναι υποχρεωτική Η τιμή της παραμέτρου μπορεί να είναι : string |
Array<JSON>
|
Επιστρέφει ένα πίνακα σε JSON μορφή με πεδία
:
|
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 Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας είναι υποχρεωτικό πεδίο |
MissingUnitNetworkObjectIpValue
|
ExceptionMessages::MissingUnitNetworkObjectIpValue ExceptionCodes::MissingUnitNetworkObjectIpValue Η IP των Δικτυακών Αντικειμένων της Μονάδας πρέπει να έχει τιμή |
InvalidUnitNetworkObjectIpArray
|
ExceptionMessages::InvalidUnitNetworkObjectIpArray ExceptionCodes::InvalidUnitNetworkObjectIpArray Η IP των Δικτυακών Αντικειμένων της Μονάδας δεν μπορεί να έχει πολλαπλές τιμές |
InvalidUnitNetworkObjectIpType
|
ExceptionMessages::InvalidUnitNetworkObjectIpType ExceptionCodes::InvalidUnitNetworkObjectIpType Η IP των Δικτυακών Αντικειμένων της Μονάδας πρέπει να έχει αριθμητική μορφή IP |
MissingUnitNetworkObjectIpParam
|
ExceptionMessages::MissingUnitNetworkObjectIpParam ExceptionCodes::MissingUnitNetworkObjectIpParam Η IP των Δικτυακών Αντικειμένων της Μονάδας είναι υποχρεωτικό πεδίο |
DuplicatedUnitNetworkObjectIpValue
|
ExceptionMessages::DuplicatedUnitNetworkObjectIpValue ExceptionCodes::DuplicatedUnitNetworkObjectIpValue Η διεύθυνση IP του Δικτυακού Αντικειμένου της Μονάδας υπάρχει ήδη |
MissingUnitNetworkObjectDnsNameValue
|
ExceptionMessages::MissingUnitNetworkObjectDnsNameValue ExceptionCodes::MissingUnitNetworkObjectDnsNameValue Το DNS Όνομα των Δικτυακών Αντικειμένων της Μονάδας πρέπει να έχει τιμή |
InvalidUnitNetworkObjectDnsNameArray
|
ExceptionMessages::InvalidUnitNetworkObjectDnsNameArray ExceptionCodes::InvalidUnitNetworkObjectDnsNameArray Το DNS Όνομα των Δικτυακών Αντικειμένων της Μονάδας δεν μπορεί να έχει πολλαπλές τιμές |
InvalidUnitNetworkObjectDnsNameType
|
ExceptionMessages::InvalidUnitNetworkObjectDnsNameType ExceptionCodes::InvalidUnitNetworkObjectDnsNameType Το DNS Όνομα των Δικτυακών Αντικειμένων της Μονάδας πρέπει να είναι αλφαριθμητικό |
MissingUnitNetworkObjectDnsNameParam
|
ExceptionMessages::MissingUnitNetworkObjectDnsNameParam ExceptionCodes::MissingUnitNetworkObjectDnsNameParam Το DNS Όνομα των Δικτυακών Αντικειμένων της Μονάδας είναι υποχρεωτικό πεδίο |
DuplicatedUnitNetworkObjectDnsNameValue
|
ExceptionMessages::DuplicatedUnitNetworkObjectDnsNameValue ExceptionCodes::DuplicatedUnitNetworkObjectDnsNameValue Το DNS όνομα του Δικτυακού Αντικειμένου της Μονάδας υπάρχει ήδη |
InvalidUnitNetworkObjectDescriptionType
|
ExceptionMessages::InvalidUnitNetworkObjectDescriptionType ExceptionCodes::InvalidUnitNetworkObjectDescriptionType Η Περιγραφή των Δικτυακών Αντικειμένων της Μονάδας πρέπει να είναι αλφαριθμητική |
MissingUnitNetworkSubnetIDValue
|
ExceptionMessages::MissingUnitNetworkSubnetIDValue ExceptionCodes::MissingUnitNetworkSubnetIDValue Ο Κωδικός του Υποδικτύου της Μονάδας της Μονάδας πρέπει να έχει τιμή |
InvalidUnitNetworkSubnetIDArray
|
ExceptionMessages::InvalidUnitNetworkSubnetIDArray ExceptionCodes::InvalidUnitNetworkSubnetIDArray Ο Κωδικός του Υποδικτύου της Μονάδας δεν μπορεί να έχει πολλαπλές τιμές |
InvalidUnitNetworkSubnetValue
|
ExceptionMessages::InvalidUnitNetworkSubnetValue ExceptionCodes::InvalidUnitNetworkSubnetValue Το Υποδικτύο της Μονάδας δεν βρέθηκε |
InvalidUnitNetworkSubnetIDType
|
ExceptionMessages::InvalidUnitNetworkSubnetIDType ExceptionCodes::InvalidUnitNetworkSubnetIDType Ο Κωδικός του Υποδικτύου της Μονάδας πρέπει να είναι αριθμητικός |
MissingUnitNetworkSubnetIDParam
|
ExceptionMessages::MissingUnitNetworkSubnetIDParam ExceptionCodes::MissingUnitNetworkSubnetIDParam Ο Κωδικός του Υποδικτύου της Μονάδας είναι υποχρεωτικό πεδίο |