Webservice‎ > ‎Category API‎ > ‎

Tree

La chiamata Tree ha la seguente firma:

CategoryTreeResponse Tree(CategoryTreeRequest request);

Cosa permette di fare

La chiamata Tree permette di ottenere l'intera gerarchia delle categorie al di sotto di una categoria padre. In altre parole è possibile ottenere il dettaglio di tutte le categorie figlie (e di tutte le figlie delle figlie, e di tutte le figlie delle figlie delle figlie e così via) di una determinata categoria di cui si conosce l'ID. Utilizzando come ID padre 1, si può ottenere la completa gerarchia delle categorie impostate su eDock.

Limitazioni

  • E' possibile richiedere il Tree di una sola categoria padre alla volta.

Richiesta

In rosso sono evidenziate le proprietà obbligatorie.

 Proprietà Tipo Descrizione
 idParent Int ID della categoria di cui si vuole recuperare la gerarchia

Risposta

 Proprietà Tipo Descrizione
 Categories Category[] Contenitore delle categorie figlie
 Categories.Category Category Contenitore di una categoria figlia
 Categories.Category.CategoryName String Nome della cateogira
 Categories.Category.idCategory Int ID della categoria
 Categories.Category.idParent Int
 ID della categoria padre
 ErrorCode String
 Codice errore
 ErrorMessage String Messaggio d'errore
 Status Status Enumerativo che rappresenta lo stato di esecuzione della chiamata. Valori ammessi:
  • Success: la chiamata è stata eseguita senza errori.
  • Warning: la chiamata è stata eseguita per alcuni prodotti, ma non per tutti.
  • Error: la chiamata non è stata eseguita per nessun prodotto.

Errori possibili

 ErrorCode 
 Significato
 AUTH0001 Impossibile autenticare l'utente. Il nome utente o i token non sono validi o non sono corretti.
 TREE0001 L'ID categoria padre non è valido. E' stato passato un valore minore di 1.
 TREE0002 L'ID categoria padre non è valido. Non esiste una categoria con tale ID.