Authorization token required | true |
Admin Authorization token required | true |
<GetSessionsRequest type="..."
[sortBy="{sort-by} (nameAsc | nameDesc | createdAsc | createdDesc | accessedAsc | accessedDesc)"]
[offset="(Long)"] [limit="(Long)"] [refresh="(0|1)"] /> ## GetSessionsRequest
elements and attributes you can define within a
<GetSessionsRequest>
element:
XPath | Required / Optional | Description |
@type | Required (only 1) | Type: String Type - valid values soap|imap|admin |
@sortBy | Optional (0 or 1) | Type: nameAsc | nameDesc | createdAsc | createdDesc | accessedAsc | accessedDesc SortBy |
@offset | Optional (0 or 1) | Type: Long Offset - the starting offset (0, 25, etc) |
@limit | Optional (0 or 1) | Type: Long Limit - the number of sessions to return per page (0 is default and means all) |
@refresh | Optional (0 or 1) | Type: 0|1 Refresh. If 1 (true), ignore any cached results and start fresh. |
<GetSessionsResponse more="{more-flag} (0|1)" total="{total-num-accounts} (int)"> ## GetSessionsResponse
(<s zid="{account-id}" name="{account-name}" sid="{session-id}" cd="{creation-date} (long)"
ld="{last-accessed-date} (long)" /> ## SimpleSessionInfo)*
</GetSessionsResponse>
elements and attributes you can define within a
<GetSessionsResponse>
element:
XPath | Required / Optional | Description |
@more | Required (only 1) | Type: 0|1 1 (true) if more sessions left to return |
@total | Required (only 1) | Type: int Total number of accounts that matched search (not affected by limit/offset) |
/s | Optional (0 or more) | Session information |
/s@zid | Required (only 1) | Type: String Account ID |
/s@name | Required (only 1) | Type: String Account name |
/s@sid | Required (only 1) | Type: String Session ID |
/s@cd | Required (only 1) | Type: long Creation date |
/s@ld | Required (only 1) | Type: long Last accessed date |