 | Cloud Fax and Notifications API 2.4 Documentation ListRetrieve | Cloud Fax and Notifications API Forums Home |
38.3 ListRetrieveResult | ListRetrieve Overview ListRetrieveRequest |
| Tag Name & type | # | Description | ||||
|---|---|---|---|---|---|---|
| ListRetrieveResult | Namespace of this element is http://premconn.premiereconnect.com/ListRetrieve/2008/10 | |||||
| Status StatusType | 1 | Status of processing. See StatusType. | ||||
| SubmitId xs:string | 0-1 | Echoes SubmitId from the request, if present and if possible. | ||||
| ListId ListIdType | 0-1 | This is the id of the retrieved list, and may not be present if the operation failed. See ListIdType. | ||||
| ListContents | 0-1 | This element contains the all of the destinations in the stored list, and may not be present if the operation fails. For ListRetrieve, each destination will be represented as a DeliveryItemGeneric element. | ||||
| DeliveryItemGeneric DeliveryItemGenericType | 0- | Each destination in the list will be returned as a DeliveryItemGeneric element. See DeliveryItemGeneric below for more details. | ||||
| History | 0-1 | This contains some meta-data that may be associated with the stored list. The ListRetrieve operation does not necessarily provide all such information, and not all agents (including the Cloud Fax and Notifications API) that operate on lists contribute to this data. Furthermore, some operations may obscure previous activity, as when a list is deleted and then recreated This means that not all actions taken on the list may be indicated here. | ||||
| Created xs:dateTime | 0-1 | Time list was created. | ||||
| Template xs:string | 0-1 | Certain agents use a "template" to govern the list contents | ||||
| Sort xs:string | 0-1 | Sort order requested for list - not necessarily the order of data in ListContents | ||||
| CopiedFrom xs:string | 0-1 | Certain agents may record a source list if this list was created by copying | ||||
| CreatedFrom xs:string | 0-1 | Certain agents may record a base source list | ||||
| Action HistoryType | 0- | |||||
| Action xs:string | 1 | Describes the type of action performed on the list | ||||
| Operator xs:string | 1 | The operator performing the action | ||||
| Agent xs:string | 1 | The mechanism that performed the action | ||||
| Time xs:dateTime | 1 | The time of the action | ||||
| ItemCount ItemCountType | 1 | The number of list items affected by the action. The value will be an integer. | ||||
| @type HistoryActionType | 0-1 | Indicates the way the items were affected. Legal values are:
| ||||
| © 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 |