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

Corinne.chui: 1 revision

2016-05-30T19:36:05Z

1 revision

Jerry.dimitrov: /* Parameters */

2016-05-09T13:46:42Z

Parameters

Mike.robski: 1 revision: Release 100

2014-11-19T05:10:23Z

1 revision: Release 100

Velimira.metodieva: /* Parameters */

2014-10-30T16:29:18Z

Parameters

Mike.robski: 1 revision: Release 95

2014-07-02T05:58:44Z

1 revision: Release 95

Velimira.metodieva: /* Response */

2014-05-14T13:11:01Z

Response

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:17Z

1 revision: Release 87

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-webmail:GET to Accounts-account-email-domain-usernames-mailboxName-webmail:GET

2013-09-27T12:05:14Z

moved Accounts-account-email-domain-usernames-mailbox-webmail:GET to Accounts-account-email-domain-usernames-mailboxName-webmail:GET

New page

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail =
Gets OpenXchange account type.

__TOC__

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

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''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>
{
"authToken": "{authenticationToken}",
"type": "{type}",
"allowUpgrade": {allowUpgrade},
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; authenticationToken - ''string''
: Authentication token value
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type.

== Examples ==

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

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

{
"authToken": "PoiC9iyBehe13ZHWyhfa2eArKUJy+RJ5WpyN0eCBs2+Ns8SIdvhgto9zWLDnGZWlgTV9MuJ1F+//XnoKZWxjaRr2qh++437fChyxZmaHwe7g==",
"type": "standard",
"allowUpgrade": true,
"links": [
{
"href": "{APIBaseURL}/accounts/test/email/test.com/usernames/john.smith/webmail/",
"rel": "self"
}
]
}
</nowiki>

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

@@ Line 40: / Line 40: @@
     "type": "{type}",
     "allowUpgrade": {allowUpgrade},
     "theme": "{theme}",
     "language": "{language}",
@@ Line 60: / Line 61: @@
 ; type - ''string'' - one of "standard", "activesync" or "premium"
 : OpenXchange account type.
 ; theme - ''string''
 : Theme identifier for setting a specific theme when creating an OX account
@@ Line 83: / Line 86: @@
     "type": "standard",
     "allowUpgrade": true,
     "theme": "test_theme",
     "language": "en_US",

@@ Line 59: / Line 59: @@
 ; allowUpgrade - ''boolean''
 : OpenXchange allowUpgrade option
-; type - ''string'' - one of "standard", "activesync" or "premium"
+; type - ''string''
-: OpenXchange account type.
+: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
 ; resetPassword - ''boolean''
 : Returns if customer will be forced to reset mailbox password the next time he logs in to his OX account