getTimestampRequest

Returns the date the user's database was last backedup and the last time retention software processed items in an account. Typically, backup or retention software time-stamps an account when it completes. This method can also be used as a noop method. If the noop element is True, no work is done in the POA to return data. This operation can be used to keep a connection alive.

Request

<getTimestampRequest>
   <backup type="boolean"/>
   <retention type="boolean"/>
   <noop type="boolean"/>
   <retentionModified type="boolean"/>
</getTimestampRequest>

Response

<getTimestampResponse>
   <backup type="dateTime"/>
   <retention type="dateTime"/>
   <status" type="types:Status"/>
   <retentionModified type="dateTime"/>
</getTimestampResponse>

Elements

backup

Specifies whether the last backup date on the user’s account is returned.

retention

Specifies whether the last retention date on the user’s account is returned.

noop

Specifies that getTimestampRequest is used to ping the server and keep the connection alive.

backup

Specifies the date the user's account was last backed up.

retention

Returns the time stamp that was marked by retention software.

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.

retentionModified

Specifies the date and time that a significant or meaningful part of the item was modified.

RetentionModified is a little different than the retention timestamp. Suppose an item has a retention timestamp. If a user modifies the item by adding a personal attachment or some other significant change, retention software will skip the item because it has already been retained. RetentionModified is now used to catch an item after the first retention and a significant change has occured to the item.

Example

<getTimestampRequest> 
   <backup>true</backup> 
   <retention>true</retention> 
   <noop>false</noop> 
   </getTimestampRequest>

<getTimestampResponse>
   <backup>2012-07-19T01:00:00Z</backup> 
   <retention>2012-08-20T03:00:00Z</retention> 
   <getTimestampResponse> 
   <status> 
      <code>0</code> 
   </status> 
</getTimestampResponse>