Function PutConnections

Ενημέρωση Διασύνδεσης

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

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

• H σχολική μονάδα που αντιστοιχεί στο ldap_id,cpe_id,circuit_id θα πρέπει να είναι ίδια με την σχολική μονάδα της Διασύνδεσης.
• Ένα CPE μπορεί να ανήκει σε περισσότερες από μία Διασυνδέσεις.
• Ο LDAP λογαριασμός και το Τηλεπικοινωνιακό Κύκλωμα ανήκουν σε μια και μοναδική Διασύνδεση.
• Ένα καταργημένο Τηλεπικοινωνιακό Κύκλωμα δεν μπορεί να ανήκει σε μια Διασύνδεση.
• Το CPE είναι μοναδικό ανά σχολική μονάδα , ένα CPE μπορεί να ανήκει σε μια και μόνο σχολική μονάδα.
• Ο LDAP λογαριασμός είναι μοναδικός ανά σχολική μονάδα, Ο LDAP λογαριασμός μπορεί να ανήκει σε μια και μόνο σχολική μονάδα.
• Το Τηλεπικοινωνιακό Κύκλωμα είναι μοναδικό ανά σχολική μονάδα, ένα Τηλεπικοινωνιακό Κύκλωμα μπορεί να ανήκει σε μια και μόνο σχολική μονάδα.

Πίνακας Παραμέτρων
Στον Πίνακα Παραμέτρων 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/connections \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -u username:password \
   -d '{"connection_id" : "100", "circuit_id" : "345"}'

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

<script>
   var params = JSON.stringify({
       "connection_id" : "100", "circuit_id" : "345"
   });

   var http = new XMLHttpRequest();
   http.open("PUT", "https://mm.sch.gr/api/connections");
   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 + " : " + result.data);
       }
   }

   http.send(params);
</script>

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

<?php
   header("Content-Type: text/html; charset=utf-8");

   $params = array(
      "connection_id" => "100", "circuit_id" => "345"
   );

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

   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/connections',
       dataType: "json",
       data: {
         "connection_id" : "100", "circuit_id" : "345"
       },
       beforeSend: function(req) {
           req.setRequestHeader('Authorization', btoa('username' + ":" + 'password'));
       },
       success: function(data){
           console.log(data);
       }
   });
</script>

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

{
  "method": "PutConnections",
  "connection_id": 100,
  "status": 200,
  "message": "success"
}