GetTrackingMessagesCatalog

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Sending >

GetTrackingMessagesCatalog

Restituisce il catalogo dei messaggi di tracciamento (TrackingMessage) di tutti i percorsi di spedizione disponibili in una risorsa di tipo Dati, che traccia un processo di spedizione.

 

Metodo

JamioSending/GetTrackingMessagesCatalog

 

Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo del server per domini esterni (o "" per il dominio corrente).

String

Y

token

Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

resource

Riferimento della risorsa di tipo Dati.

Reference

 

parameters

Parametri di filtro e paginazione.

SearchParameters

Y

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Dato strutturato che riporta il catalogo dei messaggi di tracciamento.

Il dato strutturato contiene restituito dal metodo contiene i seguenti campi:

“Name” (String), nome del catalogo;

“TotalCount” (Int32), numero totale di righe di un catalogo;

"ItemList” (Lista di Extended Reference), lista di oggetti, uno per ogni riga del catalogo.

 

Download returnValue Dataset.

DataSet

 

 

Esempio

Se si devono ricercare tra i messaggi di tracciamento di alcune spedizioni, solo quelli di consegna (TrackingStatus=14) relativi alla spedizione di messaggi PEC (Transport=1), il parametro parameters può essere così caratterizzato, utilizzando le funzioni OEL SearchParameters e CatalogFilter:

 

SearchParameters(1,100,FilterAnd(CatalogFilter('Transport','EqualsTo',false,1),CatalogFilter('Status','EqualsTo',false,14)))

 

o equivalentemente

 

SearchParameters(1,100,FilterAnd(CatalogFilter('Transport','EqualsTo',false,Transport.PEC),CatalogFilter('Status','EqualsTo',false,TrackingStatus.DeliveredToRecipient)))

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di lettura sulla risorsa di cui si vuole ottenere il catalogo dei messaggi di tracciamento.