purgeRequest

Purges (permanently deletes) the selected item from the container.

Request

<purgeRequest>
   <items type="types:ItemRefList">
   <recurrenceAllInstances type="unsignedInt"/>
</purgeRequest>

Response

<purgeResponse>
   <status type="types:Status"/>
</purgeResponse>

Elements

items

Specifies the items to be purged from the user's account.

code

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

status

Returns the success or failure of the method.

recurrenceAllInstances

Specifies that you want the purge to be applied to all recurring items if you pass the recurrenceKey.

Example

<purgeRequest> 
   <items> 
      <item>450FE01C.domain1.po1.100.16E3837.1.102A.1@1:7.
             domain1.po1.100.0.1.0.1@16<item> 
   </items> 
</purgeRequest>

<purgeResponse> 
   <status> 
      <code>0</code> 
   </status> 
</purgeResponse>