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

23.2 JobCancelRequest

JobCancel Overview   JobCancelResult

Tag Name
& type
#Description
JobCancelRequest   Namespace of this element is http://ws.easylink.com/JobCancel/2011/01
   SubmitId
xs:string
0-1Optional string identifying request, which will be echoed in result.
   CancelItem
JobCancelItemType
1-Each CancelItem specifies one job (or delivery item) to be canceled, and there may be more than one CancelItem within the JobCancelRequest.
   JobId
JobIdType
1Specifies the job to be canceled. See JobIdType.
   BillingSubjobNumber
xs:integer
0-1If a particular delivery item within the job is to be canceled, rather than the entire job, the BillingSubjobNumber of the group of deliveries containing the item must be provided, along with the XQN. This corresponds to the DeliveryGroupId in a JobDeliveryStatus result, and the Group@num value in a JobDetail result.
   XQN
xs:integer
0-1If a particular delivery item within the job is to be canceled, rather than the entire job, the XQN of the item must be provided, along with the BillingSubjobNumber. This corresponds to the DeliveryDetail@xqn value in a JobDeliveryStatus result, and the XQN element in a JobDetail result.
   CancelType
JobCancelType
0-1Specifies what aspect of the job is to be canceled. This element must have one of the following values:
ValueDescription
AllCancel all deliveries and reports.
This is the action taken when CancelType is not specified
DeliveriesCancel primary deliveries only.
ReportsCancel delivery reports only.
AcceptanceReportCancel acceptance report.
CancellationNoticeCancel cancellation notice
PullsCancel pull reports
FriendDeliveriesCancel friend deliveries.
This element should not be used for item-level (XQN) cancellations.
   NotificationAddress
DestinationType
0-1If a cancel notification is requested (by including either NotificationType or NotificationText, described below), then it will be sent to the address specified by this item. See DestinationType.
Notifications are not available for item-level (XQN) cancellations.
   NotificationType
xs:string
1The value of this element is the name of a pre-defined notification template to be used for the cancellation notification.
Notifications are not available for item-level (XQN) cancellations.
NotificationText
DocDataType
1This contains an actual document to be sent as the cancellation notification, in DocData format. See DocumentType.
Notifications are not available for item-level (XQN) cancellations.
 
    prev  next        Table of Contents  JobCancel  
© 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