getArchiveItemsRequest

Returns items from the specified archive database.

Request

  <container type="types:uid" />
  <view type="types:View"/>
  <filter type="types:Filter" />
  <items type="types:ItemRefList" />
  <count type="int" />
  <path type="string" />
</getArchiveItemsRequest>

Response

<getArchiveItemsResponse>
  <items type="types:Items />
  <status type="types:Status" />
</getArchiveItemsResponse>

Elements

container

(optional) Specifies the folder, address book, or library container ID. If the container is not specified, the filter is used. If the filter is not present, an error is returned.

view

Specifies the elements returned for each item. The view reduces the amount of data returned. If a view is not specified, all item elements are returned.

filter

Specifies the items to return based on a filter.

items

On input, specifies a list of item ids to return.

On return, returns the specified items.

count

Specifies the number of items to return. If the count element is -1, all items are returned.

path

Specifies the path to the archive directory. If not specified, the POA oftemp directory is used.

code

Specifies the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Example

See archiveRequest.