OPTIONS Exchange Mailboxes list

Latest revision as of 23:59, 1 July 2014

Retrieves additional parameters for sorting and filtering of Mailboxes

OPTIONS {server_name}/accounts/{account_number}/exchange/{domain_name}/mailboxes/

Parameters

account_number - string

The account number that the Exchange resource belongs to

domain_name - string

The domain name that is associated with the Exchange resource

Response Body

{
  "sortFields" : [ "username" ],
  "sortOrders" : [ "asc", "desc" ],
  "filterFields" : [ {
    "field" : "username",
    "values" : [ ]
  }, {
    "field" : "billingStatus",
    "values" : [ "new", "placed", "pending", "open", "suspended", "close_pending", "closed", "purge_pending" ]
  } ]
}
 

sortFields - list

List of the fields that are sortable

sortOrders - list

List of available orders for sorting

filterFields - list

List of specifications of fields that are filterable. Each element has the following parameters:

field - string

name of the field that is filterable. To filter a specified field add a parameter to the get request starting with filter and capitalising the field i.e. to filter name a filterName parameter should be passed to the get request.

values - list

List of allowed filterable values. If the list is empty no restrictions apply

Response Headers

Allow

A comma-separated list of request methods supported on this URI.

Expected Response Codes

200

Success

404

Non-existent resource