Descrizione
Questo metodo può essere utilizzato per ottenere la lista dei gruppi utente presenti all'interno del sistema.
Utilizzo
I parametri richiesti da questa funzione sono:
- customerGroupId: Id del gruppo utenti di cui si vogliono ottenere informazioni, se impostato a false verranno ritornati tutti i gruppo utenti presenti.
- languageId: Id della lingua in cui si volgliono ottenere il nome e la descrizione del gruppo utenti, per le lingue disponibile vedere il metodo getAvailableLanguages.
In caso di successo ritorna un'array di oggetti così strutturati:
- customerGroupId: Id del gruppo utenti.
- customerGroupName: Nome del gruppo utenti.
- customerGroupDescription: Descrizione del gruppo utenti.
- requireApproval: true se gli utenti di questo gruppo hanno necessità dell'approvazione dell'amministratore di sistema per essere attiva, false in caso contrario.
- companyIdVisible: true se il campo partiva iva è visibile, false se non lo è.
- companyIdRequired: true se il campo partita iva è obbligatorio, false se non lo è.
- taxIdVisible: true se il campo codice fiscale è visibile, false se non lo è.
- taxIdRequired: true se il campo codice fiscale è obbligatorio, false se non lo è.
- sortOrder: Numero che rappresenta l'indice di visualizzazione per questo elemento.
Gestione errori
In caso di errore il metodo genererà un'eccezione che riporterà uno dei seguenti codici di errore:
- ERROR_INVALID_PARAMS: Uno dei parametri inviati non è valido.
- ERROR_INVALID_TOKEN: Non è stato effettuato nessun login in precedenza o la sessione è scaduta per inutilizzo.
- ERROR_INVALID_IP: L'indirizzo ip del server che sta effettuando la chiamata non valido perchè non inserito nella whitelist associata alle credenziali.
- ERROR_SERVER_UNAVAILABLE: Il server non è disponibile o si è verificato un errore di comunicazione generico.
PHP
require "vendor/autoload.php" try { $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it'); $apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG'); $availableLanguages = $ezPrintSDK->backOffice->bGetAvailableLanguages(); $customerGroups = $ezPrintSDK->backOffice->bGetCustomerGroups(false, $availableLanguages[0]['languageId']); foreach($customerGroups as $group) { echo $group['customerGroupId'], ' ', $group['customerGroupName']; } } catch (Exception $e) { echo 'Error Code: ', $e->getMessage(); }
Node.js
try { var util = require('util'); var ezPrintSDK = require('ezprint-sdk-wrapper'); ezPrintSDK.initializeWrapper('http://demo.ezprint.it'); var apiToken = ezPrintSDK.cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG'); var availableLanguages = ezPrintSDK.backOffice.bGetAvailableLanguages(); var customerGroups = ezPrintSDK.backOffice.bGetCustomerGroups(false, availableLanguages[0].languageId); customerGroups.forEach(function(group) { console.log(group.customerGroupId); console.log(group.customerGroupName); }); } catch (ex) { console.log(ex); }
.NET (C#)
try { ezPrintSDKWrapper.Client ezPrintSDK = new ezPrintSDKWrapper.Client("http://demo.ezprint.it"); ezPrintSDK.cLoginAPI("1WHm0icsupAEm9fil9en","yCHZ0nKiyn1MU0DhpgmG"); List<ezPrintSDKWrapper.Structures.languageItem> availableLanguages = ezPrintSDK.BackOffice.bGetAvailableLanguages(); List<ezPrintSDKWrapper.Structures.customerGroupItem> customerGroups = ezPrintSDK.BackOffice.bGetCustomerGroups(false, availableLanguages[0].languageId); System.Console.WriteLine("FontPreset {0}: {1}", customerGroups[0].customerGroupId, customerGroups[0].customerGroupName); } catch (ezPrintException ex) { string ErrorMessage = ex.Message; }