 | Cloud Fax and Notifications API 2.5 Documentation JobDeliveryStatus | Cloud Fax and Notifications API Forums Home |
24.2 JobDeliveryStatusRequest | JobDeliveryStatus Overview JobDeliveryStatusResult |
| Tag Name & type | # | Description | |||||
|---|---|---|---|---|---|---|---|
| JobDeliveryStatusRequest | Namespace of this element is http://ws.easylink.com/JobDeliveryStatus/2011/01 | ||||||
| SubmitId xs:string | 0-1 | Optional string identifying request, which will be echoed in result. | |||||
| StatusOptions StatusOptionsType | 0-1 | This contains options that can affect the selection and handling of the returned data. | |||||
| AllDeliveryGroups xs:boolean | 0-1 | If true, then information about report and notification deliveries will be included as well as information about primary deliveries. If AllDeliveryGroups is false (or not present), then only primary deliveries will be included. | |||||
| UseBase64 xs:boolean | 0-1 | Optional boolean value. Defines the way data will be returned. For more details se Character Sets. | |||||
| UseBinary xs:boolean | 0-1 | Optional boolean value. Defines the way data will be returned. For more details see Character Sets. | |||||
| IncludeExtendedJobData ExtDataFilterType | 0-1 | If present, this requests extended data at the job level. This is sometimes referred to as "UDDRS" data. | |||||
| ExtSegmentFilter | 0- | Contains the requested fields from a particular segment. | |||||
| @name xs:string | 0-1 | Name of the segment | |||||
| ExtPropFilter | 0- | Identifies a requested field. Must have either the name or idnum attribute | |||||
| @name xs:string | 0-1 | Name of the requested field. | |||||
| @idnum xs:string | 0-1 | Identifying number of the request field. | |||||
| IncludeExtendedDeliveryData ExtDataFilterType | 0-1 | If present, this requests extended data at the destination level. This is sometimes referred to as "UDDRS" data. | |||||
| ExtSegmentFilter | 0- | Contains the requested fields from a particular segment. | |||||
| @name xs:string | 0-1 | Name of the segment | |||||
| ExtPropFilter | 0- | Identifies a requested field. Must have either the name or idnum attribute | |||||
| @name xs:string | 0-1 | Name of the requested field. | |||||
| @idnum xs:string | 0-1 | Identifying number of the request field. | |||||
| JournalWindow JobDateTimeWindowType | 0-1 | Optional window to limit returned data to include only events that occured in the specified timeframe. This is useful for reporting arrival, removal or pull events, which may be monitored over a long period. | |||||
| Minutes xs:integer | 1 | This choice specifies the number of minutes in a time window ending "now". Default is 1440 (24 hours). | |||||
| Interval DateTimeSpanType | 1 | This choice defines a start and end date and time for the desired time window. | |||||
| StartDateTime xs:dateTime | 1 | Required. See xs:dateTime. | |||||
| EndDateTime xs:dateTime | 0-1 | If omitted, window ends "now" See xs:dateTime. | |||||
| NumToRetrieve xs:unsignedInt | 0-1 | Limits the number of destinations in response. | |||||
| JobId JobIdType | 1- | Delivery information will be retrieved (if possible) for each JobId listed. See JobIdType. | |||||
| © 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 |