Function PutCircuitTypes

Ενημέρωση Τύπου Τηλεπικοινωνιακών Κυκλωμάτων

Η συνάρτηση αυτή ενημερώνει Τύπους Τηλεπικοινωνιακών Κυκλωμάτων σύμφωνα με τις παραμέτρους που έγινε η κλήση

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

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

Πίνακας Αποτελεσμάτων
Στον Πίνακα Αποτελεσμάτων 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/circuit_types \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -u username:password \
   -d '{"circuit_type_id" : 4, "circuit_type" : "ADSL"}'

Παράδειγμα κλήσης της συνάρτησης με JavaScript :

<script>
   var params = JSON.stringify({"circuit_type_id" : 4, "circuit_type" : "ADSL"});

   var http = new XMLHttpRequest();
   http.open("PUT", "https://mm.sch.gr/api/circuit_types");
   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("circuit_type_id" => 4, "circuit_type" => "ADSL");

$curl = curl_init("https://mm.sch.gr/api/circuit_types");

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 = curl_exec($curl);
$data = json_decode($data);
echo "<pre>"; var_dump( $data ); echo "</pre>";
?>

Παράδειγμα κλήσης της συνάρτησης με Ajax :

<script>
   $.ajax({
       type: 'PUT',
       url: 'https://mm.sch.gr/api/circuit_types',
       dataType: "json",
       data: {
          "circuit_type_id" : 4,
          "circuit_type" : "ADSL"
       },
       beforeSend: function(req) {
           req.setRequestHeader('Authorization', btoa('username' + ":" + 'password'));
       },
       success: function(data){
           console.log(data);
       }
   });
</script>

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

{
   "method": "PostCircuitTypes",
   "circuit_type_id": "4",
   "status": 200,
   "message": "success"
}