Function GetCrmData

Αναζήτηση CRM Δικτυακά Στοιχεία Μονάδας

Η συνάρτηση αυτή επιστρέφει CRM Δικτυακά Στοιχεία Μονάδας , μέσω web-service από το CRM, σύμφωνα με τις παραμέτρους που έγινε η κλήση
Η κλήση μπορεί να γίνει μέσω της παρακάτω διεύθυνσης με τη μέθοδο GET και route_api_name = crm_data :
https://mm.sch.gr/api/crm_data

Πίνακας Παραμέτρων

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

Πίνακας Αποτελεσμάτων

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

Πίνακας Σφαλμάτων

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

Παραδείγματα Κλήσης

Υπάρχουν διαθέσιμα παραδείγματα κλήσης της συνάρτησης με διάφορους τρόπους (ApiRequestExamples).

Μηνύματα Authentication/Authorization

Υπάρχουν αναλυτικές πληροφορίες για τα μηνύματα Authentication/Authorization (AuthMessages).

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

{
 "data": [{}],
 "controller": "GetCrmData",
 "function": "crm_data",
 "method": "GET",
 "status": 200,
 "message": "[GET][crm_data]:success"
}

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

{  "data": {
  "mmId": ``,
  "circuits": [{
                  "id": ``,
                  "linenumber": ``,
                  "type": ``,
                  "owner": ``,
                  "services": [{
                                  "id": ``,
                                  "type": ``,
                                  "owner": ``,
                                  "bandwidth": ``
                              }]
              }],
  "subnets": [ {"id": ``,
                "type": "LAN",
                "network": ``},
               {"id": ``,
                "type": "ROUTER",
                "network": ``},
               {"id": ``,
                "type": "NAT",
                "network": ``}
             ],
  "connections": [{
                      "id": ``,
                      "name": ``,
                      "subnets": [],
                      "circuits": [],
                      "devices": [],
                      "ldapEntries": []
                  }]
}

Package: GET
Author: ΤΕΙ Αθήνας
Located at api/get/GetCrmData.php

Parameters summary
`integer`	`$mm_id`	Μονάδα Ο Κωδικός MM της Μονάδας Η παράμετρος είναι *υποχρεωτική* Η τιμή της παραμέτρου μπορεί να είναι : integer integer Αριθμητική : Η αναζήτηση γίνεται με τον Κωδικό ΜΜ της Μονάδας, Μπορεί να δωθέι oλοκληρος ο Κωδικός ΜΜ. Η αναζήτηση στο CRM γίνεται στις εγγραφές που περιέχουν ακριβώς την τιμή του $mm_id και επιστρέφει τα δικτυακα στοιχεία της μονάδας 1. Κυκλώματα 2. Υποδίκτυα 3. Συνδέσεις Σε περίπτωση που δεν βρεθεί μονάδα με το κωδικό $mm_id που δώθηκε από τον χρήστη επιστρέφεται { "data": { "message": "Page not found." } }

Return value summary
`Objects<JSON>`	Επιστρέφει τα παρακάτω JSON objects : array : data : Ο Πίνακας με τα δεδομένα integer : mmId : Ο Κωδικός ΜΜ array : circuits : Κυκλώματα Μονάδας integer : id : Ο Κωδικός ID του Κυκλώματος integer : linenumber : Το Αριθμός Γραμμής του Κυκλώματος string : type : Ο Τύπος του Κυκλώματος string : owner : Ο Πάροχος του Κυκλώματος array : services : Υπηρεσίες Κυκλώματος integer : id : Ο Κωδικός ID του Κυκλώματος string : type : Ο Τύπος του Κυκλώματος string : owner : Ο Πάροχος του Κυκλώματος string : bandwidth : Το Bandwidth του Κυκλώματος array : subnets : Υποδίκτυα Μονάδας integer : id : Ο Κωδικός ID του Υποδίκτυου string : type : Ο Τύπος του Υποδίκτυου string : network : Το Δίκτυο του Υποδίκτυου array : connections : Συνδέσεις Μονάδας integer : id : Ο Κωδικός ID της Σύνδεσης string : name : Το Όνομα της Σύνδεσης array : subnets : Υποδίκτυα Μονάδας array : circuits : Κυκλώματα Μονάδας array : devices : Δικτυακές Συσκευές Μονάδας array : ldapEntries : Ldap Λογαριασμοί Μονάδας string : controller : Ο controller που χρησιμοποιείται string : function : Η συνάρτηση που υλοποιείται από το σύστημα string : method : Η μέθοδος κλήσης της συνάρτησης integer : status : Ο Κωδικός του αποτελέσματος της κλήσης string : message : Το Μήνυμα του αποτελέσματος της κλήσης

Thrown exceptions summary
`MissingUnitMMIDParam`	`ExceptionMessages::MissingUnitMMIDParam` `ExceptionCodes::MissingUnitMMIDParam`
`MissingUnitMMIDValue`	`ExceptionMessages::MissingUnitMMIDValue` `ExceptionCodes::MissingUnitMMIDValue`
`InvalidUnitMMIDArray`	`ExceptionMessages::InvalidUnitMMIDArray` `ExceptionCodes::InvalidUnitMMIDArray`
`InvalidUnitMMIDType`	`ExceptionMessages::InvalidUnitMMIDType` `ExceptionCodes::InvalidUnitMMIDType`
`NoErrors`	`ExceptionMessages::NoErrors` `ExceptionCodes::NoErrors`

Packages

Functions

Function GetCrmData