Latest revision as of 23:59, 1 July 2014

GET /accounts/{accountNumber}/exchange/{domainName}

Retrieve an Exchange resource by domain name

Request

GET /accounts/{accountNumber}/exchange/{domainName}

Request Parameters

accountNumber - string

the Id of the ServicePlex account

domainName - string

the domain name under which Exchange is provisioned

URI Parameters

None.

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Status Code

200 OK

Success

304 Cached

The resource has not been modified since the client cached it; the client should use the version in its cache

403 Forbidden

The user lacks the necessary permissions to access the resource

404 Not Found

The account or payment info was not found

405 Unsupported Method

The request method is not supported by this resource

Response Headers

None.

Response Body

{
  "domain": "{domainName}", 
  "links": [
    {
      "href": "https://api.hostway.com/accounts/{accountNumber}/exchange/{domainName}/",
      "rel": "self"
    }
  ], 
  "mailboxes": [
    {
      "href": "https://api.hostway.com/accounts/{accountNumber}/exchange/{domainName}/mailboxes/", 
      "rel": "related"
    }
  ],
  "globalContacts": [
    {
      "href": "https://api.hostway.com/accounts/{accountNumber}/exchange/{domainName}/globalContacts/", 
      "rel": "related"
    }
  ],
  "mailingLists": [
    {
      "href": "https://api.hostway.com/accounts/{accountNumber}/exchange/{domainName}/mailingLists/", 
      "rel": "related"
    }
  ],
  "version": "2010"
}
 

Parameters

domainName - string

The domain name under which Exchange is provisioned

accountNumber - string

The ServicePlex account number