Mike.robski: 1 revision: Release 95

2014-07-02T05:59:31Z

1 revision: Release 95

Petre.popescu at 13:45, 14 May 2014

2014-05-14T13:45:46Z

New page

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

Retrieve an Exchange resource by domain name

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/exchange/{domainName}</code>

==== 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}}

== 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 ===
<nowiki>
{
"domain": "{domainName}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/",
"rel": "self"
}
],
"mailboxes": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/mailboxes/",
"rel": "related"
}
],
"globalContacts": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/globalContacts/",
"rel": "related"
}
],
"mailingLists": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/mailingLists/",
"rel": "related"
}
],
"version": "2010"
}
</nowiki>

==== Parameters ====
; domainName - ''string''
: The domain name under which Exchange is provisioned

; accountNumber - ''string''
: The ServicePlex account number

[[Category:Hostway API]]
[[Category:Exchange API]]

GET Exchange - Revision history

Mike.robski: 1 revision: Release 95

Petre.popescu at 13:45, 14 May 2014