Accounts-account-email-domain-usernames-mailboxName-webmail:PUT
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 93) |
(→Parameters) |
||
| Line 26: | Line 26: | ||
{ | { | ||
"type": "{oxtype}", | "type": "{oxtype}", | ||
| − | "allowUpgrade": {allowUpgrade} | + | "allowUpgrade": {allowUpgrade}, |
| + | "theme": "{theme}", | ||
| + | "language": "{language}", | ||
| + | "timezone": "{timezone}" | ||
} | } | ||
</nowiki> | </nowiki> | ||
| Line 36: | Line 39: | ||
; type - ''string'' - one of "standard", "activesync" or "premium" | ; type - ''string'' - one of "standard", "activesync" or "premium" | ||
: OpenXchange account type. Valid values are standard, activesync, premium. Required. | : OpenXchange account type. Valid values are standard, activesync, premium. Required. | ||
| − | : If allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response | + | : The account owner(with admin-user credentials) can make changes between account types regardless of the allowUpgrade settings. |
| − | : If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request'' | + | : If the call is made with the end-user credentials and allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response |
| + | : If the call is made with the end-user credentials and type is already different than standard and allowUpgrade is set to ''false'' the response is ''400 Bad Request'' | ||
: If current usage is more than new type quota the response is ''400 Bad Request'' | : If current usage is more than new type quota the response is ''400 Bad Request'' | ||
| + | : If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request'' | ||
| + | ; theme - ''string'' | ||
| + | : Theme identifier for setting a specific theme when creating an OX account. | ||
| + | ; language - ''string'' | ||
| + | : OpenXchange account locale of type 'en_US'. | ||
| + | ; timezone - ''string'' | ||
| + | : OpenXchange account timezone of type 'America/Chicago'. | ||
== Response == | == Response == | ||
| Line 118: | Line 129: | ||
</nowiki> | </nowiki> | ||
| − | === Failure | + | === Failure upgrading account while allowUpgrade is set to false === |
'''Request''' | '''Request''' | ||
<nowiki> | <nowiki> | ||
| Line 131: | Line 142: | ||
{"message": "This account is not allowed to be upgraded"} | {"message": "This account is not allowed to be upgraded"} | ||
| + | </nowiki> | ||
| + | |||
| + | === Failure upgrading account when mailbox qty for OX type is exceeded === | ||
| + | '''Request''' | ||
| + | <nowiki> | ||
| + | PUT /accounts/test/email/test.com/usernames/john.smith/webmail | ||
| + | |||
| + | {"type": "activesync"} | ||
| + | </nowiki> | ||
| + | |||
| + | '''Response''' | ||
| + | <nowiki> | ||
| + | 400 Bad Request | ||
| + | |||
| + | {"computeFault":"Number of mailboxes exceeded"} | ||
</nowiki> | </nowiki> | ||
| Line 146: | Line 172: | ||
</nowiki> | </nowiki> | ||
| − | === Failure | + | === Failure downgrading account due to current usage greater than new quota === |
'''Request''' | '''Request''' | ||
<nowiki> | <nowiki> | ||
| Line 160: | Line 186: | ||
{"message": "Current mailbox usage is larger than the new quota value"} | {"message": "Current mailbox usage is larger than the new quota value"} | ||
</nowiki> | </nowiki> | ||
| + | === Success updating timezone, language and theme === | ||
| + | '''Request''' | ||
| + | <nowiki> | ||
| + | PUT /email/test.com/usernames/john.smith/webmail | ||
| + | |||
| + | {"theme": "new_theme", "language": "en_US", "timezone": "America/Chicago"} | ||
| + | </nowiki> | ||
| + | |||
| + | '''Response''' | ||
| + | <nowiki> | ||
| + | 204 No Content | ||
| + | </nowiki> | ||
| + | |||
{{disqus}} | {{disqus}} | ||
[[Category:Hostway API]] | [[Category:Hostway API]] | ||
[[Category:Email API]] | [[Category:Email API]] | ||
Revision as of 09:20, 24 June 2014
PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail
Upgrades/downgrades OpenXchange account type.
Request
PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail
URI Parameters
- account - string
- domain - string
- mailboxName - string
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
Request Body
{
"type": "{oxtype}",
"allowUpgrade": {allowUpgrade},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
Parameters
- allowUpgrade - boolean
- OpenXchange allowUpgrade option value
- type - string - one of "standard", "activesync" or "premium"
- OpenXchange account type. Valid values are standard, activesync, premium. Required.
- The account owner(with admin-user credentials) can make changes between account types regardless of the allowUpgrade settings.
- If the call is made with the end-user credentials and allowUpgrade is set to false providing a type different than standard results in a 400 Bad Request response
- If the call is made with the end-user credentials and type is already different than standard and allowUpgrade is set to false the response is 400 Bad Request
- If current usage is more than new type quota the response is 400 Bad Request
- If current mailbox qty is more than allowed for specific OpenXchange account type the response is 400 Bad Request
- theme - string
- Theme identifier for setting a specific theme when creating an OX account.
- language - string
- OpenXchange account locale of type 'en_US'.
- timezone - string
- OpenXchange account timezone of type 'America/Chicago'.
Response
Status Code
- 204 No Content
- Success
- 400 Bad Request
- The format of the request body is invalid or the username does not meet the requirements.
- 401 Unauthorized
- The supplied credentials are invalid or do not provide permissions for this operation.
- 404 Not Found
- The domain name does not exist.
Examples
Failure updating account type with missing required parameter
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": ""}
Response
400 Bad Request
{"type": "Required"}
Failure updating account type with invalid parameter
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "invalid-type"}
Response
400 Bad Request
{"type": "\"invalid-type\" is not one of standard, activesync, premium"}
Failure using inconsistent combination of allowUpgrade and type
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "premium", "allowUpgrade": false}
Response
400 Bad Request
{"message": "The allowUpgrade option is inconsistent with the provided type"}
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"allowUpgrade": false}
Response
400 Bad Request
{"message": "The account is already upgraded. Please downgrade it to standard first."}
Failure upgrading account while allowUpgrade is set to false
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "premium"}
Response
400 Bad Request
{"message": "This account is not allowed to be upgraded"}
Failure upgrading account when mailbox qty for OX type is exceeded
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "activesync"}
Response
400 Bad Request
{"computeFault":"Number of mailboxes exceeded"}
Success updating account type
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "premium"}
Response
204 No Content
Failure downgrading account due to current usage greater than new quota
Request
PUT /accounts/test/email/test.com/usernames/john.smith/webmail
{"type": "standard"}
Response
400 Bad Request
{"message": "Current mailbox usage is larger than the new quota value"}
Success updating timezone, language and theme
Request
PUT /email/test.com/usernames/john.smith/webmail
{"theme": "new_theme", "language": "en_US", "timezone": "America/Chicago"}
Response
204 No Content
