Accounts-account-email-domain-webmail:GET - Revision history

Corinne.chui: 1 revision

2016-05-30T19:36:05Z

1 revision

Jerry.dimitrov: /* Parameters */

2016-05-09T13:59:16Z

Parameters

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:15Z

1 revision: Release 87

Stanimir.dimitrov at 14:06, 14 June 2013

2013-06-14T14:06:23Z

New page

= GET /accounts/{account}/email/{domain}/webmail =
Gets OpenXchange account type for the domain.

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/webmail</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

=== Response Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade}
"trialType": "{trialType}",
"trialExpiration": "{trialExpiration}",
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; type - ''string'' - one of "standard", "activesync" or "premium"
: Webmail account type.

; allowUpgrade - ''boolean''
: Webmail allowUpgrade option value.

; trialType - ''string'' - one of "standard", "activesync", "premium" or null
: Trial account type. Null if not set.

; trialExpiration - ''date''
: Expiration date of trial period formatted as YYYY-mm-dd. Null if not set.

== Examples ==

=== Success getting account type ===
'''Request'''
<nowiki>
GET /accounts/test/email/test.com/webmail
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"type": "standard",
"allowUpgrade": true,
"trialType": "premium",
"trialExpiration": "2018-10-28",
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 50: / Line 50: @@
 ==== Parameters ====
-; type - ''string'' - one of "standard", "activesync" or "premium"
+; type - ''string''
-: Webmail account type.
+: Webmail account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
 ; allowUpgrade - ''boolean''
 : Webmail allowUpgrade option value.
-; trialType - ''string'' - one of "standard", "activesync", "premium" or null
+; trialType - ''string'' - Can be null
-: Trial account type. Null if not set.
+: Trial account type. Null if not set. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
 ; trialExpiration - ''date''