StartReceiving

<< Fare clic per visualizzazione il sommario >>

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

StartReceiving

Avvia il tracciamento, tramite una risorsa Dati, di un processo di business di ricezione di un'informazione da un corrispondente a Jamio openwork.

 

Metodo

JamioSending/StartReceiving

 

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 traccia il processo di ricezione.

Reference

 

correspondent

Riferimento del Corrispondente da cui si riceve l'informazione. In assenza di una Risorsa Jamio openwork che individua il Corrispondente, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Reference

 

address

Riferimento dell'Indirizzo da cui si riceve l'informazione. 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 da cui si riceve l'informazione. In assenza di una risorsa Jamio che individua il Carrier, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

Reference

 

transport

Tipo di trasporto con cui viene effettuata la spedizione.

Transport

 

sendId

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

String

Y

 

Commenti

Il metodo è utile ad avviare il tracciamento, tramite una risorsa Dati, di un processo di business di ricezione di un'informazione da un corrispondente a Jamio openwork. Il metodo prevede in input:

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

il riferimento del mittente da cui si riceve l'informazione;

l'indirizzo del mittente da cui si riceve l'informazione;

il tipo di trasporto con cui viene effettuata la spedizione;

il vettore della spedizione;

un eventuale identificativo della spedizione.

Il metodo imposta sulla risorsa che traccia il processo di ricezione:

lo stato della spedizione (proprietà SendingStatus) da none a pending, ad indicare che la ricezione è stata avviata ed è in attesa di essere gestita;

la percentuale di completamento della spedizione (proprietà SendingProgress) pari a zero;

la direzione della spedizione (proprietà SendingDirection) pari a 1, ovvero spedizione in entrata.

Il metodo crea in automatico il CorrespondentInfo del riferimento specificato come corrispondente. Alla risorsa Dati che traccia il processo di ricezione, viene associato il corrispondente e per esso viene impostato lo stato (SendingStatus) a pending. Inoltre il metodo aggiunge, per il corrispondente, un percorso di spedizione (SendingPath). Il TargetSendingStatus del percorso di spedizione (SendingPath) viene impostato a Delivered; quindi la ricezione si completerà quando verrà aggiunto, al percorso di spedizione, un TrackingMessage con stato pari a DeliveredToRecipient.

 

L'esecuzione del metodo avvia una spedizione pertanto genera un evento su spedizione con proprietà Action uguale a StartReceive.

 

Autorizzazioni

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

 

Stato della risorsa

Il metodo può essere eseguito se la proprietà SendingStatus della risorsa Dati che traccia il processo di ricezione è uguale a None, diversamente il metodo restituisce un errore.