Overview

Packages

  • DELETE
  • DEPRECATED
  • GET
  • POST
  • PUT
  • SYSTEM

Functions

  • DeleteCircuits
  • DeleteCircuitTypes
  • DeleteConnections
  • DeleteConnectionUnitNetworkSubnets
  • DeleteExtLog
  • DeleteGroups
  • DeleteLevels
  • DeleteUnitNetworkObjects
  • DeleteUnitNetworkSubnets
  • DeleteUnitNetworkSubnetTypes
  • GetCircuits
  • GetCircuitTypes
  • GetConnections
  • GetConnectionUnitNetworkSubnets
  • GetGroups
  • GetLevels
  • GetUnitNetworkObjects
  • GetUnitNetworkSubnets
  • GetUnitNetworkSubnetTypes
  • GetUnitsOld
  • PostCircuits
  • PostCircuitTypes
  • PostConnections
  • PostConnectionUnitNetworkSubnets
  • PostGroups
  • PostLevels
  • PostUnitNetworkObjects
  • PostUnitNetworkSubnets
  • PostUnitNetworkSubnetTypes
  • PutCircuits
  • PutCircuitTypes
  • PutConnections
  • PutConnectionUnitNetworkSubnets
  • PutGroups
  • PutLevels
  • PutUnitNetworkObjects
  • PutUnitNetworkSubnets
  • PutUnitNetworkSubnetTypes
  • Overview
  • Package
  • Function

Function GetUnitNetworkObjects

Δικτυακά Αντικειμένα Μονάδων

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

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

Τα αποτελέσματα είναι ταξινομημένα ως προς τον Κωδικό των Δικτυακών Αντικειμένων της Μονάδας
Μέσω των παραμέτρων Πεδίο Ταξινόμησης ($orderby) και Τύπος Ταξινόμησης ($ordertype) μπορεί να καθοριστεί το πεδίο και η σειρά ταξινόμησης


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


Πίνακας Αποτελεσμάτων
Στον Πίνακα Αποτελεσμάτων Return value summary εμφανίζονται οι μεταβλητές που επιστρέφει η συνάρτηση
Όλες οι μεταβλητές επιστρέφονται σε ένα πίνακα σε JSON μορφή
Η μεταβλητή data είναι ο πίνακας με το λεξικό
Η μεταβλητή status καθορίζει αν η εκτέλεση της συνάρτησης ήταν επιτυχής (κωδικός 200) ή προέκυψε κάποιο σφάλμα


Πίνακας Σφαλμάτων
Στον Πίνακα Σφαλμάτων Thrown exceptions summary εμφανίζονται τα Μηνύματα Σφαλμάτων που μπορεί να προκύψουν κατά την κλήση της συνάρτησης
Οι περιγραφές των Σφαλμάτων καθώς και οι Κωδικοί τους είναι διαθέσιμες μέσω του πίνακα Μηνύματα Σφαλμάτων (ExceptionMessages) και Κωδικοί Σφαλμάτων (ExceptionCodes) αντίστοιχα


Παραδείγματα Κλήσης
Παρακάτω εμφανίζεται μια σειρά από παραδείγματα κλήσης της συνάρτησης με διάφορους τρόπους :
cURL | JavaScript | PHP | Ajax


Παράδειγμα κλήσης της συνάρτησης με cURL (console) :

curl -X GET https://mm.sch.gr/api/unit_network_objects \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -u username:password \
   -d '{"unit_network_subnet": ""}'

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

<script>
   var params = JSON.stringify({ "unit_network_subnet": "" });

   var http = new XMLHttpRequest();
   http.open("GET", "https://mm.sch.gr/api/unit_network_objects");
   http.setRequestHeader("Accept", "application/json");
   http.setRequestHeader("Content-type", "application/json; charset=utf-8");
   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("unit_network_subnet" => "");

   $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, "GET");
   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: 'GET',
       url: 'https://mm.sch.gr/api/unit_network_objects',
       dataType: "json",
       data:{'unit_network_subnet': ''},
       beforeSend: function(req) {
           req.setRequestHeader('Authorization', btoa('username' + ":" + 'password'));
       },
       success: function(data){
           console.log(data);
       }
   });
</script>


Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα του λεξικού σε μορφή JSON :

{"data":[
        {
                "unit_network_object_id": ,
                "ip": "",
                "object_dns_name": "",
                "description": "",
                "unit_network_subnet_id":,
                "unit_network_subnet": ""
        }
]}

Package: DEPRECATED
Author: ΤΕΙ Αθήνας
Located at api/get/GetUnitNetworkObjects.php
Parameters summary
integer $unit_network_object unit_network_object Δικτυακό Αντικείμενο
Ο Κωδικός του Δικτυακού Αντικειμένου
Η παράμετρος δεν είναι υποχρεωτική
Λίστα Τύπων Αναζήτησης : SearchEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : integer|array[integer]
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό του Δικτυακού Αντικειμένου
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::ContainAll
  • array[integer]
    Σύνολο από Αριθμητικές τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
string $ip IP Δικτυακού Αντικειμένου
Η Διεύθυνση IP του Δικτυακού Αντικειμένου
Η παράμετρος δεν είναι υποχρεωτική
Λίστα Τύπων Αναζήτησης : SearchEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με την Διεύθυνση IP του Δικτυακού Αντικειμένου
    Με την χρήση της παραμέτρου Τύπος Αναζήτησης ($searchtype) μπορεί να καθοριστεί ο τρόπος με τον οποίο θα αναζητηθεί η τιμή της παραμέτρου στην Διεύθυνση IP του Δικτυακού Αντικειμένου
    Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στην Διεύθυνση IP του Δικτυακού Αντικειμένου γίνεται με τον Tύπο SearchEnumTypes::ContainAll
  • array[string]
    Σύνολο από Αριθμητικές και Αλφαριθμητικές τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
string $object_dns_name DNS Όνομα Δικτυακού Αντικειμένου
Το DNS Όνομα του Δικτυακού Αντικειμένου
Η παράμετρος δεν είναι υποχρεωτική
Λίστα Τύπων Αναζήτησης : SearchEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το DNS Όνομα του Δικτυακού Αντικειμένου
    Με την χρήση της παραμέτρου Τύπος Αναζήτησης ($searchtype) μπορεί να καθοριστεί ο τρόπος με τον οποίο θα αναζητηθεί η τιμή της παραμέτρου στον Αριθμό του Τηλεπικοινωνιακού Κυκλώματος
    Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στον DNS Όνομα του Δικτυακού Αντικειμένου γίνεται με τον Tύπο SearchEnumTypes::ContainAll
  • array[string]
    Σύνολο από Αλφαριθμητικές τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
mixed $unit_network_subnet Υποδίκτυο Μονάδας
Ο Κωδικός και το Όνομα του Υποδικτύου Μονάδας
Η παράμετρος δεν είναι υποχρεωτική
Λίστα Τύπων Αναζήτησης : SearchEnumTypes
Υποδίκτυα Μονάδας : GetUnitNetworkSubnets()
Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|array[integer|string]}
  • integer
    Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό του Υποδικτύου Μονάδας
    Η αναζήτηση στον Κωδικό γίνεται με τον Τύπο SearchEnumTypes::Exact
  • string
    Αλφαριθμητική : Η αναζήτηση γίνεται με το Όνομα του Υποδικτύου Μονάδας
    Η αναζήτηση στο Όνομα γίνεται με τον Τύπο SearchEnumTypes::Exact
  • array[integer|string]
    Σύνολο από Αριθμητικές και Αλφαριθμητικές τιμές διαχωρισμένες με κόμμα
    Η αναζήτηση γίνεται με οποιαδήποτε από αυτές τις τιμές
integer $pagesize Αριθμός Εγγραφών/Σελίδα
Ο αριθμός των εγγραφών που θα επιστρέψουν ανα σελίδα
Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφούν όλες οι εγγραφές (Parameters::AllPageSize)
Λίστα Παραμέτρων Σελιδοποίησης : Parameters
Η τιμή της παραμέτρου μπορεί να είναι : integer
  • integer
    Αριθμητική : Η τιμή της παραμέτρου πρέπει να είναι μεγαλύτερη από 0
integer $page Αριθμός Σελίδας
Ο αριθμός της σελίδας με τις $pagesize εγγραφές που βρέθηκαν σύμφωμα με τις παραμέτρους
Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφεί η πρώτη σελίδα
Η τιμή της παραμέτρου μπορεί να είναι : integer
  • integer
    Αριθμητική : Η τιμή της παραμέτρου πρέπει να είναι μεγαλύτερη από 0
string $orderby Πεδίο Ταξινόμησης
Το όνομα του πεδίου με το οποίο γίνεται η ταξινόμηση των εγγραφών
Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με τον Κωδικό ΜΜ της Μονάδας
Η τιμή της παραμέτρου μπορεί να είναι : string
  • string
    Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι οποιοδήποτε πεδίο επιστρέφει η συνάρτηση στον πίνακα data
string $ordertype Τύπος Ταξινόμησης
Ο Τύπος Ταξινόμησης με τον οποίο γίνεται η ταξινόμηση των εγγραφών
Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με Αύξουσα Σειρά (OrderEnumTypes::ASC)
Λίστα Τύπων Ταξινόμησης : OrderEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : string
  • string
    Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι ένας από τους Tύπους OrderEnumTypes
string $searchtype Τύπος Αναζήτησης
Ο Τύπος Αναζήτησης με τον οποίο γίνεται η αναζήτηση
  • στην IP Διευθυνση ($ip) του Δικτυακού Αντικειμένου
  • στο DNS Όνομα ($object_dns_name) του Δικτυακού Αντικειμένου

Η παράμετρος δεν είναι υποχρεωτική
Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στα πεδία αυτά γίνεται με τον Τύπο SearchEnumTypes::ContainAll
Λίστα Τύπων Αναζήτησης : SearchEnumTypes
Η τιμή της παραμέτρου μπορεί να είναι : string
  • string
    Αλφαριθμητική : Η τιμή της παραμέτρου μπορεί να είναι ένας από τους Tύπους SearchEnumTypes
Return value summary
Array<JSON> Επιστρέφει ένα πίνακα σε JSON μορφή με πεδία :

string : method : Η μέθοδος κλήσης της συνάρτησης
integer : status : Ο Κωδικός ExceptionCodes του αποτελέσματος της κλήσης
string : message : Το Μήνυμα ExceptionMessages του αποτελέσματος της κλήσης
integer : count : Το πλήθος των εγγραφών της κλήσης σύμφωνα με τις παραμέτρους σελιδοποίησης
integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης
array : data : Ο Πίνακας με το λεξικό
  • integer : unit_network_object_id : Ο Κωδικός του Δικτυακού Αντικειμένου
  • string : ip : Η Διεύθυνση IP του Δικτυακού Αντικειμένου
  • string : object_dns_name : Το DNS Όνομα του Δικτυακού Αντικειμένου
  • string : description : Η Περιγραφή του Δικτυακού Αντικειμένου
  • integer : unit_network_subnet_id : Ο Κωδικός του Υποδικτύου Μονάδας
  • string : unit_network_subnet : Το Όνομα του Υποδικτύου Μονάδας(Λεξικό : GetUnitNetworkSubnets())
Thrown exceptions summary
InvalidSearchType ExceptionMessages::InvalidSearchType
ExceptionCodes::InvalidSearchType
Ο Τύπος Αναζήτησης είναι λάθος
MissingPageValue ExceptionMessages::MissingPageValue
ExceptionCodes::MissingPageValue
Ο Αριθμός Σελίδας πρέπει να έχει τιμή
InvalidPageArray ExceptionMessages::InvalidPageArray
ExceptionCodes::InvalidPageArray
Ο Αριθμός Σελίδας δεν μπορεί να έχει πολλαπλές τιμές
InvalidPageNumber ExceptionMessages::InvalidPageNumber
ExceptionCodes::InvalidPageNumber
Ο Αριθμός Σελίδας πρέπει να είναι μεγαλύτερος από 0
InvalidPageType ExceptionMessages::InvalidPageType
ExceptionCodes::InvalidPageType
Ο Αριθμός Σελίδας πρέπει να είναι αριθμητικός
MissingPageSizeValue ExceptionMessages::MissingPageSizeValue
ExceptionCodes::MissingPageSizeValue
Ο Αριθμός Εγγραφών/Σελίδα πρέπει να έχει τιμή
InvalidPageSizeArray ExceptionMessages::InvalidPageSizeArray
ExceptionCodes::InvalidPageSizeArray
Ο Αριθμός Εγγραφών/Σελίδα δεν μπορεί να έχει πολλαπλές τιμές
InvalidPageSizeNumber ExceptionMessages::InvalidPageSizeNumber
ExceptionCodes::InvalidPageSizeNumber
Ο Αριθμός Εγγραφών/Σελίδα πρέπει να είναι από 0 έως 500
InvalidPageSizeType ExceptionMessages::InvalidPageSizeType
ExceptionCodes::InvalidPageSizeType
Ο Αριθμός Εγγραφών/Σελίδα πρέπει να είναι αριθμητικός
InvalidUnitNetworkObjectIDType ExceptionMessages::InvalidUnitNetworkObjectIDType
ExceptionCodes::InvalidUnitNetworkObjectIDType
Ο Κωδικός των Δικτυακών Αντικειμένων της Μονάδας πρέπει να είναι αριθμητικός
InvalidUnitNetworkObjectIpType ExceptionMessages::InvalidUnitNetworkObjectIpType
ExceptionCodes::InvalidUnitNetworkObjectIpType
Η IP των Δικτυακών Αντικειμένων της Μονάδας πρέπει να έχει αριθμητική μορφή IP
InvalidUnitNetworkObjectDnsNameType ExceptionMessages::InvalidUnitNetworkObjectDnsNameType
ExceptionCodes::InvalidUnitNetworkObjectDnsNameType
Το DNS Όνομα των Δικτυακών Αντικειμένων της Μονάδας πρέπει να είναι αλφαριθμητικό
InvalidUnitNetworkSubnetType ExceptionMessages::InvalidUnitNetworkSubnetType
ExceptionCodes::InvalidUnitNetworkSubnetType
Το Υποδικτύο της Μονάδας πρέπει να είναι αριθμητικό ή αλφαριθμητικό
InvalidOrderType ExceptionMessages::InvalidOrderType
ExceptionCodes::InvalidOrderType
Ο Τύπος Ταξινόμησης πρέπει να είναι ASC ή DESC
InvalidOrderBy ExceptionMessages::InvalidOrderBy
ExceptionCodes::InvalidOrderBy
Το Πεδίο Ταξινόμησης πρέπει να είναι κάποιο από τα πεδία που επιστρέφει η συνάρτηση
mm.sch.gr API documentation generated by ApiGen 2.8.0