Hostway API Documentation - User contributions [en]

Accounts-accountNumber-domains:GET

2015-03-13T14:33:50Z

Stanimir.dimitrov:

= GET /accounts/''{accountNumber}''/domains =
Search for domains in client's account. Standard paging parameters can be used.
The result is in standard paging format: list of list of results and pages count.
You can search by name (with wildcard), expired or expiring (within 45 days of
expiration) domains, or specify date range for expiration.

__TOC__
== Request ==
<code>GET /accounts/''{accountNumber}''/domains</code>

==== Parameters ====
;filterName
: The product name or wildcard pattern (optional).
;filterDomainName
: The product domain name (optional)
;filterExpired
: true|false (optional)
;filterExpiring
: true|false (optional)
;filterDays
: number of days (optional) to be used in conjunction with expiring or expired. The default value is 45 days, i.e. a domain is considered "expiring" if it expires in 45 days or less.
;filterExpiresBefore
: yyyy-mm-dd (optional)
;filterExpiresAfter
: yyyy-mm-dd (optional)
;filterStatus
: The product status (optional)
;page
: page number (optional)
;pageSize
: number of items per page (optional)

=== URI Parameters ===
;accountNumber
: client account number

=== Request Headers ===
None.

=== Request Body ===
None.

== Response ==

=== Status Code ===
;200 OK
: Returns list of domains.

=== Response Body ===
List of list of domains and pages count.

== Example search for a domain product. ==
'''Request'''
<nowiki>
GET /accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=2014-04-11

</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8

{
"total_count": 1,
"list":
[
{
"status": "open",
"createDate": "2013-02-02",
"billingCycle": 12,
"name": "ng-test-fitnesse-20130202-0605.com",
"domainName": "ng-test-fitnesse-20130202-0605.com",
"expirationDate": "2018-02-02",
"serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
"service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
}
],
"links":
[
{
"href": "http://{host:port}/accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=2014-04-11",
"rel": "self"
}
]
}
</nowiki>

== Example search for a domain product. ==
'''Request'''
<nowiki>
GET /accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com

</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8

{
"total_count": 1,
"list":
[
{
"status": "open",
"createDate": "2013-02-02",
"billingCycle": 12,
"name": "ng-test-fitnesse-20130202-0605.com",
"domainName": "ng-test-fitnesse-20130202-0605.com",
"expirationDate": "2018-02-02",
"serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
"service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
}
],
"links":
[
{
"href": "http://{host:port}/accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Accounts-accountNumber-domains:GET

2014-12-09T13:51:48Z

Stanimir.dimitrov:

Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT

2014-11-11T13:35:35Z

Stanimir.dimitrov: /* Examples */

= PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox =
Creates or updates a mailbox for specified account and domain. The mailbox quota is determined by the E-mail domain product specification.
__TOC__

== Request ==
<code>PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''string''
: The mailbox. String should meet the regexp [a-zA-Z0-9._-]+

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

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

=== Request Body ===
<nowiki>
{
"password": "{password}",
"master": {master},
"quota": {quota},
"type": {type},
"username": {username}
}
</nowiki>

==== Parameters ====
<onlyinclude>
; password - ''string'' (Required)
: The password. The password should be at least 8 characters long, a mix of numbers, symbols and mixed-case letters. It should not begin with "pass", "123", "abc", should not contain the second-level domain name of the service, should not contain the username of the mailbox or start with its first 3 characters. There is a restriction using the same password more than once.
: Password validation rules:
:: Password must not be used more than once
:: Minimum length 8
:: Maximum length 128
:: Should have at least one digit
:: Should have at least one capital letter
:: Should have at least one lower case letter
:: Should contain at least one special character (any character other than lower or uppercase letters, digits and underscore "_" is considered special character)
:: Should not start with the phrase 'pass' case-insensitively
:: Should not start with 'abc' case-insensitively
:: Should not start with 123
:: Must not contain second-level domain, username or start with the first 3 letters from the username
</onlyinclude>

; master - ''boolean''
: Describes if this is a master account.

; quota - ''int''
: Quota value in MB. If not provided default quota for OpenXchange type is set

; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''

; username - ''string''
: The mailbox. String should meet the regexp [a-zA-Z0-9._-]+
: Should be used when updating mailbox only

== Response ==

=== Status Code ===
; 201 Created
: Success

; 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.

; 409 Conflict
: Mailbox already exists.

== Examples ==

=== Trying to create mailbox without a password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"master": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"password":"Required"}
</nowiki>

=== Trying to create mailbox with a not valid password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "abc1234", "master": true}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"password":"Required"}
</nowiki>

=== Trying to create mailbox with invalid quota value(less or equal to 0) ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password: "test_password1", "quota": 0}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Quota must be greater than 0"}
</nowiki>

=== Trying to create mailbox when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password: "test_password1", "type": "activesync"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"computeFault":"Number of mailboxes exceeded"}
</nowiki>

=== Create mailbox ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "pWord123$", "master": true}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

=== Update mailbox password ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "!q2w3e4R"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Trying to update mailbox password with already used one ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"password": "pWord123$"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request
</nowiki>

=== Update mailbox name ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"username": "john.smith2"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Update mailbox using an existing name ===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"username": "jack.smith"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request
</nowiki>

=== Create mailbox with specified quota===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"password": "pword1234", "quota": 70}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

=== Update existing mailbox quota===
'''Request'''
<nowiki>
PUT /accounts/test-account123/email/test.com/usernames/john.smith2/mailbox

{"quota": 85}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API|Email API]]

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

Dns-healthcheck:GET

2014-07-18T11:36:08Z

Stanimir.dimitrov:

= GET /dns/healthcheck =

__TOC__

== Request ==
<code>GET /dns/healthcheck</code>

== Response ==

=== Status Codes ===
; 200 OK : Success
; 400 Bad Request : If any of the database connections is down.
; 500 Internal Server Error : If something is wrong with the DNS API.

== See also ==
* [[DNS|DNS API]]
* [[Common Features]]

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

Dns-heartbeat:GET

2014-07-18T11:34:19Z

Stanimir.dimitrov: /* Status Codes */

= GET /dns/heartbeat =

__TOC__

== Request ==
<code>GET /dns/heartbeat</code>

== Response ==

=== Status Codes ===
;200 OK
: Success

;500 Internal Server Error
: Internal error occurred.

== See also ==
* [[DNS|DNS API]]
* [[Common Features]]

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

Accounts-account-email-domain-usernames-mailboxName-forwards:POST

2014-06-27T09:27:45Z

Stanimir.dimitrov: /* Creating local forwarding or distribution list that contains mailboxes in the source domain */

= POST accounts/{account}/email/{domain}/usernames/{mailbox}/forwards =
Sets forwarding for specified mailbox,domain and account.

__TOC__

== Request ==
<code>POST accounts/{account}/email/{domain}/usernames/{mailbox}/forwards</code>

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

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

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

=== Request Body ===
<nowiki>
{
"targets": [
{"target": "{target-email}"},
{"target": "{target-email1}"},
]
}
</nowiki>

==== Parameters ====
; targets - ''list''
: List of target objects.

; target - ''string''
: The target mailbox to forward to.

== 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 when creating a forwarding with missing required parameter ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{empty request body}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"targets":"Required"}
</nowiki>

=== Failure when creating a forwarding with an empty list of targets ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{"targets":[]}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"targets": "Shorter than minimum length 1"}
</nowiki>

=== Success when creating a forwarding ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@example.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Success setting multiple forwarding targets (distribution list) ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@test.com"},
{"target": "test-fwd1@example.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Creating local forwarding or distribution list that contains mailboxes in the source domain ===
Local forwarding is created when some or all of the target mailboxes are in the same domain as the source mailbox. In case there are such mailboxes certain validation rules are applied that verify the target mailbox existence and that the target mailbox is different than the source.<br/>
It is important to note that '''none''' of the targets will be created if the validation fails for '''any''' of the mailboxes in the list.<br/>
That is: a single non-existent local target mailbox in the list will prevent all of the targets from being added regardless of the invalid target position in the list.

=== Failure when creating forwarding to the same mailbox (avoids forwarding loops) ===
'''Request'''
<nowiki>
POST accounts/source_account/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "source-account@test.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"source-account@test.com": "Is the same as current mailbox"}
</nowiki>

=== Failure when creating local forwarding to non-existing mailbox ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "not-existing-mailbox@test.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"not-existing-mailbox@test.com": "Target not found"}
</nowiki>

=== Failure when creating a distribution list with a missing local target mailbox ===
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "existing-mailbox@test.com"},
{"target": "not-existing-mailbox@test.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"not-existing-mailbox@test.com": "Target not found"}
</nowiki>

=== Success creating forwarding to an external mailbox ===
Notice the '''different_domain.com''' in the request is external (different than '''test.com''').<br>
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@different-domain.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Success creating forwarding to multiple external mailboxes (distribution list) ===
'''Request'''<br>
Notice that '''different_domain_1.com''' and '''different_domain_2.com''' are both different than '''test.com'''.
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@different-domain_1.com"},
{"target": "test-fwd1@different-domain_2.com"}
]
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API|Email API]]

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

Accounts-accountId-products-productId-services:GET

2014-01-31T13:06:40Z

Stanimir.dimitrov: /* Status Code */

= GET /accounts/''{accountId}''/products/''{productId}''/services =
Retrieves a list of all services associated with a given product.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/''{productId}''/services</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

; productId - ''string''
: The Id of the product.

=== URI Parameters ===
None.

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

== Response ==

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

;404 Not Found
: The account Id or product Id was not found.

;403 Forbidden
: Access to '''closed''' and '''suspended''' accounts requires elevated permissions

=== Response Body ===
<nowiki>
{
"list": [
{
"name": "Product 1",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecId1}",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId1}", "rel": "self"}
]
},
{
"name": "Product 2",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecId2}"
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId2}", "rel": "self"}
],
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about specific services

:; status - ''string''
:: Describes the status of a service. Valid values are '''open''', '''closed''', '''pending''', or '''suspended'''

:; name - ''string''
:: Descriptive name of the service

:; billingCycle - ''integer''
:: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

:; serviceSpecification - ''string''
:: [[Hypermedia]] for this service resource. Link to the service's specification.

:; links - ''list''
:: [[Hypermedia]] for this service resource. Links to the service.

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-products-productId-services-serviceId:GET

2014-01-31T13:05:26Z

Stanimir.dimitrov: /* Status Code */

= GET /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}'' =
Get service information.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

; productId - ''string''
: The Id of the product.

; serviceId - ''string''
: The Id of the service.

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

== Response ==

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

; 401 Unauthorized
: Authorization credentials not submitted or invalid.

; 404 Not Found
: The account, product Id or service Id not found.

=== Response Body ===

<nowiki>
{
"status": "open",
"name": "Service Name",
"billingCycle": 12,
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId}", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Current status of the service. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''.

; name - ''string''
: Name of the service.

; billingCycle - ''integer''
: Billing cycle of the service in months.

; serviceSpecification - ''string''
: Link to the specification of the current service.

; links - ''list''
: [[Hypermedia]] for the service resource

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Account

2014-01-31T12:54:49Z

Stanimir.dimitrov:

= Account Management API =
The account management API provides methods for managing the account contacts, users and products.
Clients can update the status of the account products as well as change (upgrade/downgrade) them.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Account Management ==
* [[Accounts:GET|GET /accounts]] - Returns list of accounts authorized for access with the provided credentials
* [[Accounts-accountId:GET|GET /accounts/{accountId}]] - Returns information about an account
* [[Accounts-accountId:GET#Alternative_with_partner_Id|GET /partnerAccounts/{partnerAccountId}]] - Returns information about an account specified by its partner Id
* [[Accounts-accountId:PUT|PUT /accounts/{accountId}]] - Updates account status
* [[Accounts-accountId:PUT#Alternative_with_partner_Id|PUT /partnerAccounts/{partnerAccountId}]] - Updates account status for account specified by its partner Id
* [[Accounts-accountId:DELETE|DELETE /accounts/{accountId}]] - Purges an account from the system
* [[Accounts-accountId:DELETE#Alternative_with_partner_Id|DELETE /partnerAccounts/{partnerAccountId}]] - Purges an account specified by its partner Id from the system

== Partner Account Attributes Management ==
* [[PartnerAccounts-partnerAccountId-attributes:GET|GET /partnerAccounts/{partnerAccountId}/attributes]] - Returns list of attributes
* [[PartnerAccounts-partnerAccountId-attributes:POST|POST /partnerAccounts/{partnerAccountId}/attributes]] - Creates new attribute
* [[PartnerAccounts-partnerAccountId-attributes-attribute:GET|GET /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Gets attribute
* [[PartnerAccounts-partnerAccountId-attributes-attribute:PUT|PUT /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Updates attribute value
* [[PartnerAccounts-partnerAccountId-attributes-attribute:DELETE|DELETE /partnerAccounts/{partnerAccountId}/attributes/{attribute}]] - Deletes attribute

== Contacts Management ==
* [[Accounts-accountId-Contacts:GET|GET /accounts/{accountId}/contacts]] - Returns all contacts for an account

== Users Management ==
* [[Accounts-accountId-users:GET|GET /accounts/{accountId}/users]] - Returns a list of users in the account
* [[Accounts-accountId-users:POST|POST /accounts/{accountId}/users]] - Creates a new user in the account
* [[Accounts-accountId-users-userName:GET|GET /accounts/{accountId}/user/{userName}]] - Returns the details of a specific user in the account
* [[Accounts-accountId-users-userName:PUT|PUT /accounts/{accountId}/user/{userName}]] - Updates the user details (password, security question/answer)
* [[Accounts-accountId-user:PUT|PUT /accounts/{accountId}/user]] - (Deprecated) Updates the user details (password, security question/answer) of a user
* [[Accounts-accountId-users-userName:DELETE|DELETE /accounts/{accountId}/user/{userName}]] - Deletes a user
* [[Accounts-accountId-users-userName-roles:GET|GET /accounts/{accountId}/user/{userName}/roles]] - Returns the list of roles of a user
* [[Accounts-accountId-users-userName-roles:PUT|PUT /accounts/{accountId}/user/{userName}/roles]] - Updates the list of roles of a user

== Products Management ==
* [[Accounts-accountId-products:GET|GET /accounts/{accountId}/products]] - Gets all products for an account
* [[Accounts-accountId-products-productId:GET|GET /accounts/{accountId}/products/{productId}]] - Get information about a product
* [[Accounts-accountId-products-productId:PUT|PUT /accounts/{accountId}/products/{productId}]] - Update the status of a product
* [[Accounts-accountId-products-productId-action:POST|POST /accounts/{accountId}/products/{productId}/action]] - Perform an action (e.g: upgrade/downgrade) for a product
* [[Accounts-accountId-products-productId-services:GET|GET /accounts/{accountId}/products/{productId}/services]] - List services for a specific product
* [[Accounts-accountId-products-productId-services-serviceId:GET|GET /accounts/{accountId}/products/{productId}/services/{serviceId}]] - Get information about a specific service

== Products Bandwidth Management ==
* [[Accounts-accountId-products-productId-bandwidth-daily:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/daily?filterType={filterType}&from={filterStartDate}&to={filterEndDate}]] - Get a report on the daily bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-weekly:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/weekly?filterType={filterType}&from={filterStartDate}&to=filterEndDate}]] - Get a report on the weekly bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-monthly:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/monthly?filterType={filterType}&from={filterStartDate}&to=filterEndDate}]] - Get a report on the monthly bandwidth usage of the product
* [[Accounts-accountId-products-productId-bandwidth-yearly:GET|GET /accounts/{accountId}/products/{productId}/bandwidth/yearly?filterType={filterType}&from={filterStartDate}&to=filterEndDate}]] - Get a report on the yearly bandwidth usage of the product
Each bandwidth usage is filtered by the traffic type(www or ftp), the start date and the end date in ISO format(eg. 2013-20-02).

== Products Usage Management ==
* [[Accounts-accountId-products-productId-usage:GET|GET /accounts/{accountId}/products/{productId}/usage]] - Get an aggregated services usage report of a product

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-account-email-domain-usernames-mailboxName-messagestats:GET

2014-01-22T16:11:49Z

Stanimir.dimitrov: /* Status Code */

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats =
Retrieves mailbox message count for INBOX, SENT and SPAM folders

__TOC__

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

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

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

== 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 or the mailbox does not exist.
: Unable to get message count for virtual mailboxes.

; 500 Internal Server Error
: Missing Domain or Installation records

; 502 Bad Gateway
: Unable to get message count. No IMAP connection
: Unable to get message count. IMAP search operation failed.
: Unable to get message count. IMAP folder selection failed.

=== Response Body ===
<nowiki>
{
"messageCount" : {
"inbox" : {
"allMessages" : {inbox_all_messages_count},
"unreadMessages" : {inbox_unread_messages_count}
},
"sent" : {
"allMessages" : {sent_all_messages_count},
"unreadMessages" : {sent_unread_messages_count}
},
"spam" : {
"allMessages" : {spam_all_messages_count},
"unreadMessages" : {sent_unread_messages_count}
}
},
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats/, "rel": "self"}]
}
</nowiki>

==== Parameters ====
; inbox_all_messages_count- ''integer''
: All messages for INBOX folder

; inbox_unread_messages_count- ''integer''
: Unread messages for INBOX folder

; sent_all_messages_count- ''integer''
: All messages for SENT folder

; sent_unread_messages_count- ''integer''
: Unread messages for SENT folder

; spam_all_messages_count- ''integer''
: All messages for SPAM folder

; spam_unread_messages_count- ''integer''
: Unread messages for SPAM folder

== Examples ==

=== Success ===
'''Request'''
<nowiki>
GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats
</nowiki>

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

{
"messageCount" : {
"inbox" : {
"allMessages" : 3,
"unreadMessages" : 3
},
"sent" : {
"allMessages" : 0,
"unreadMessages" : 0
},
"spam" : {
"allMessages" : 0,
"unreadMessages" : 0
}
},
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats/", "rel": "self"}]
}
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

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

Accounts-account-email-domain-contacts-contact:DELETE

2013-11-06T14:09:50Z

Stanimir.dimitrov:

= DELETE /accounts/{account}/email/{domain}/contacts/{contact} =
Deletes domain's global address book contact.

__TOC__

== Request ==
<code>DELETE /accounts/{account}/email/{domain}/contacts/{contact}</code>

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

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

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

== Response ==

=== Status Code ===
; 204 No Content
: Success

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

; 404 Not Found
: The domain or contact does not exist.

== Examples ==

=== Success deleting domain's global address book contact ===
'''Request'''
<nowiki>
DELETE </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API#Global Address Book|Global Address Book Public API]]

[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-contacts-contact:PUT

2013-11-06T14:09:33Z

Stanimir.dimitrov: /* See also */

= PUT /accounts/{account}/email/{domain}/contacts/{contact} =
Updates domain's global address book contact info
__TOC__

== Request ==
<code>PUT /accounts/{account}/email/{domain}/contacts/{contact}</code>

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

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

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

=== Request Body ===
<nowiki>
{
"email": "{email}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"displayName": "{displayName}"
"title": "{title}",
"homePhone": "{homePhone}",
"mobilePhone": "{mobilePhone}",
"businessPhone": "{businessPhone}",
"businessFax": "{businessFax}",
"isdnNumber": "{isdnNumber}",
"pager": "{pager}",
"telexNumber": "{telexNumber}",
"company": "{company}",
"department": "{department}",
"roomNumber": "{roomNumber}",
"streetAddress": "{streetAddress}",
"postalCode": "{postalCode}",
"city": "{city}",
"state": "{state}",
"country": "{country}"
}
</nowiki>

==== Parameters ====
; email - ''string''
: The email of global address book contact.

; firstName - ''string''
: The first name of global address book contact.

; lastName - ''string''
: The last name of global address book contact.

; displayName - ''string''
: The display name of global address book contact.

; title - ''string''
: The title of global address book contact person.

; homePhone - ''string''
: The home phone of global address book contact.

; mobilePhone - ''string''
: The home phone of global address book contact.

; businessPhone - ''string''
: The business phone of global address book contact.

; businessFax - ''string''
: The business fax of global address book contact.

; isdnNumber - ''string''
: The isdn number of global address book contact.

; pager - ''string''
: The pager of global address book contact.

; telexNumber - ''string''
: The telex number of global address book contact.

; company - ''string''
: The company name of global address book contact.

; department - ''string''
: The department name of global address book contact.

; roomNumber - ''string''
: The room number of global address book contact.

; streetAddress - ''string''
: The street address of global address book contact.

; postalCode - ''string''
: The postal code of global address book contact.

; city - ''string''
: The city name of global address book contact.

; state - ''string''
: The state name of global address book contact.

; country - ''string''
: The country name of global address book contact.

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the parameters don't meet the requirements.

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

== Examples ==

=== Failure updating global address book contact because of erroneous data ===
'''Request'''
<nowiki>
PUT </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact

{
"email": "updated-email",
"displayName": "Display Name Updated"
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{
"email": "Invalid email address"
}
</nowiki>

=== Success updating global address book contact ===
'''Request'''
<nowiki>
PUT </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact

{
"email": "new@test.com",
"mobilePhone": "123456789"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API#Global Address Book|Global Address Book Public API]]

[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-contacts-contact:GET

2013-11-06T14:09:13Z

Stanimir.dimitrov: /* See also */

= GET /accounts/{account}/email/{domain}/contacts/{contact} =
Gets domain's global address book contact information
__TOC__

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

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

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

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

=== Status Code ===
; 200 Ok
: Success

; 400 Bad Request
: The format of the request body is invalid or the parameters don't meet the requirements.

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

=== Response Body ===
<nowiki>
{
"name": "{name}",
"email": "{email}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"displayName": "{displayName}"
"title": "{title}",
"homePhone": "{homePhone}",
"mobilePhone": "{mobilePhone}",
"businessPhone": "{businessPhone}",
"businessFax": "{businessFax}",
"isdnNumber": "{isdnNumber}",
"pager": "{pager}",
"telexNumber": "{telexNumber}",
"company": "{company}",
"department": "{department}",
"roomNumber": "{roomNumber}",
"streetAddress": "{streetAddress}",
"postalCode": "{postalCode}",
"city": "{city}",
"state": "{state}",
"country": "{country}",
"links": [{"href": "{APIBaseURL}/accounts/{account}/email/{domain}/contacts/{name}", "rel": "self"}]

}
</nowiki>

==== Parameters ====
; name - ''string''
: The name of global address book contact.

; email - ''string''
: The email of global address book contact.

; firstName - ''string''
: The first name of global address book contact.

; lastName - ''string''
: The last name of global address book contact.

; displayName - ''string''
: The display name of global address book contact.

; title - ''string''
: The title of global address book contact person.

; homePhone - ''string''
: The home phone of global address book contact.

; mobilePhone - ''string''
: The home phone of global address book contact.

; businessPhone - ''string''
: The business phone of global address book contact.

; businessFax - ''string''
: The business fax of global address book contact.

; isdnNumber - ''string''
: The isdn number of global address book contact.

; pager - ''string''
: The pager of global address book contact.

; telexNumber - ''string''
: The telex number of global address book contact.

; company - ''string''
: The company name of global address book contact.

; department - ''string''
: The department name of global address book contact.

; roomNumber - ''string''
: The room number of global address book contact.

; streetAddress - ''string''
: The street address of global address book contact.

; postalCode - ''string''
: The postal code of global address book contact.

; city - ''string''
: The city name of global address book contact.

; state - ''string''
: The state name of global address book contact.

; country - ''string''
: The country name of global address book contact.

== Examples ==

=== Error getting global address book contact info ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/non-existent-contact

</nowiki>

'''Response'''
<nowiki>
404 Not Found

</nowiki>

=== Success getting global address book contact info ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "test@test.com",
"homePhone": "",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact", "rel": "self"}]
}
</nowiki>

== See also ==
* [[Email API#Global Address Book|Global Address Book Public API]]

[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-contacts:GET

2013-11-06T14:08:57Z

Stanimir.dimitrov: /* See also */

= GET /accounts/{account}/email/{domain}/contacts?filter{FieldName}={FieldValue}[&filter{FieldName}={FieldValue}] =
Filter domain's global address book contacts list

= GET /accounts/{account}/email/{domain}/contacts?search{FieldName}={FieldValue}[&search{FieldName}={FieldValue}] =
Search domain's global address book contacts list
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/contacts?filter{FieldName}={FieldValue}[&filter{FieldName}={FieldValue}]</code>

<code>GET /accounts/{account}/email/{domain}/contacts?search{FieldName}={FieldValue}[&search{FieldName}={FieldValue}]</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; filter{FieldName} - ''string''
: Specifies fields to filter by, i.e. filterName, filterEmail, etc...
; search{FieldName} - ''string''
: Specifies fields to search by, i.e. searchName, searchEmail, etc...
=== Request Headers ===
{{Authorization}}

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

=== Status Code ===
; 200 Ok
: Success

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

=== Response Body ===
<nowiki>
{
"count": {count},
"list": [
{
"name": "{name}",
"email": "{email}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"displayName": "{displayName}"
"title": "{title}",
"homePhone": "{homePhone}",
"mobilePhone": "{mobilePhone}",
"businessPhone": "{businessPhone}",
"businessFax": "{businessFax}",
"isdnNumber": "{isdnNumber}",
"pager": "{pager}",
"telexNumber": "{telexNumber}",
"company": "{company}",
"department": "{department}",
"roomNumber": "{roomNumber}",
"streetAddress": "{streetAddress}",
"postalCode": "{postalCode}",
"city": "{city}",
"state": "{state}",
"country": "{country}",
"links": [{"href": "{APIBaseUrl}/accounts/{account}/email/{domain}/contacts/{name}", "rel": "self"}],
}
],
"links": [{"href": "{APIBaseUrl}/accounts/{account}/email/{domain}/contacts", "rel": "self"}],
}
</nowiki>

==== Parameters ====
; count - ''int''
: The count of global address book contacts matching the serch/filter condition.

; name - ''string''
: The name of global address book contact.

; email - ''string''
: The email of global address book contact.

; firstName - ''string''
: The first name of global address book contact.

; lastName - ''string''
: The last name of global address book contact.

; displayName - ''string''
: The display name of global address book contact.

; title - ''string''
: The title of global address book contact person.

; homePhone - ''string''
: The home phone of global address book contact.

; mobilePhone - ''string''
: The home phone of global address book contact.

; businessPhone - ''string''
: The business phone of global address book contact.

; businessFax - ''string''
: The business fax of global address book contact.

; isdnNumber - ''string''
: The isdn number of global address book contact.

; pager - ''string''
: The pager of global address book contact.

; telexNumber - ''string''
: The telex number of global address book contact.

; company - ''string''
: The company name of global address book contact.

; department - ''string''
: The department name of global address book contact.

; roomNumber - ''string''
: The room number of global address book contact.

; streetAddress - ''string''
: The street address of global address book contact.

; postalCode - ''string''
: The postal code of global address book contact.

; city - ''string''
: The city name of global address book contact.

; state - ''string''
: The state name of global address book contact.

; country - ''string''
: The country name of global address book contact.

== Examples ==

=== Success filtering global address book contacts with filterName and filterEmail parameters ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts?filterName=search-contact&filterEmail=new@test.com

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"count": 1,
"list": [
{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "new@test.com",
"homePhone": "",
"name": "search-contact",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/search-contact", "rel": "self"}],
}
],
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts", "rel": "self"}],
}
</nowiki>

=== Success filtering global address book contacts with only filterEmail parameter ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts?filterEmail=new@test.com

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"count": 2,
"list": [
{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "new@test.com",
"homePhone": "",
"name": "search-contact",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/search-contact", "rel": "self"}],
},
{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "123456789",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "new@test.com",
"homePhone": "",
"name": "test-contact",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact", "rel": "self"}],
}
],
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts", "rel": "self"}],
}
</nowiki>

=== Success searching global address book contacts with only searchName parameter ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts?searchName=contact

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"count": 2,
"list": [
{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "new@test.com",
"homePhone": "",
"name": "search-contact",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/search-contact", "rel": "self"}],
},
{
"city": "",
"businessPhone": "",
"displayName": "Display Name",
"mobilePhone": "123456789",
"firstName": "First",
"title": "",
"roomNumber": "",
"lastName": "Last",
"company": "",
"pager": "",
"state": "",
"department": "",
"streetAddress": "",
"isdnNumber": "",
"postalCode": "",
"country": "",
"telexNumber": "",
"businessFax": "",
"email": "new@test.com",
"homePhone": "",
"name": "test-contact",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts/test-contact", "rel": "self"}],
}
],
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts", "rel": "self"}],
}
</nowiki>

=== Success filtering global address book contacts with non-existent filterName parameter ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts?filterName=notexisting

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"count": 0,
"list": [],
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts", "rel": "self"}],
}
</nowiki>

=== Success searching global address book contacts with non-existent searchName parameter ===
'''Request'''
<nowiki>
GET </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts?searchName=notexisting

</nowiki>

'''Response'''
<nowiki>
200 Ok

{
"count": 0,
"list": [],
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts", "rel": "self"}],
}
</nowiki>

== See also ==
* [[Email API#Global Address Book|Global Address Book Public API]]

[[Category:Hostway API]]
[[Category:Email API]]

Accounts-account-email-domain-contacts:POST

2013-11-06T14:08:39Z

Stanimir.dimitrov: /* See also */

= POST /accounts/{account}/email/{domain}/contacts =
Creates global address book contact for domain
__TOC__

== Request ==
<code>POST /accounts/{account}/email/{domain}/contacts</code>

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

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

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

=== Request Body ===
<nowiki>
{
"name": "{name}",
"email": "{email}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"displayName": "{displayName}"
"title": "{title}",
"homePhone": "{homePhone}",
"mobilePhone": "{mobilePhone}",
"businessPhone": "{businessPhone}",
"businessFax": "{businessFax}",
"isdnNumber": "{isdnNumber}",
"pager": "{pager}",
"telexNumber": "{telexNumber}",
"company": "{company}",
"department": "{department}",
"roomNumber": "{roomNumber}",
"streetAddress": "{streetAddress}",
"postalCode": "{postalCode}",
"city": "{city}",
"state": "{state}",
"country": "{country}"
}
</nowiki>

==== Parameters ====
; name - ''string''
: The name of global address book contact. Required.

; email - ''string''
: The email of global address book contact. Required.

; firstName - ''string''
: The first name of global address book contact.

; lastName - ''string''
: The last name of global address book contact.

; displayName - ''string''
: The display name of global address book contact. Required.

; title - ''string''
: The title of global address book contact person.

; homePhone - ''string''
: The home phone of global address book contact.

; mobilePhone - ''string''
: The home phone of global address book contact.

; businessPhone - ''string''
: The business phone of global address book contact.

; businessFax - ''string''
: The business fax of global address book contact.

; isdnNumber - ''string''
: The isdn number of global address book contact.

; pager - ''string''
: The pager of global address book contact.

; telexNumber - ''string''
: The telex number of global address book contact.

; company - ''string''
: The company name of global address book contact.

; department - ''string''
: The department name of global address book contact.

; roomNumber - ''string''
: The room number of global address book contact.

; streetAddress - ''string''
: The street address of global address book contact.

; postalCode - ''string''
: The postal code of global address book contact.

; city - ''string''
: The city name of global address book contact.

; state - ''string''
: The state name of global address book contact.

; country - ''string''
: The country name of global address book contact.

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the parameters don't meet the requirements.

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

; 409 Conflict
: The global address book contact already exists.

== Examples ==

=== Failure creating global address book contact because of missing data ===
'''Request'''
<nowiki>
POST </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts

{}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{
"displayName": "Required",
"name": "Required",
"email": "Required"
}
</nowiki>

=== Failure creating global address book contact because of erroneous data ===
'''Request'''
<nowiki>
POST </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts

{
"name": "test-contact",
"email": "test",
"displayName": "Display Name"
}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{
"email": "Invalid email address"
}
</nowiki>

=== Success creating global address book contact ===
'''Request'''
<nowiki>
POST </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts

{
"name": "test-contact",
"email": "test@test.com",
"firstName": "First",
"lastName": "Last",
"displayName": "Display Name"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Failure creating contact because contact with the same name already exists ===
'''Request'''
<nowiki>
POST </nowiki>{{APIBaseURL}}<nowiki>/accounts/account007/email/test-domain.com/contacts

{
"name": "test-contact",
"email": "test@test.com",
"firstName": "First",
"lastName": "Last",
"displayName": "Display Name"
}
</nowiki>

'''Response'''
<nowiki>
409 Conflict

{
"conflict": {
"guid": "af4f4c85-4c8f-4c63-95d1-f3fb8cb8c479",
"code": 409,
"message": "Data conflict"
"details": ""
}
}
</nowiki>

== See also ==
* [[Email API#Global Address Book|Global Address Book Public API]]

[[Category:Hostway API]]
[[Category:Email API]]

Email API

2013-11-06T13:17:22Z

Stanimir.dimitrov:

== Mailboxes ==
* [[Accounts-account-email-domain-usernames:GET|GET /accounts/{account}/email/{domain}/usernames]] - Retrieves a list of mailboxes
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}]] - Gets mailbox details
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Create or update mailbox data
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Deletes a mailbox

== Forwards ==
* [[Accounts-account-email-domain-usernames-mailboxName-forwards:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards]] - Sets mailbox forwarding
* [[Accounts-account-email-domain-usernames-mailboxName-forwards:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards]] - Gets mailbox forwarding info
* [[Accounts-account-email-domain-usernames-mailboxName-forwards-fwdmailbox:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards/{fwd-mailbox}]] - Deletes mailbox forwarding

== Autoresponder ==
* [[Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/autoresponder]] - Sets an auto-responder
* [[Accounts-account-email-domain-usernames-mailboxName-autoresponder:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/autoresponder]] - Gets auto-responder info

== CleanMailPlus ==
* [[Accounts-account-email-domain-usernames-mailboxName-cleanmailplus:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/cleanmailplus]] - Gets mailbox's CleanMailPlus info
* [[Accounts-account-email-domain-usernames-mailboxName-cleanmailplus:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/cleanmailplus]] - Updates mailbox's CleanMailPlus info

== Webmail ==
* [[Accounts-account-email-domain-webmail:GET|GET /accounts/{account}/email/{domain}/webmail]] - Getting OX allowUpgrade option for the domain
* [[Accounts-account-email-domain-webmail:PUT|PUT /accounts/{account}/email/{domain}/webmail]] - Change the OX allowUpgrade option for the domain
* [[Accounts-account-email-domain-usernames-mailboxName-webmail:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail]] - Getting OX account type
* [[Email-domain-usernames-mailboxName-webmail:GET|GET /email/{domain}/usernames/{mailboxName}/webmail]] - Getting OX account type
* [[Accounts-account-email-domain-usernames-mailboxName-webmail:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail]] - Create OX account
* [[Email-domain-usernames-mailboxName-webmail:POST|POST /email/{domain}/usernames/{mailboxName}/webmail]] - Create OX account
* [[Accounts-account-email-domain-usernames-mailboxName-webmail:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail]] - Update/Downgrade OX account
* [[Email-domain-usernames-mailboxName-webmail:PUT|PUT /email/{domain}/usernames/{mailboxName}/webmail]] - Update/Downgrade OX account

== InfoStore ==
* [[Accounts-account-email-domain-infostore:GET|GET /accounts/{account}/email/{domain}/infostore]] - Getting InfoStore usage
* [[Accounts-account-email-domain-infostore:PUT|PUT /accounts/{account}/email/{domain}/infostore]] - Change InfoStore quota

== Mailbox domain statistics ==
* [[Accounts-account-email-domain-statistics-mailboxTypeCount:GET|GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount]] - Retrieves per domain statistics about webmail usage

== Mailbox migration failure ==
* [[Accounts-account-email-domain-usernames-mailboxName-migration:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/migration]] - Creating support ticket for failed mailbox migration

== Global Address Book ==
* [[Accounts-account-email-domain-contacts:POST|POST /accounts/{account}/email/{domain}/contacts]] - Creates global address book contact for domain
* [[Accounts-account-email-domain-contacts:GET|GET /accounts/{account}/email/{domain}/contacts]] - Search/Filter domain's global address book contacts list
* [[Accounts-account-email-domain-contacts-contact:GET|GET /accounts/{account}/email/{domain}/contacts/{contact}]] - Gets domain's global address book contact info
* [[Accounts-account-email-domain-contacts-contact:PUT|PUT /accounts/{account}/email/{domain}/contacts/{contact}]] - Updates domain's global address book contact info
* [[Accounts-account-email-domain-contacts-contact:DELETE|DELETE /accounts/{account}/email/{domain}/contacts/{contact}]] - Deletes domain's global address book contact

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

Orders-orderId-account-products-productId-promotion:PUT

2013-10-03T10:52:06Z

Stanimir.dimitrov: /* Status Code */

= PUT /orders/{orderId}/account/products/{productId}/promotion =
Set promotion code for a product in an order.
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/products/{productId}/promotion</code>

=== URI Parameters ===
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product for which actions are to be performed

=== Query String Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"promoCode": "ThanksgivingPriceDrop"
}
</nowiki>

==== Request Body Parameters ====
; promoCode - ''string''
: A promotion code to be applied to the product fees when retrieving the quote.

== Response ==

=== Status Code ===
;204 No Content
: The promotion code was successfully set.

;401 Unauthorized
: The request was not properly authorized.

;404 Not Found
: Returned if the order or the product could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders-orderId-account-products-productId-promotion:DELETE

2013-10-03T10:51:28Z

Stanimir.dimitrov: Created page with "= DELETE /orders/{orderId}/account/products/{productId}/promotion = Set promotion code for a product in an order. __TOC__ == Request == <code>DELETE /orders/''{orderId}''/acc..."

= DELETE /orders/{orderId}/account/products/{productId}/promotion =
Set promotion code for a product in an order.
__TOC__

== Request ==
<code>DELETE /orders/''{orderId}''/account/products/{productId}/promotion</code>

=== URI Parameters ===
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product for which actions are to be performed

=== Query String Parameters ===
None.

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

{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
;204 No Content
: The promotion code was successfully set.

;401 Unauthorized
: The request was not properly authorized.

;404 Not Found
: Returned if the order or the product could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders-orderId-account-products:POST

2013-10-03T10:42:22Z

Stanimir.dimitrov: /* Parameters */

= POST /orders/''{orderId}''/account/products =
Adds a new Product to the Account's Order.

If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).

If there is already an Account in the order at the time this call is made, the currency of the specified product offering *must* match the currency of the Account.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products</code>

=== Request Parameters ===
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"promoCode": "{promoCode}"
}
</nowiki>

==== Parameters ====
; offering - ''string''
: Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
; promoCode - ''string''
: A promotion code for the new product [[Orders#Promotion_Codes|promotion codes]].

=== Validation Rules ===
:# The product specification URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}'' ) should point to an existing product.
:# The product offering currency should match the account currency.
:# The product offering URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}'' ) should point to an existing product offering.
:# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
:# The product offering should be valid according to the back-end.

== Response ==

=== Status Code ===
;201 Created
: The product was successfully added to the order.

;400 Bad Request
: The request body contains invalid JSON or the values do not adhere to the restrictions set for them.

;401 Unauthorized
: The ''OwnerId'' cookie was not specified or is incorrect.

;403 Forbidden
: The client does not have permissions to add products.

;404 Not Found
: An account has not been added to the given order or the order does not exist.

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added product.

=== Response Body ===
None.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders

2013-10-03T10:36:44Z

Stanimir.dimitrov: /* Ordering API */

= Ordering API =
The ordering API supports the operations of creating, building and placing orders.
The orders are the main method of creating new accounts and adding and managing the products for an account.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Orders ==
Order management resources.
* [[Orders:POST|POST /orders]] - Creates a new order
* [[Orders-orderId:GET|GET /orders/{orderId}]] - Returns order details
* [[Orders-orderId:DELETE|DELETE /orders/{orderId}]] - Deletes an order
* [[Orders-orderId-action:POST|POST /orders/{orderId}/action]] - Performs an action on an order

== Order Shorthand ==
An URL shortcut allowing the user to access the currently open order without specifying the order ID.
* [[Order Shorthand]]

== Account ==
Customer information in a given order. Only one account is allowed per order.
* [[Orders-orderId-account:PUT|PUT /orders/{orderId}/account]] - Add account to the order
* [[Orders-orderId-account:GET|GET /orders/{orderId}/account]] - Returns the account details

== Account Attributes ==
Custom attributes for an Account in a given Order.
* [[Orders-orderId-account-attributes:PUT|PUT /orders/{orderId}/account/attributes]] - Sets account attributes
* [[Orders-orderId-account-attributes:GET|GET /orders/{orderId}/account/attributes]] - Returns account attributes
* [[Orders-orderId-account-attributes:DELETE|DELETE /orders/{orderId}/account/attributes]] - Deletes all account attributes

== Account Contact Info ==
Various types of Contact Info set for an Account in a given Order.
* [[Orders-orderId-account-contactInfo-contactType:PUT|PUT /orders/{orderId}/account/contactInfo/{contactType}]] - Set contact details
* [[Orders-orderId-account-contactInfo-contactType:GET|GET /orders/{orderId}/account/contactInfo{contactType}]] - Returns contact details
* [[Orders-orderId-account-contactInfo:GET|GET /orders/{orderId}/account/contactInfo]] - Returns all account contacts
* [[Orders-orderId-account-contactInfo-contactType:DELETE|DELETE /orders/{orderId}/account/contactInfo/{contactType}]] - Deletes specific contact

== Account Payment Information ==
Payment method information for an Account in a given Order. An account cannot have multiple payment methods.
* [[Orders-orderId-account-paymentInfo:PUT|PUT /orders/{orderId}/account/paymentInfo]] - Sets the payment method for an account
* [[Orders-orderId-account-paymentInfo:GET|GET /orders/{orderId}/account/paymentInfo]] - Returns the payment method for an account

== Account User ==
User information for an Account in a given Order.
* [[Orders-orderId-account-user:PUT|PUT /orders/{orderId}/account/user]] - Sets the account user credentials
* [[Orders-orderId-account-user:GET|GET /orders/{orderId}/account/user]] - Returns information about account user credentials

== Products ==
Products included in the order.
* [[Orders-orderId-account-products:POST|POST /orders/{orderId}/account/products]] - Adds product to the account
* [[Orders-orderId-account-products:GET|GET /orders/{orderId}/account/products]] - Gets all products
* [[Orders-orderId-account-products-productId:GET|GET /orders/{orderId}/account/products/{productId}]] - Gets the product details
* [[Orders-orderId-account-products-productId:DELETE|DELETE /orders/{orderId}/account/products/{productId}]] - Removes product from the order

== Services ==
Services included in the products.
* [[Orders-orderId-account-products-productId-services:POST|POST /orders/{orderId}/account/products/{productId}/services]] - Adds service to a product
* [[Orders-orderId-account-products-productId-services:GET|GET /orders/{orderId}/account/products/{productId}/services]] - Gets all services for a product
* [[Orders-orderId-account-products-productId-services-serviceId:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}]] - Gets service details
* [[Orders-orderId-account-products-productId-services-serviceId:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}]] - Removes service from a product

== Service Attributes ==
Attributed for the included services.
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Adds service attributes
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Gets service attributes
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:OPTIONS|OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Returns information about supported attributes
* [[ServiceAttributesStructure|Service Attributes Structure]] - Structure of attributes set supported by Hostway API

== Promotion Codes ==
Describes handling of promotion codes.

=== Product Promotion Codes ===
* [[Orders-orderId-account-products-productId-promotion:PUT|PUT /orders/{orderId}/account/products/{productId}/promotion]] - Add or update promotion code for a product.
* [[Orders-orderId-account-products-productId-promotion:DELETE|DELETE /orders/{orderId}/account/products/{productId}/promotion]] - Removes the promotion code for a product.

== Custom Discounts ==
Custom discounts at the order, product and service levels. Managing discounts requires elevated permissions.

=== Order Discounts ===
* [[Orders-orderId-discounts:PUT|PUT /orders/{orderId}/discounts]] - Adds order discounts
* [[Orders-orderId-discounts:GET|GET /orders/{orderId}/discounts]] - Returns all order discounts
* [[Orders-orderId-discounts:DELETE|DELETE /orders/{orderId}/discounts]] - Removes all order discounts

=== Product Discounts ===
* [[Orders-orderId-account-products-productId-discounts:PUT|PUT /orders/{orderId}/account/products/{productId}/discounts]] - Adds product discounts
* [[Orders-orderId-account-products-productId-discounts:GET|GET /orders/{orderId}/account/products/{productId}/discounts]] - Returns all product discounts
* [[Orders-orderId-account-products-productId-discounts:DELETE|DELETE /orders/{orderId}/account/products/{productId}/discounts]] - Removes all product discounts

=== Service Discounts ===
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Adds service discounts
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Returns all service discounts
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Removes all service discounts

== Order Quote ==
Quote information for a given order.
* [[Orders-orderId-quote:GET|GET /orders/{orderId}/quote]] - Returns quote for the products and services in the order

== See also ==
* [[Common Features]]

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

Accounts-account-email-domain-usernames-mailboxName-cleanmailplus:GET

2013-09-27T12:06:22Z

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

= GET accounts/{account}/email/{domain}/usernames/{mailbox}/cleanmailplus =
Gets mailbox's CleanMailPlus info.

__TOC__

== Request ==
<code>GET accounts/{account}/email/{domain}/usernames/{mailbox}/cleanmailplus</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailbox - ''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 or mailbox does not exist.

=== Response Body ===
<nowiki>
[
{
"selected": "{selected_option_value}",
"fieldName": "{field_name}",
"description": "{description}",
"options": [
{
"name": "{option_name}",
"value": "{option_value}"
}
]
}
]
</nowiki>

==== Parameters ====
; selected_option_value - ''string''
: Currently selected option value.
; field_name - ''string''
: Field name.
; description - ''string''
: Descriptive option info.
; options - ''list''
: List of options.
; options.name - ''string''
: Option's name.
; options.value - ''string''
: Option's value.

== Examples ==
=== Failure getting CleanMailPlus info for a non-existent domain ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/non-existent-domain.com/usernames/test/cleanmailplus
</nowiki>

'''Response'''
<nowiki>
404 Not Found
</nowiki>

=== Success getting CleanMailPlus info ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames/test/cleanmailplus
</nowiki>

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

[
{
"selected": "6",
"fieldName": "SPAM_LEVEL",
"description": "SPAM Tag Level",
"options": [
{
"name": "Least Aggressive",
"value": "6"
},
{
"name": "Less Aggressive",
"value": "5"
},
{
"name": "Normal",
"value": "4"
},
{
"name": "More Aggressive",
"value": "3"
},
{
"name": "Most Aggressive",
"value": "2"
},
{
"name": "Ultra Aggressive",
"value": "1"
}
]
},
{
"selected": "2",
"fieldName": "SPAM_ACTION",
"description": "SPAM Detected Action",
"options": [
{
"name": "None",
"value": "0"
},
{
"name": "Tag Subject",
"value": "2"
},
{
"name": "Move to SPAM Folder",
"value": "1"
},
{
"name": "Delete",
"value": "3"
}
]
},
{
"selected": "1",
"fieldName": "ATTACHMENT_CONTROL",
"description": "Attachment Control",
"options": [
{
"name": "Enable",
"value": "1"
},
{
"name": "Disable",
"value": "0"
}
]
},
{
"selected": "2",
"fieldName": "VIRUS_ACTION",
"description": "Virus Detected Action",
"options": [
{
"name": "No Virus Filter",
"value": "0"
},
{
"name": "Delete Automatically",
"value": "1"
},
{
"name": "Quarantine Message",
"value": "2"
}
]
},
{
"selected": "0",
"fieldName": "SPAM_LEARNING",
"description": "SPAM Learning Status",
"options": []
},
{
"selected": "20",
"fieldName": "SPAM_DISCARD_LEVEL",
"description": "SPAM Discard Level",
"options": []
},
{
"selected": "0",
"fieldName": "PHISHING_CHECKS",
"description": "Phishing Checks",
"options": [
{
"name": "Enabled",
"value": "1"
},
{
"name": "Disabled",
"value": "0"
}
]
},
{
"selected": "0",
"fieldName": "CLEANMAIL_PLUS",
"description": "CleanMail Plus Enable",
"options": [
{
"name": "Enable",
"value": "1"
},
{
"name": "Disable",
"value": "0"
}
]
},
{
"selected": "1",
"fieldName": "SPAM_CHECK",
"description": "SPAM Check Option",
"options": [
{
"name": "Enable",
"value": "1"
},
{
"name": "Disable",
"value": "0"
}
]
}
]
</nowiki>

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

Email-domain-usernames-mailboxName-webmail:PUT

2013-09-27T12:05:49Z

Stanimir.dimitrov: moved Email-domain-usernames-mailbox-webmail:PUT to Email-domain-usernames-mailboxName-webmail:PUT

= PUT /email/{domain}/usernames/{mailboxName}/webmail =
Upgrades/downgrades OpenXchange account type.

__TOC__

== Request ==
<code>PUT /email/{domain}/usernames/{mailboxName}/webmail</code>

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

=== Request Headers ===
{{EmailApiAuthorization}}

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

=== Request Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== 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.
: If allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
: If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request''

== 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 empty type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": ""}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "Required"}
</nowiki>

=== Failure updating account type with invalid type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "invalid-type"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"invalid-type\" is not one of standard, activesync, premium"}
</nowiki>

=== Failure using inconsistent combination of allowUpgrade and type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium", "allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The allowUpgrade option is inconsistent with the provided type"}
</nowiki>

=== Failure changing the allowUpgrade option for activesync or premium accounts ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The account is already upgraded. Please downgrade it to standard first."}
</nowiki>

=== Failure when upgrading the account while allowUpgrade is set to false ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "This account is not allowed to be upgraded"}
</nowiki>

=== Success updating account type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-webmail:PUT

2013-09-27T12:05:38Z

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

= PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail =
Upgrades/downgrades OpenXchange account type.

__TOC__

== Request ==
<code>PUT /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>

=== Request Body ===
<nowiki>
{
"type": "{oxtype}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== 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.
: If allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
: If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request''

== 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'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": ""}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "Required"}
</nowiki>

=== Failure updating account type with invalid parameter ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "invalid-type"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"invalid-type\" is not one of standard, activesync, premium"}
</nowiki>

=== Failure using inconsistent combination of allowUpgrade and type ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "premium", "allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The allowUpgrade option is inconsistent with the provided type"}
</nowiki>

=== Failure changing the allowUpgrade option for activesync or premium accounts ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The account is already upgraded. Please downgrade it to standard first."}
</nowiki>

=== Failure when upgrading the account while allowUpgrade is set to false ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "This account is not allowed to be upgraded"}
</nowiki>

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

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

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

Email-domain-usernames-mailboxName-webmail:POST

2013-09-27T12:05:32Z

Stanimir.dimitrov: moved Email-domain-usernames-mailbox-webmail:POST to Email-domain-usernames-mailboxName-webmail:POST

= POST /email/{domain}/usernames/{mailboxName}/webmail =
Creates OpenXchange account.

__TOC__

== Request ==
<code>POST /email/{domain}/usernames/{mailboxName}/webmail</code>

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

=== Request Headers ===
{{EmailApiAuthorization}}

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

=== Request Body ===
<nowiki>
{
"type": "{oxtype}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value. The default value is true.
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.

== Response ==

=== Status Code ===
; 201 Created
: Success

; 400 Bad Request
: The format of the request body is invalid or the OpenXchange account type does not meet the requirements.

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

; 409 Conflict
: OpenXchange account already exists.

; 404 Not Found
: The domain name or mailbox do not exist.

== Examples ==

=== Failure creating account with not-valid parameter ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "non-valid"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"non-existing\" is not one of standard, activesync, premium"}
</nowiki>

=== Success creating account ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "activesync", "allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-webmail:POST

2013-09-27T12:05:25Z

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

= POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail =
Creates OpenXchange account.

__TOC__

== Request ==
<code>POST /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>

=== Request Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value. The default value is true.
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.

== Response ==

=== Status Code ===
; 201 Created
: Success

; 400 Bad Request
: The format of the request body is invalid or the OpenXchange account type does not meet the requirements.

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

; 409 Conflict
: OpenXchange account already exists.

; 404 Not Found
: The domain name or mailbox do not exist.

== Examples ==

=== Failure creating account with not-valid parameter ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "non-valid"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"non-existing\" is not one of standard, activesync, premium"}
</nowiki>

=== Success creating account ===
'''Request'''
<nowiki>
POST /accounts/test/email/test.com/usernames/john.smith/webmail

{"type": "standard", "allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

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

Email-domain-usernames-mailboxName-webmail:GET

2013-09-27T12:05:20Z

Stanimir.dimitrov: moved Email-domain-usernames-mailbox-webmail:GET to Email-domain-usernames-mailboxName-webmail:GET

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

__TOC__

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

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

=== Request Headers ===
{{EmailApiAuthorization}}

; 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},
"links": [
{
"location": "{APIBaseURL}/email/{domain}/usernames/{mailboxName}/webmail/",
"rel": "self"
}
]
}
</nowiki>

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

== Examples ==

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

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

{"type": "standard", "allowUpgrade": true, "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}
</nowiki>

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

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

2013-09-27T12:05:14Z

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

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

Accounts-account-email-domain-usernames-mailboxName-migration:POST

2013-09-27T12:02:56Z

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-migration:POST to Accounts-account-email-domain-usernames-mailboxName-migration:POST

= POST accounts/{account}/email/{domain}/usernames/{mailboxName}/migration =
Creates a support ticket for failed mailbox migration
__TOC__

== Request ==
<code>POST accounts/{account}/email/{domain}/usernames/{mailboxName}/migration</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>

=== Request Body ===
<nowiki>
{
"subject": "{subject}",
"body": "{body}"
}
</nowiki>

==== Parameters ====
; subject - ''string''
: Subject of the support ticket

; body - ''string''
: Body of the support ticket

== Response ==

=== Status Code ===
; 201 Created
: 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 ==

=== Success creating a support ticket ===
'''Request'''
<nowiki>
POST accounts/test-account123/email/test.com/usernames/john.smith/migration

{
"subject": "subject"
"body": "body",
}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

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

Accounts-account-email-domain-usernames-mailboxName-forwards-fwdmailbox:DELETE

2013-09-27T12:02:49Z

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-forwards-fwdmailbox:DELETE to Accounts-account-email-domain-usernames-mailboxName-forwards-fwdmailbox:DELETE

= DELETE accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/{fwd-mailbox} =
Deletes forwarding for specified mailbox,domain and account.

__TOC__

== Request ==
<code>DELETE accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/{fwd-mailbox}</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailbox - ''string''
:
; fwd-mailbox - ''string''
: Target mailbox forwarding to be deleted.

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

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

== Response ==

=== Status Code ===
; 204 No Content
: 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.

== Examples ==

=== Sucess deleting mailbox forwarding ===
'''Request'''
<nowiki>
DELETE accounts/{account}/email/test.com/usernames/test/forwards/test-fwd-mailbox
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Email API|Email API]]

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

Accounts-account-email-domain-usernames-mailboxName-forwards:GET

2013-09-27T12:02:21Z

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

= GET accounts/{account}/email/{domain}/usernames/{mailbox}/forwards=
Gets forwarding for specified mailbox,domain and account.

__TOC__

== Request ==
<code>GET accounts/{account}/email/{domain}/usernames/{mailbox}/forwards</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailbox - ''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>
{
"targets": [
{
"target":"{target_mailbox}"
},
{
"target":"{target_mailbox}"
}
],
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; target_mailbox - ''string''
: The returned forward target mailbox.

== Examples ==

=== Sucess getting forwarding info ===
'''Request'''
<nowiki>
GET accounts/{account}/email/test.com/usernames/test/forwards
</nowiki>

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

<nowiki>
{
"targets": [
{
"target":"mb1@test.com"
},
{
"target":"test@test-forward.com"
}
],
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/",
"rel": "self"
}
]
}
</nowiki>
</nowiki>

== See also ==
* [[Email API|Email API]]

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

Accounts-account-email-domain-usernames-mailboxName-autoresponder:GET

2013-09-27T12:01:54Z

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

= GET accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder =
Gets the autoresponder info.

__TOC__

== Request ==
<code>GET accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailbox - ''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>
{
"autoresponder": {
"body": "{body}",
"active": {active},
"subject": "{subject}"
},
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; body - ''string''
: The body of auto-responder.

; active - ''boolean''
: The status of auto-responder.

; subject- ''string''
: The subject of auto-responder.

== Examples ==

=== Success getting the autoresponder info ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames/test/autoresponder
</nowiki>

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

{
"body": "AutoRespond",
"active": true,
"links": [
{
"href": "http://coreapi01.ote.chicago.hostway:8095/accounts/test-account123/email/test.com/usernames/test/autoresponder",
"rel": "self"
}
],
"subject": "Subject"
}
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT

2013-09-27T12:01:00Z

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-autoresponder:PUT to Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT

= PUT accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder =
Activates/deactivates the autoresponder for specified mailbox,domain and account.

__TOC__

== Request ==
<code>PUT accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder</code>

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

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

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

=== Request Body ===
<nowiki>
{
"subject": "{subject}",
"body": "{body}",
"active": {active}
}
</nowiki>

==== Parameters ====
; subject - ''string''
: The subject of auto-responder.

; body - ''string''
: The body of auto-responder. Required.

; active - ''boolean''
: Sets the status of auto-responder. Required.

== 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 setting the autoresponder with missing required parameter ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"subject": "Subject", "active": true}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"body":"Required"}
</nowiki>

=== Success setting the auto-responder ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"subject": "Subject", "body": "AutoRespond", "active": true}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Success deactivating the auto-responder ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"body": "AutoRespond", "active": false}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-mailbox:GET

2013-09-27T12:00:31Z

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

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox =
Get mailbox details.

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox</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>
{
"username": "{username}",
"master": {master},
"quota": {quota},
"usage": {usage},
"authToken": {authToken},
"links": [
{
"location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/",
"rel": "self"
}
]
"sitemail_urls":
[
{
"url": "http://sitemaildev7.test",
"version": "7"
},
{
"url": "http://sitemaildev8.test",
"version": "8"
}
]
}
</nowiki>

==== Parameters ====
; username - ''string''
: The mailbox username.

; authToken - ''string''
: Authorization string for logging into OpenXchange
: Returned only if long URL, starting with "/accounts" is used

; master - ''boolean''
: Describes if this is a master account.

; quota - ''integer''
: Mailbox quota in MB.

; usage - ''integer''
: Mailbox usage in MB.

; sitemail_urls - ''list''
: List containing maps of SiteMail URLs and their versions

== Examples ==

=== Success getting mailbox details ===
'''Request'''
<nowiki>
GET /accounts/test-account123/email/test.com/usernames/john.smith/mailbox
</nowiki>

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

{
"username": "test",
"authToken": "NGA8mH65N63ZpakAIYCWZodYRRbsOQ/Uj9TcnWWWaUYuHZliHZbmT2eDFQW2zV71PYmmMhUKlTx/5UMYkG4hv2ycGb0p7C2i4U8Vh1mK4/OrQQjQHLej27zfTMR+FB9FsSDGjcEUi6psAGdPa4EBSCWoaVE9B0M3",
"master": true,
"quota": 10,
"usage": 10,
"links": [
{
"href": "{APIBaseURL}/accounts/test-account123/email/test.com/usernames/john.smith/mailbox/", "rel": "self"
}
]
"sitemail_urls":[
{
"url": "http://sitemaildev7.test",
"version": "7"
},
{
"url": "http://sitemaildev8.test",
"version": "8"
}
]
}
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT

2013-09-27T10:56:13Z

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames:POST to Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT

= PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox =
Creates a mailbox for specified account and domain
__TOC__

== Request ==
<code>PUT accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailboxName - ''string''
: The mailbox. String should meet the regexp [a-zA-Z0-9._-]+

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

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

=== Request Body ===
<nowiki>
{
"password": "{password}",
"master": {master}
}
</nowiki>

==== Parameters ====
; password - ''string''
: The password. Required. The password should contain at least one letter and at least one digit. It should be at least 8 characters long. It should also not begin with "pass", and should not contain the second-level domain name of the service or the username of the mailbox.

; master - ''boolean''
: Describes if this is a master account.

== Response ==

=== Status Code ===
; 201 Created
: 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 ==

=== Trying to create mailbox without a password ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"master": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"password":"Required"}
</nowiki>

=== Create mailbox ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/john.smith/mailbox

{"password": "pword1234", "master": true}
</nowiki>

'''Response'''
<nowiki>
201 Created
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

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

Accounts-account-email-domain-usernames:GET

2013-09-27T10:50:12Z

Stanimir.dimitrov: /* GET /accounts/{account}/email/{domain}/mailboxes */

= GET /accounts/{account}/email/{domain}/usernames =
Retrieves a list of mailboxes for a specific account and domain
__TOC__

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

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the mailboxes
; domain - ''string''
: The specific domain for which the call will retrieve the list

=== URI Parameters ===

; filterUsername - ''string''
: Only mailboxes with username matching the value of the parameter will be returned. The values used could be specified as a partial match with a wildcard(*).

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed values are '''username''' and '''quota'''

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''

; details - ''integer''
: If set to '''1''' the type of mailbox users will be displayed for each mailbox

== 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 or account does not exist.

=== Response Body ===
<nowiki>
{
"list": [
{
"username": "{username}",
"master": {master},
"quota": {quota},
"webmailAccess": "{webmailAccess}",
"trialType": "{trialType}",
"trialExpiration": "{trialExpiration}"
}
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; username - ''string''
: The username of an individual mailbox

; master - ''integer''
: Allowed values are '''0''' or '''1'''

; quota - ''integer''
: The quota of the mailbox in Megabytes

; webmailAccess - ''string''
: (OPTIONAL)
: The type of webmail of the mailbox. Allowed values are '''standard''', '''activesync''' and '''premium'''. Will only be displayed if the user passed the details URI parameter

; trialType - ''string'' - one of "standard", "activesync" or "premium"
: Trial account type set for a given period of time. Values are standard, activesync, premium.

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

; href - ''string''
: Link to other resources relevant to the mailboxes lists

; rel - ''string''
: Type of relation to the resource for the provided link

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test",
"master": 1,
"quota": 10,
"trialType": "premium",
"trialExpiration": "2018-10-28"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/",
"rel": "self"
}
]
}
</nowiki>

=== Request with webmailAccess ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?details=1
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test",
"master": 1,
"quota": 10,
"webmailAccess": "standard"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/",
"rel": "self"
}
]
}
</nowiki>

=== Paginated request ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?page=2&pageSize=2
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test1",
"master": 1,
"quota": 10
},
{
"username": "test2",
"master": 1,
"quota": 15
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=2&pageSize=2",
"rel": "self"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "first"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "last"
}
]
}
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

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

Orders-orderId-account-products:POST

2013-09-26T14:34:28Z

Stanimir.dimitrov: /* Request Parameters */

= POST /orders/''{orderId}''/account/products =
Adds a new Product to the Account's Order.

If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).

If there is already an Account in the order at the time this call is made, the currency of the specified product offering *must* match the currency of the Account.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products</code>

=== Request Parameters ===
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}"
}
</nowiki>

==== Parameters ====
; offering - ''string''
: Link to the [[Products|product catalog offering]] specifying the new product.

=== Validation Rules ===
:# The product specification URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}'' ) should point to an existing product.
:# The product offering currency should match the account currency.
:# The product offering URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}'' ) should point to an existing product offering.
:# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
:# The product offering should be valid according to the back-end.

== Response ==

=== Status Code ===
;201 Created
: The product was successfully added to the order.

;400 Bad Request
: The request body contains invalid JSON or the values do not adhere to the restrictions set for them.

;401 Unauthorized
: The ''OwnerId'' cookie was not specified or is incorrect.

;403 Forbidden
: The client does not have permissions to add products.

;404 Not Found
: An account has not been added to the given order or the order does not exist.

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added product.

=== Response Body ===
None.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders-orderId-account-products-productId-services:POST

2013-09-26T14:34:06Z

Stanimir.dimitrov: /* Request Parameters */

= POST /orders/''{orderId}''/account/products/''{productId}''/services =
Adds a new service to a product in the order.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products/''{productId}''/services</code>

=== Request Parameters ===
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"name": "john.smith1",
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": {
"{attribute-name}": "{attribute-value}",
....
}
}
</nowiki>

==== Parameters ====
; name - ''string''
: The name of the new service

; relatedTo - ''list''
: ''(OPTIONAL)''
: A list containing other services related in some way to the newly created service. The relatedTo may be omitted, but relationships between some types of services have to be established for the order to be validated or submitted.

; serviceSpecification - ''string''
: Link to the [[Products|product catalog specification]] describing the new service

; billingCycle - ''integer''
: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

; attributes - ''dictionary''
: ''(OPTIONAL)''
: a dictionary of the new service's attributes values. Each (''attribute-name'', ''attribute-value'') pair present the service attribute name and its relevant value to be set. The allowed attribute names depends on the ''serviceSpecification'' field value. See [[ServiceAttributesStructure | Service Attributes Structure]].

=== Validation Rules ===
:# The service specification URL ( ''{{APIBaseURL}}/serviceSpecifications/{serviceSpecificationId}'' ) should point to an existing service.
:# Each service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) from the related services list should point to a valid service already added to the product.
:# The service billing cycle should be allowed for the product.
:# The product should support adding the service.

== Response ==

=== Status Code ===
;201 Created
: The product was successfully added to the order.

;400 Bad Request
: The request body contains invalid JSON or the values do not adhere to the restrictions set for them.

;401 Unauthorized
: The ''OwnerId'' cookie was not specified or is incorrect.

;403 Forbidden
: The client does not have permissions to add services.

;404 Not Found
: An account has not been added to the given order or the order does not exist.

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added service.

=== Response Body ===
None.

== Examples ==

=== Create a service with attributes ===
'''Request'''
<nowiki>
{
"name": "ng-test-hwus-test.com",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.dedserver",
"billingCycle": 1,
"attributes": {
"serverName": "sampleServerName",
"serverLocation": "Tampa"
}
}
</nowiki>

'''Response'''
<nowiki>
{
"url": "</nowiki>{{APIBaseURL}}<nowiki>/order/account/products/00000140728b013c52e249a4007f000000010001/services/00000140735d43640f62c50f007f000000010001/"
}
</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

Orders-orderId-account-products-productId-services-serviceId-attributes:PUT

2013-09-26T14:33:53Z

Stanimir.dimitrov: /* Request Parameters */

= PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/attributes =
Adds Attributes to the Service.
Not all services support this call. Depending on the service, this call ''may'' return a response code of 405 (method not supported).
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/attributes</code>

=== Request Parameters ===
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
A dictionary whose keys/values will depend on the service category of the service. See [[ServiceAttributesStructure | Service Attributes Structure]].
<nowiki>
{
"key_one": "Value One",
"key_two": "Value Two",
...
}
</nowiki>

=== Validation Rules ===
:# The service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) should point to a valid service already added to the product.
:# The attribute key/value pair should be allowed for the service specification.

== Response ==

=== Status Code ===
;200 OK
: The attributes were successfully set.

;400 Bad Request
: The request body contains invalid JSON or the values do not adhere to the restrictions set for them.

;401 Unauthorized
: The ''OwnerId'' cookie was not specified or is incorrect.

;403 Forbidden
: The client does not have permissions to add services.

;404 Not Found
: An account has not been added to the given order or the order does not exist.

;405 Method Not Allowed
: The service does not support attributes.

=== Response Body ===
None.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

Orders-orderId-account-products-productId-services-serviceId-discounts:PUT

2013-09-26T12:11:08Z

Stanimir.dimitrov: /* Parameters */

= PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts =
Set discounts for the specified service. '''Note: This will replace any existing discounts that were configured for the specified service.'''
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/discounts</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product for which actions are to be performed

; serviceId - ''string''
: UUID specifying the service for which actions are to be performed

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": "1.00"
}
]
}
</nowiki>

==== Parameters ====
; discounts - ''list''
: A list of discounts. Each discount contains the following:

:; priceName - ''string''
:: The type of price to which the discount will be applied.
:: Validation: Should match the fee types configured in the back-end (eg. 'recurring').

:; recurrences - ''integer''
:: The number of times that the discount will be applied. A value of "-1" means the discount will be applied every time the fee is charged.
:: Validation: Should be either a positive integer or -1.
:: Note: Value must be -1 if the priceName is "recurring".

:; type - ''string''
:: Specifies the discount type which determines the method used to calculate the amount that is discounted. Possible values are:
::: '''amount''': Discount will be treated as an exact amount
::: '''percent''': Discount will be treated as a percentage
:: Validation: Should be set to either '''amount''' or '''percent'''.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.
:: Validation: Should be a positive number.

== Response ==

=== Status Code ===
;200 OK
: The discount was successfully set.

;401 Unauthorized
: The request was not properly authorized.

;403 Forbidden
: The client does not have sufficient privileges.

;404 Not Found
: Returned if the order could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders-orderId-account-products-productId-discounts:PUT

2013-09-26T12:10:48Z

Stanimir.dimitrov: /* Parameters */

= PUT /orders/{orderId}/account/products/{productId}/discounts =
Set discounts for a Product in an Order. Discounts will be applied only to the specified product.
'''Note: This will replace any existing discounts that were configured for the specified product.'''
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/products/{productId}/discounts</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product for which actions are to be performed

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": "1.00"
}
]
}
</nowiki>

==== Parameters ====
; discounts - ''list''
: A list of discounts. Each discount contains the following:

:; priceName - ''string''
:: The type of price to which the discount will be applied.
:: Validation: Should match the fee types configured in the back-end (eg. 'recurring').

:; recurrences - ''integer''
:: The number of times that the discount will be applied. A value of "-1" means the discount will be applied every time the fee is charged.
:: Validation: Should be either a positive integer or -1.
:: Note: Value must be -1 if the priceName is "recurring".

:; type - ''string''
:: Specifies the discount type which determines the method used to calculate the amount that is discounted. Possible values are:
::: '''amount''': Discount will be treated as an exact amount
::: '''percent''': Discount will be treated as a percentage
:: Validation: Should be set to either '''amount''' or '''percent'''.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.
:: Validation: Should be a positive number.

== Response ==

=== Status Code ===
;200 OK
: The discount was successfully set.

;400 Bad Request
: Returned if discount data is invalid.

;401 Unauthorized
: The request was not properly authorized.

;403 Forbidden
: The client does not have sufficient privileges.

;404 Not Found
: Returned if the order could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Orders-orderId-discounts:PUT

2013-09-26T12:06:12Z

Stanimir.dimitrov: /* Parameters */

= PUT /orders/''{orderId}''/discounts =
Set discounts for the entire Order. Discounts that are applied to an entire order will be applied to all of the product and services within the order.
'''Note: This will replace any existing discounts that were configured at the order level.'''
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/discounts</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": "1.00"
}
]
}
</nowiki>

==== Parameters ====
; discounts - ''list''
: A list of discounts. Each discount contains the following:

:; priceName - ''string''
:: The type of price to which the discount will be applied.
:: Validation: Should match the fee types configured in the back-end.
:: Note: Only "recurring" is currently supported

:; recurrences - ''integer''
:: The number of times that the discount will be applied. A value of "-1" means the discount will be applied every time the fee is charged.
:: Validation: Should be either a positive integer or -1.
:: Note: Value must be -1 if the priceName is "recurring".

:; type - ''string''
:: Specifies the discount type which determines the method used to calculate the amount that is discounted. Possible values are:
::: '''amount''': Discount will be treated as an exact amount
::: '''percent''': Discount will be treated as a percentage
:: Validation: Should be set to either '''amount''' or '''percent'''.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.
:: Validation: Should be a positive number.

== Response ==

=== Status Code ===
;200 OK
: The discount was successfully set.

;400 BadRequest
: The request body contains invalid parameters

;401 Unauthorized
: The request was not properly authorized.

;403 Forbidden
: The client does not have sufficient privileges.

;404 Not Found
: Returned if the order could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Accounts-account-email-domain-webmail:GET

2013-06-14T14:06:23Z

Stanimir.dimitrov:

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