OPTIONS Exchange Mailing List Members
From Hostway API Documentation
Revision as of 23:59, 1 July 2014 by Mike.robski (Talk | contribs)
Retrieves additional parameters for sorting and filtering of Mailing List Members
OPTIONS {server_name}/accounts/{account_number}/exchange/{domain_name}/malingLitsts/{username}/members
Contents |
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
- username - string
- The username that is associated with the Mailing List resource
Response Body
{
"sortFields" : [ "name", "username", "type" ],
"sortOrders" : [ "asc", "desc" ],
"filterFields" : [ {
"field" : "name",
"values" : [ ]
}, {
"field" : "username",
"values" : [ ]
}, {
"field" : "type",
"values" : [ "mailbox", "globalContact" ]
} ]
}
- 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
Access-Control-Allow-Methods GET,POST,OPTIONS Access-Control-Allow-Headers Authorization,Content-Type,Accept,If-Modified-Since
- Access-Control-Allow-Methods
- A comma-separated list of request methods supported on this URI.
- Access-Control-Allow-Headers
- A comma-separated list of request header parameters supported on this URI.
Expected Response Codes
- 200
- Success
- 404
- Non-existent resource
See also
