Webservice

Le API di eDock sfruttano il paradigma richiesta / risposta. L'applicazione client (o, in altre parole, quella che vuole interrogare i servizi di eDock) effettua delle richieste e attende delle risposte. Ogni singola chiamata di ogni set di API accetta, quindi, come input un oggetto di tipo Request e ritorna in output un oggetto di tipo Response. Ovviamente ogni singola chiamata ha parametri di input e di output specializzati. Ad esempio la chiamata per la creazione di un prodotto (Create) che appartiene al set Product API, accetta in ingresso un oggetto di tipo ProductCreateRequest e ritorna un oggetto di tipo ProductCreateResponse. È tuttavia da notare che tutte le classi di richiesta derivano da una classe base chiamata BaseRequest, mentre tutte le classi di risposta derivano da una classe base chiamata BaseResponse.Ogni richiesta è formata da un piccolissimo insieme di campi (analizzati nel paragrafo seguente BaseRequest) che contiene, tra gli altri, un certo ApiToken. Tale campo è, sostanzialmente, la password utilizzata per effettuare le operazioni. Il token è un valore che viene comunicato da DBN Communication srl al cliente a seguito della sottoscrizione del contratto ad eDock e permette l'utilizzo delle API da parte di software terzo senza dover necessariamente utilizzare la propria password personale di accesso ad eDock.
Teniamo a precisare che non esiste un legame diretto tra token e password di eDock.

Richiesta di base

Ogni richiesta, per qualunque chiamata sia, è formata dalle seguenti informazioni.

 Nome campo Tipo Occorrenza Descrizione
 eDockUsername string Obbligatorio Rappresenta il nome utente attraverso cui effettuare le richieste.
 ApiToken string Obbligatorio Rappresenta la password utilizzabile esclusivamente per l'invocazione delle API di eDock.
 Culture string Facoltativo Cultura della richiesta. In tale modo le risposte effettuate da eDock saranno localizzate. Attualmente sono supportate le culture italiana (it-IT) e statunitense (en-US).
 Type RequestTypeEnum Facoltativo Enumerativo attualmente a solo uso interno

Risposta di base

Ogni risposta, da qulunque chiamata provenga, è formata dalle seguenti informazioni:
 Nome campo Tipo Occorrenza Descrizione
 Status ResponseStatusEnum Obbligatorio Rappresenta l'esito della richiesta.
 ErrorMessage string Facoltativo Contiene, se esiste, il messaggio d'errore (nella cultura selezionata dalla richiesta) verificatosi su eDock
 ErrorCode string Facoltativo Contiene, se esiste, il codice d'errore verificatosi su eDock