Descrizione
Questo metodo può essere utilizzato per ottenere la lista delle sessioni attive all'interno del sistema.
Utilizzo
I parametri richiesti da questa funzione sono:
- sessionHash: Id della sessione di cui si vogliono ottenere le informazioni, false se non necessario, se impostato annulla gli altri filtri.
- sessionType: Tipo di sessione di cui si vogliono ottenere le informazioni, false se non necessario.
- editorType: Tipo di editor di cui si vogliono ottenere le sessioni, false se non necessario.
- customerId: Id del cliente di cui si vogliono ottenere le sessioni, false se non necessario.
In caso di successo ritorna un'array di oggetti così strutturati:
- sessionHash: Id della sessione.
- sessionType: Tipologia della sessione.
- editorType: Tipologia di editor associato alla sessione.
- productId: Id del prodotto associato alla sessione.
- projectId: Id del progetto associato alla sessione.
- customerId: Id del cliente associato alla sessione.
- shoppingCartUrl: Url del carrello esterno.
- shoppingCartExtraParams: Array di oggetti che rappresentano i parametri extra che verranno inviati al carrello esterno così composti:
- paramName: Nome del parametro extra.
- paramValue: Valore del parametro extra.
- languageCode: Codice della lingua preimpostata nella sessione.
- dateCreated: Stringa contenente la data in cui è stato creato il template nel formato YYYY-MM-DD HH:MM:SS.
- dateUpdated: Stringa contenente la data in cui è stato modificato il template nel formato YYYY-MM-DD HH:MM:SS.
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.
ATTENZIONE
Possibili tipologie di sessione
Il campo sessionType può avere i seguenti valori:
- 0: Sessione per designer.
- 1: Sessione per cliente.
In .NET è possibile utilizzare la struttura statica editorSessionType presente in Structures.
ATTENZIONE
Possibili tipologie di palette colori
Il campo editorType può avere i seguenti valori:
- 1: PhotoEditor.
- 2: SmartEditor.
In .NET è possibile utilizzare la struttura statica editorType presente in Structures.
PHP
require "vendor/autoload.php"
try {
$ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it');
$apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
$editorSessions = $ezPrintSDK->editor->eGetActiveEditorSessions(false, false, 2, false);
foreach($editorSessions as $session) {
echo $session['sessionHash'], ' ', $session['languageCode'];
}
} 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 editorSessions = ezPrintSDK.editor.eGetActiveEditorSessions(false, false, 2, false);
editorSessions.forEach(function(session) {
console.log(session.sessionHash);
console.log(session.languageCode);
});
} 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.sessionEditorItem> editorSessions = ezPrintSDK.Editor.eGetActiveEditorSessions(false, false, ezPrintSDKWrapper.Structures.editorType.smartEditor, 200);
System.Console.WriteLine("Smart Template {0}: {1}", smartTemplates[0].templateCode, smartTemplates[0].templateName);
} catch (ezPrintException ex) {
string ErrorMessage = ex.Message;
}