Cloud Fax and Notifications API 2.6 Documentation
ItemLevelCancelSearch
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  ItemLevelCancelSearch  

21.3 ItemLevelCancelSearchResult

ItemLevelCancelSearch Overview   ItemLevelCancelSearchRequest

Tag Name
& type
#Description
ItemLevelCancelSearchResult   Namespace of this element is http://ws.easylink.com/ItemLevelCancelSearch/2011/01
   Status
StatusType
1Status of processing. See StatusType.
   SubmitId
xs:string
0-1Echoes the SubmitId in the request, if one was provided, and if possible.
   ItemLevelData0-The data for each matching destination (if any) will be returned in an ItemLevelData element.
   UserId
xs:string
0-1The UserId of the owner of the job containing the delivery.
   JobId
JobIdType
1The 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
1The 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
1The 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-1Time the job entered the system.
   BillingCode
EncodableStringType
0-1The user-supplied billing code (if any) from the job containing the delivery. See EncodableStringType.
   CustomerReference
EncodableStringType
0-1The user-supplied customer reference (if any) from the job containing the delivery. See EncodableStringType.
   ResendOriginalJob
JobIdType
0-1If 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-1The "ref" value associated with the delivery. See EncodableStringType.
   DestinationAddress
DestinationType
0-1The destination address of the delivery. See EncodableStringType.
   DestinationAddressNormalized
DestinationType
0-1The normalized form of the destination address used by the switch. See EncodableStringType.
   CancDisposition
xs:string
0-1If 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
   AttemptData0-If delivery attempt information is available, it will be included here.
   Direction
xs:string
0-1Indicates direction of delivery - inbound ('I') or outbound ('O')
   Attempt
xs:short
0-1Attempt number.
   DeliveryTime
xs:dateTime
0-1Time of the attempt.
   State
StateType
0-1Indicates the current state of this delivery attempt. The value will be one of
  • Pending
  • Submitted
  • InProcess
  • Error
  • Cancelled
  • Held
  • Sent
  • Expired
   @code
StateCodeType
1The value will be a number corresponding to the state.
1Pending
2Submitted
3InProcess
4Error
5Cancelled
6Held
7Sent
8Expired
   @gammacode
xs:int
0-1A 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.
   JobList0-1Jobs not completely set up at the time of the request will be listed here.
   JobId
JobIdType
1-See JobIdType.
 
    prev  next        Table of Contents  ItemLevelCancelSearch  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020