AddTrackingMessageByAddress

<< Fare clic per visualizzazione il sommario >>

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

AddTrackingMessageByAddress

Aggiunge un messaggio di tracciamento (TrackingMessage) ad un percorso di spedizione. Il percorso di spedizione a cui aggiungere il tracking message viene riconosciuto mediante il riferimento della risorsa Dati che traccia la spedizione, il name dell'Indirizzo ed il name del Carrier.

 

Metodo

JamioSending/AddTrackingMessageByAddress

 

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 Dati che monitora la spedizione.

Reference

 

name

Oggetto del messaggio di tracciamento.

String

 

description

Descrizione dettagliata del messaggio di tracciamento.

String

Y

address

Riferimento dell'Indirizzo della spedizione. In assenza di una Risorsa Jamio openwork che individua l'Indirizzo, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Reference

 

carrier

Riferimento del vettore per la spedizione. In assenza di una Risorsa Jamio openwork che individua il Carrier, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Reference

 

date

Data del messaggio di tracciamento.

DateTime

 

sendId

Identificativo della spedizione, relativo a questo percorso, eventualmente fornito dal vettore.

String

Y

status

Stato del messaggio di tracciamento.

TrackingStatus

 

references

Lista di riferimenti a file allegati o ad altre risorse.

List of reference

Y

overwrite

Se true, sovrascrive un eventuale messaggio precedente con lo stesso stato (status) e relativo allo stesso percorso, altrimenti ne aggiunge uno nuovo.

Boolean

Y

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Riferimento al messaggio di tracciamento creato.

Reference

 

 

 

Commenti

Il metodo AddTrackingMessageByAddress crea o sovrascrive un tracking message su un percorso di spedizione (SendingPath) associato ad un corrispondente di una spedizione. Il metodo prevede in input:

il riferimento della risorsa Dati che traccia il processo di spedizione;

i parametri utili ad identificare il percorso di spedizione a cui aggiungere il messaggio di tracciamento ovvero riferimento alla risorsa che traccia la spedizione, indirizzo della spedizione e vettore per la spedizione;

le proprietà utili a valorizzare il messaggio di tracciamento;

un opzione utile a specificare se sovrascrivere un precedente messaggio di tracciamento con uguali sendId e status (incrementando il Recurrence) o accodarne uno nuovo. In caso di sovrascrittura tutti gli eventuali allegati al tracking message sovrascritto vengono eliminati.

 

Il metodo restituisce il collegamento al messaggio di tracciamento (TrackingMessage) creato. L'esecuzione del metodo genera un evento di tracciamento per un percorso di spedizione.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di modifica sulla risorsa Dati che traccia la spedizione.

 

Stato della risorsa

Il metodo può essere eseguito se la proprietà SendingStatus della risorsa Dati che traccia la spedizione è diversa da None, diversamente il metodo restituisce un errore.