GET Exchange Email Aliases list

Retrieve an Exchange Email Aliases list by domain name

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

GET /accounts/account-number/exchange/domain-name/emailaliases?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.The values can be also specified using wildcards(*).

filter-value - string

(OPTIONAL)

A value with which the filter-field is filtered. Values are either an exact match or partial match using a wildcard(*). Additional restrictions may be specified by an OPTIONS request

Response

Returns a dictionary with shorten information about email aliases of the Exchange product associated with the given domain name

Response Body

{
  "list" : [ {
    "emailAlias" : "email_alias_1@example.com",
    "details" : "http://{server-name}/accounts/{account-number}/exchange/{domain-name}/emailaliases/email_alias_1"
  }, {
    "emailAlias" : "email_alias_2@example.com",
    "details" : "http://{server-name}/accounts/{account-number}/exchange/{domain-name}/emailaliases/email_alias_2"
  }],
  "links" : [ {
    "href" : "http://{server-name}/accounts/{account-number}/exchange/{domain-name}/emailaliases/",
    "rel" : "self"
  } ]
}
  

list - list

List of the email aliases for the selected domain. Each element of the list has the following attributes:

emailAlias - string

The email alias address

details - string

Hyperlink to the email alias' details

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

The details hyperlink and hypermedia's parameters are as following:

{server-name} - string

The name of the server from which the resources are requested

{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

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.