Function GetUnitNetworkSubnets
Υποδίκτυα Μονάδας
Η συνάρτηση αυτή επιστρέφει όλα τα Υποδίκτυα Μονάδας σύμφωνα με τις παραμέτρους που έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω
διεύθυνσης με τη μέθοδο GET :
https://mm.sch.gr/api/unit_network_subnets
Τα αποτελέσματα είναι ταξινομημένα ως
προς τον Κωδικό ΜΜ της Μονάδας
Μέσω των παραμέτρων Πεδίο Ταξινόμησης ($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_subnets \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -u username:password \ -d '{subnet_type": ""}'
Παράδειγμα κλήσης της συνάρτησης με JavaScript :
<script> var params = JSON.stringify({ "subnet_type": "" }); var http = new XMLHttpRequest(); http.open("GET", "https://mm.sch.gr/api/unit_network_subnets"); 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("subnet_type" => ""); $curl = curl_init("https://mm.sch.gr/api/unit_network_subnets"); 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_subnets', dataType: "json", data:{'subnet_type': ''}, beforeSend: function(req) { req.setRequestHeader('Authorization', btoa('username' + ":" + 'password')); }, success: function(data){ console.log(data); } }); </script>
Πίνακας Δεδομένων
Παρακάτω εμφανίζεται ένα δείγμα
του λεξικού σε μορφή JSON :
{"data":[ { "unit_network_subnet_id": , "subnet_name":"" , "subnet_ip": "" , "mask": "", "subnet_default_router": "", "mm_id": , "registry_no": "", "unit_name": "", "special_unit_name": "", "unit_network_subnet_type_id": , "unit_network_subnet_type": "" } ]}
integer |
$unit_network_subnet |
Υποδίκτυο Μονάδας Ο Κωδικός του Υποδικτύου Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : integer|array[integer]
|
string |
$subnet_name |
Όνομα Υποδικτύου Μονάδας Το Όνομα του Υποδικτύου Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$subnet_ip |
IP Υποδικτύου Μονάδας Η IP Διευθυνση του Υποδικτύου Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$subnet_default_router |
$mask Μάσκα Υποδικτύου Μονάδας Η Μάσκα του Υποδικτύου Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
string |
$mask |
$subnet_default_router Gateway Υποδικτύου Μονάδας Η Default Gateway του Υποδικτύου Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string|array[string]
|
mixed |
$unit |
$subnet_type Τύπος Υποδικτύου Ο Κωδικός και το Όνομα του Τύπου Υποδικτύου Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|array[integer|string]}
|
mixed |
$unit_network_subnet_type |
$unit Μονάδα Ο Κωδικός MM και το Όνομα της Μονάδας Η παράμετρος δεν είναι υποχρεωτική Λίστα Τύπων Αναζήτησης : SearchEnumTypes Μονάδες : GetUnits() Η τιμή της παραμέτρου μπορεί να είναι : mixed{integer|string|array[integer|string]}
|
integer |
$pagesize |
Αριθμός Εγγραφών/Σελίδα Ο αριθμός των εγγραφών που θα επιστρέψουν ανα σελίδα Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφούν όλες οι εγγραφές ( Parameters::AllPageSize )Λίστα Παραμέτρων Σελιδοποίησης : Parameters Η τιμή της παραμέτρου μπορεί να είναι : integer
|
integer |
$page |
Αριθμός Σελίδας Ο αριθμός της σελίδας με τις $pagesize εγγραφές που βρέθηκαν σύμφωμα με τις παραμέτρους Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε θα επιστραφεί η πρώτη σελίδα Η τιμή της παραμέτρου μπορεί να είναι : integer
|
string |
$orderby |
Πεδίο Ταξινόμησης Το όνομα του πεδίου με το οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με τον Κωδικό ΜΜ της Μονάδας Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$ordertype |
Τύπος Ταξινόμησης Ο Τύπος Ταξινόμησης με τον οποίο γίνεται η ταξινόμηση των εγγραφών Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η ταξινόμηση γίνεται με Αύξουσα Σειρά ( OrderEnumTypes::ASC )Λίστα Τύπων Ταξινόμησης : OrderEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
string |
$searchtype |
Τύπος Αναζήτησης Ο Τύπος Αναζήτησης με τον οποίο γίνεται η αναζήτηση
Η παράμετρος δεν είναι υποχρεωτική Αν η παράμετρος δεν έχει τιμή τότε η αναζήτηση στα πεδία αυτά γίνεται με τον Τύπο SearchEnumTypes::ContainAll Λίστα Τύπων Αναζήτησης : SearchEnumTypes Η τιμή της παραμέτρου μπορεί να είναι : string
|
Array<JSON>
|
Επιστρέφει ένα πίνακα σε JSON μορφή με πεδία
: string : method : Η μέθοδος κλήσης της συνάρτησης integer : status : Ο Κωδικός ExceptionCodes του
αποτελέσματος της κλήσηςstring : message : Το Μήνυμα ExceptionMessages του
αποτελέσματος της κλήσηςinteger : count : Το πλήθος των εγγραφών της κλήσης σύμφωνα με τις παραμέτρους σελιδοποίησης integer : total : Το πλήθος των εγγραφών χωρίς τις παραμέτρους σελιδοποίησης array : data : Ο Πίνακας με το λεξικό
|
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 Ο Αριθμός Εγγραφών/Σελίδα πρέπει να είναι αριθμητικός |
InvalidUnitNetworkSubnetIDType
|
ExceptionMessages::InvalidUnitNetworkSubnetIDType ExceptionCodes::InvalidUnitNetworkSubnetIDType Ο Κωδικός του Υποδικτύου της Μονάδας πρέπει να είναι αριθμητικός |
InvalidUnitNetworkSubnetNameType
|
ExceptionMessages::InvalidUnitNetworkSubnetNameType ExceptionCodes::InvalidUnitNetworkSubnetNameType Το Όνομα του Υποδικτύου της Μονάδας πρέπει να είναι αλφαριθμητικό |
InvalidUnitNetworkSubnetIpType
|
ExceptionMessages::InvalidUnitNetworkSubnetIpType ExceptionCodes::InvalidUnitNetworkSubnetIpType H IP του Υποδικτύου της Μονάδας πρέπει να είναι αλφαριθμητική |
InvalidUnitNetworkSubnetDefaultRouterType
|
ExceptionMessages::InvalidUnitNetworkSubnetDefaultRouterType ExceptionCodes::InvalidUnitNetworkSubnetDefaultRouterType H Default Gateway του Υποδικτύου της Μονάδας πρέπει να είναι αλφαριθμητική |
InvalidUnitNetworkSubnetMaskType
|
ExceptionMessages::InvalidUnitNetworkSubnetMaskType ExceptionCodes::InvalidUnitNetworkSubnetMaskType H Μάσκα του Υποδικτύου της Μονάδας πρέπει να είναι αλφαριθμητική |
InvalidUnitType
|
ExceptionMessages::InvalidUnitType ExceptionCodes::InvalidUnitType Η Μονάδα πρέπει να είναι αριθμητική ή αλφαριθμητική |
InvalidUnitNetworkSubnetTypeType
|
ExceptionMessages::InvalidUnitNetworkSubnetTypeType ExceptionCodes::InvalidUnitNetworkSubnetTypeType Η Μονάδα πρέπει να είναι αριθμητική ή αλφαριθμητική |
InvalidOrderType
|
ExceptionMessages::InvalidOrderType ExceptionCodes::InvalidOrderType Ο Τύπος Ταξινόμησης πρέπει να είναι ASC ή DESC |
InvalidOrderBy
|
ExceptionMessages::InvalidOrderBy ExceptionCodes::InvalidOrderBy Το Πεδίο Ταξινόμησης πρέπει να είναι κάποιο από τα πεδία που επιστρέφει η συνάρτηση |