AddSendingPath

<< Fare clic per visualizzazione il sommario >>

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

AddSendingPath

Aggiunge un percorso di spedizione (SendingPath) ad uno specifico corrispondente per cui è stata avviata una spedizione.

 

Metodo

JamioSending/AddSendingPath

 

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

Reference

 

correspondent

Riferimento del Corrispondente della spedizione a cui si vuole aggiungere un percorso di spedizione (SendingPath). In assenza di una Risorsa Jamio openwork che individua il Corrispondente, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Il parametro è opzionale se viene specificato il valore del parametro oldAddress, altrimenti è obbligatorio.

Reference

Y

address

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

Reference

 

oldAddress

Riferimento dell'Indirizzo di un percorso di spedizione precedentemente inserito, utilizzato per identificare il corrispondente a cui aggiungere il percorso di spedizione che si vuole creare. In assenza di una Risorsa Jamio openwork che individua l'Indirizzo, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Il parametro è opzionale se viene specificato il valore del parametro correspondent, altrimenti è obbligatorio.

Reference

Y

transport

Tipo di trasporto.

Transport

 

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

 

sendId

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

String

Y

leadTime

Tempo massimo per il completamento del percorso di spedizione, trascorso il quale, in caso di mancato completamento, viene generato un evento di timeout percorso spedizione.

TimeSpan

Y

targetSendingStatus

Stato per cui il percorso di spedizione (SendingPath) può ritenersi completato; deve essere uno stato uguale o superiore a Sent.

SendingStatus

 

 

Commenti

Il metodo AddSendingPath aggiunge un percorso di spedizione (SendingPath) ad uno specifico corrispondente. Il metodo prevede in input:

il riferimento della risorsa Dati che monitora la spedizione;

i parametri utili a costruire il percorso di spedizione da aggiungere;

un eventuale indirizzo utilizzato in un percorso di spedizione precedentemente associato allo stesso corrispondente (utile per rintracciare il corrispondente).

Il metodo crea un percorsi di spedizione con proprietà SendingStatus uguale a pending e Completed uguale a false. Il metodo identifica il corrispondente a cui aggiungere il percorso di spedizione rispetto a quanto specificato nel parametro correspondent o in alternativa a quanto specificato nel parametro oldAddress. Se non è possibile identificare univocamente un corrispondente tra quelli associati alla risorsa da spedire il metodo genera un errore. Il metodo comporta il ricalcolo del SendingStatus per i corrispondenti coinvolti e per la risorsa dati da spedire.

L'esecuzione del metodo genera un evento su percorso spedizione che notifica l’aggiornamento dello stato di spedizione di una risorsa.

 

Autorizzazioni

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

 

Stato della risorsa

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