Analysis of the different status in a JobDeliveryStatus request

avandenabeele

 

Hello,

I'm trying to get a JobDeliveryStatus and to analysze the result.

The purpose of my analysis is to define what states are final (ie what states do not move). This is to follow the progress of delivery of faxes (several jobs will be checked).

Could you please confirm my analysis on the different status of the response:

<JobDeliveryStatusResult> <Status>

In the case where this "overall" status is in check (value = 1), then all jobs are in check.

<JobDeliveryStatusResult> <JobDeliveryStatus> <JobData> <JobState>

In the case where one of the states JobState is to "Error" or "Cancelled", the job is considered failed (the faxes were not received).

In the case where the states "Posted" and "Completed" are present, the job is completed. However, it is necessary to check the delivery status for each destinatation ( <DeliveryDetail> <State> )

In other cases, a check on each destination is to do in order to monitor progress. 

<JobDeliveryStatusResult> <JobDeliveryStatus> <JobData> <DeliveryGroup> <DeliveryDetail>   <State>

Sending is OK when the status is "Sent".

Sending is failing when the status is "Error", "Cancelled" or "Expired".

For other states, the status will be considered "in progress".

Thanks for you reply.

 

skamens

You are essentially correct.  See below for some expansions/clarifications:

• The overall result (<JobDeliveryStatusResult> <Status>) does indicate the success or failure of our entire request.  A fully successful result will have <StatusCode>0</StatusCode>.  A non-zero value means that something didn't work right, but it doesn't necessarily mean total failure.  For instance, if you asked for status on two jobs and one couldn't be retrieved, that would give you a non-zero StatusCode.
  
  The overall result status tells you absolutely nothing about what happened to the job (or jobs) you asked for status on.
• The <JobState> may show "Error" or "Cancelled" even if some of the deliveries have completed (either wholly or partially).  I suggest focusing on the Item level information if it is available.  It is true that a JobState of Posted or Completed indicates that all delivery activity is done, and you should be able to get final results from the item level status. 
• Your understanding of the item level state is correct - "Sent"
   means successful delivery, while the other statuses indicate either an error or a pending item.