GET Exchange Mailing Lists list

Latest revision as of 23:59, 1 July 2014

Retrieve an Exchange Mailing Lists list by domain name

GET /accounts/account-number/exchange/domain-name/mailingLists

GET /accounts/account-number/exchange/domain-name/mailingLists?page=page-num&pageSize=page-size&sortField=sort-field&sortOrder=sort-order&filter-field=filter-value

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

page-num- int

(OPTIONAL)

Request a specific page of data. If not set defaults to 1

page-size - int

(OPTIONAL)

Size used to paginate the request. If not set defaults to 100

sort-field - string

(OPTIONAL)

Specifies a field upon which to sort the data. If not set no sorting is preformed. Allowed values are specified by an OPTIONS request

sort-order - string

(OPTIONAL)

Specifies the order in which the data is sorted. If not set no sorting is preformed if sort-field is not set or defaults to asc otherwise. Allowed values are specified by an OPTIONS request

filter-field - string

(OPTIONAL)

Specifies a field upon which the data is filtered. If multiple filter-field are set all of them have to be true to pass the filter. If none are set no filtering is performed. Allowed values are specified by an OPTIONS request. Example: if we want to filter by field 'status' then the paramenter should look like 'filterStatus=value'. That way one can filter by more then one field.

filter-value - string

(OPTIONAL)

A value with which the filter-field is filtered. Values are exact match or defined with Filter Values Wildcards.. Additional restrictions may be specified by an OPTIONS request

Response Body

{
  "list" : [ {
    "billingStatus" : "open",
    "name" : "test_list1",
    "details" : "http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingLists/test_list1"
  }, {
    "billingStatus" : "open",
    "name" : "test_list2",
    "details" : "http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingLists/test_list2"
  }],
  "links" : [ {
    "href" : "http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingLists/",
    "rel" : "self"
  } ]
}
  

list - list

List of the mailing lists for the selected domain. Each element of the list has the following attributes:

name - string

The name of the mailing list

billingStatus - string

Current status of the the mailing list. Allowed values are pending, open, suspended, close_pending, closed and purge_pending

details - string

Hyperlink to the mailing list

links - list

Hypermedia for this resource. Link to self will preserve filtering, sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable

Expected Response Codes

200

Success

400

Bad request

This is usually a sign that the client attempted to use filtering/sorting criteria that are invalid for this resource

404

Non-existent resource

Returned if no Exchange service could be found for the given domain name.

405

Unsupported method

500

Internal server error

502

Bad gateway

There was a failure in an upstream service that caused a failure in the API.