Tag Name & type | # | Description |
|---|
| ItemLevelCancelSearchResult | | Namespace of this element is http://ws.easylink.com/ItemLevelCancelSearch/2011/01 |
| | Status StatusType | 1 | Status of processing. See StatusType. |
| | SubmitId xs:string | 0-1 | Echoes the SubmitId in the request, if one was provided, and if possible. |
| | ItemLevelData | 0- | The data for each matching destination (if any) will be returned in an ItemLevelData element. |
| | UserId xs:string | 0-1 | The UserId of the owner of the job containing the delivery. |
| | JobId JobIdType | 1 | The job containing the delivery. This information should be used in an ItemSpec element for a subsequent refresh call to ItemlevelCancelSearch. See JobIdType. |
| | BillingSubJobNo xs:int | 1 | The billing subjob within the job that contains the delivery. This information should be used in an ItemSpec element for a subsequent refresh call to ItemlevelCancelSearch. |
| | XQN xs:int | 1 | The XQN value that, along with the job id and billing subjob, uniquely identifies the delivery. This information should be used in an ItemSpec element for a subsequent refresh call to ItemlevelCancelSearch. |
| | JobEntryTime xs:dateTime | 0-1 | Time the job entered the system. |
| | BillingCode EncodableStringType | 0-1 | The user-supplied billing code (if any) from the job containing the delivery. See EncodableStringType. |
| | CustomerReference EncodableStringType | 0-1 | The user-supplied customer reference (if any) from the job containing the delivery. See EncodableStringType. |
| | ResendOriginalJob JobIdType | 0-1 | If the job containing the delivery was a resend of an earlier job, this is the id of that prior job. See JobIdType. |
| | ItemReference EncodableStringType | 0-1 | The "ref" value associated with the delivery. See EncodableStringType. |
| | DestinationAddress DestinationType | 0-1 | The destination address of the delivery. See EncodableStringType. |
| | DestinationAddressNormalized DestinationType | 0-1 | The normalized form of the destination address used by the switch. See EncodableStringType. |
| | CancDisposition xs:string | 0-1 | If an item-level cancellation has been requested, this value (which should be treated as case-insensitive) will reflect the processing. The value may be:
- submitted
- pending
- processsing
- processed
- failed
- done
|
| | AttemptData | 0- | If delivery attempt information is available, it will be included here. |
| | Direction xs:string | 0-1 | Indicates direction of delivery - inbound ('I') or outbound ('O') |
| | Attempt xs:short | 0-1 | Attempt number. |
| | DeliveryTime xs:dateTime | 0-1 | Time of the attempt. |
| | State StateType | 0-1 | Indicates the current state of this delivery attempt. The value will be one of
- Pending
- Submitted
- InProcess
- Error
- Cancelled
- Held
- Sent
- Expired
|
| | @code StateCodeType | 1 | The value will be a number corresponding to the state.
| 1 | Pending |
| 2 | Submitted |
| 3 | InProcess |
| 4 | Error |
| 5 | Cancelled |
| 6 | Held |
| 7 | Sent |
| 8 | Expired |
|
| | @gammacode xs:int | 0-1 | A code that may provide more detailed status information, mainly applicable to the Error state. EasyLink can provide a table of these error codes and their meaning. Only non-zero values are returned. |
| | JobList | 0-1 | Jobs not completely set up at the time of the request will be listed here. |
| | JobId JobIdType | 1- | See JobIdType. |