Hostway API Documentation - User contributions [en]

Accounts-account-email-domain-cleanmailplus:GET

2015-07-08T14:08:26Z

Velimira.metodieva: /* Success getting CleanMailPlus info */

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

__TOC__

== Request ==
<code>GET accounts/{account}/email/{domain}/cleanmailplus</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>
[
{
"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/cleanmailplus
</nowiki>

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

=== Success getting CleanMailPlus info ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/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": "1",
"fieldName": "VIRUS_ACTION",
"description": "Virus Detected Action",
"options": [
{
"name": "No Virus Filter",
"value": "0"
},
{
"name": "Delete Automatically",
"value": "1"
}
]
},
{
"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]]

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

2015-07-08T14:08:02Z

Velimira.metodieva: /* GET accounts/{account}/email/{domain}/usernames/{mailbox}/cleanmailplus */

= 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": "1",
"fieldName": "VIRUS_ACTION",
"description": "Virus Detected Action",
"options": [
{
"name": "No Virus Filter",
"value": "0"
},
{
"name": "Delete Automatically",
"value": "1"
}
]
},
{
"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]]

AssignSecurityGroupToServer

2015-05-28T11:37:32Z

Velimira.metodieva: /* PUT /accounts/{accountId}/flexcloud/servers/{id}/os-security-group */

This operation will assign a securityGroup to the specified server

='''PUT''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/os-security-group=

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

; id
: The unique identifier of the server.

== Request==
=== JSON ===
<nowiki>
{
"securityGroup" : {
"id": "{security_group_id}",
"status": "{status}"
}
}</nowiki>

; securityGroup.id - ''string''
: The unique name of the securityGroup.

; status - ''string''
: Status. Only enabled is supported currently

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''
; Failure:
: ''HTTP/1.1 400 Bad Request''
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

== Examples ==
'''Successfully assign a securityGroup to the specified server'''
:'''PUT''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/os-security-group

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroup" : {
"id": "group2012Nov02_jD6NX8BsK"
"status": "enabled"
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : {
"id": "2012May08_61EfdIZ3Y"
"links": [{"href": "http://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012Nov02_jD6NX8BsK/", "rel": "self"}]
}
}</nowiki>

'''Failure while trying to assign a firewall group to server'''
:'''PUT''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/os-security-group

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

<nowiki>
{
"securityGroup" : {
"id": "not_exist",
"status": "enabled"
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-group-rules:POST

2015-05-26T13:58:20Z

Velimira.metodieva: /* securityGroupRule */

This operation will create a new firewall group rule.

='''POST''' /accounts/''{accountId}''/os-security-group-rules=
This operation will create a new firewall group rule.

== Request ==
=== Parameters ===
; accountId - ''string''
: The selected account Id.

=== JSON ===
<nowiki>
{
"securityGroupRule" : {
"fromPort": {start_port},
"toPort": {end_port},
"protocol": "{ip_protocol}",
"cidr": "127.0.0.1/24",
"parentGroupId": "{parent_group_id}",
"action": "{action}",
"priority": {priority}
}
}</nowiki>

====securityGroupRule====
; fromPort - ''int''
: Start port number.

; toPort - ''int''
: End port number.

; protocol - ''string''
: IP protocol used. Can be TCP, UDP, AH, ESP, GRE, AH+ESP, or ALL
: AH, ESP, GRE, AH+ESP, ALL protocols don't support port - both should be 0

; cidr - ''string''
: CIDR notation IP address.

; parentGroupId - ''string''
: Parent group identifier for this rule.

; action = ''string''
: rule target action. One of ACCEPT, REJECT or DROP

; priority = ''integer''
: rule priority, starting from 0 lowest priority

== Response ==
=== JSON ===
<nowiki>
{
"securityGroupRule" : {
"fromPort": {start_port},
"protocol": "{ip_protocol}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/{firewall_group_rule_id}/",
"rel": "self"
}
],
"toPort": {end_port},
"parentGroupId": "{parent_firewall_group_name}",
"cidr": "127.0.0.1/24"
"id": {firewall_group_rule_id}
}
}
</nowiki>

====securityGroupRule====
; fromPort - ''int''
: Start port number.

; protocol - ''string''
: IP protocol used.

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

; toPort - ''int''
: End port number.

; parentGroupId - ''string''
: Parent group identifier for this rule.

; cidr - ''string''
: IP range in CIDR notation.

; id - ''string''
: Firewall group rule unique identifier.

== Response Codes ==
; Success
: ''HTTP/1.1 201 Created''

; Failure
: ''HTTP/1.1 400 Bad Request''
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==
'''Successfully create a new firewall group rule'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"security_group_rule" : {
"from_port": 80,
"to_port": 80,
"ip_protocol": "tcp",
"cidr": "127.0.0.1/24",
"parent_group_id": "group2012May11_NpCpS3995",
"action": "ACCEPT",
"priority": 1
}
} </nowiki>

''Response Code:''
<pre>HTTP/1.1 201 Created</pre>

''Response Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"protocol": "tcp",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/214/",
"rel": "self"
}
],
"toPort": 80,
"parentGroupId": "group2012May11_NpCpS3995",
"cidr": "127.0.0.1/24",
"id": 214
}
} </nowiki>

'''Successfully create a new firewall group rule with an IP without a netmask'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "TCP",
"cidr": "127.0.0.1",
"parentGroupId": "group2012May11_NpCpS3995"
}
} </nowiki>

''Response Code:''
<pre>HTTP/1.1 201 Created</pre>

''Response Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": 80,
"protocol": "tcp",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-group-rules/215/",
"rel": "self"
}
],
"toPort": 80,
"parentGroupId": "group2012May11_NpCpS3995",
"cidr": "127.0.0.1/32",
"id": 215
}
} </nowiki>

'''Failure while trying to create a new firewall group rule with invalid data'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
Empty
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "Invalid",
"code": 400,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new rule with invalid from and to ports'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
<nowiki>
{
"securityGroupRule" : {
"fromPort": </nowiki>81<nowiki>,
"toPort": </nowiki>80<nowiki>,
"protocol": "tcp",
"cidr": "127.0.0.1/24",
"parentGroupId": "group2012May11_NpCpS3995"
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "FirewallRuleError",
"code": 400,
"details": "Invalid ports",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new rule rule with an invalid protocol'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "proto",
"cidr": "127.0.0.1/24",
"parentGroupId": "group2012May11_NpCpS3995"
}
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "Invalid",
"code": 400,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to create a new firewall rule with an invalid IP address'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/os-security-group-rules

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"securityGroupRule" : {
"fromPort": 80,
"toPort": 80,
"protocol": "tcp",
"cidr": "ip_address",
"parentGroupId": "group2012May11_NpCpS3995"
}
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest" : {
"message": "FirewallRuleError",
"code": 400,
"details": "Source IP address is invalid",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''POST''' http(s)://{api_server}/accounts/fakeId/os-security-groups

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /accounts/os-security-group-rules ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>POST /accounts/os-security-group-rules</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

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

2015-05-04T15:12:06Z

Velimira.metodieva: /* Parameters */

= GET /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/?getTargetServiceSpecifications=1 =
Get allowed PTC changes
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/?getTargetServiceSpecifications=1</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",
"displayName": "service-related-domain.com",
"billingCycle": 12,
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId}",
"rel": "self"
},
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/{detailsLink}",
"rel": "manage"
}
],
"changes": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"type": "{type}",
"name": "Target Service Name",
"billingCycle": 1
}
]
}
</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.

; displayName - ''string''
: Domain name for the service if any exists.

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

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

; type - ''string''
: Type of service change. Might be upgrade, downgrade

; links - ''list''
: ''self'' - [[Hypermedia]] for the service resource
: ''manage'' - [[Hypermedia]] for some service types. ''detailsLink'' format is:
:: for Domain type: ''domains/{domainName}/details''. Please see: [[Domains-domainName-details:GET]]
:: for Email type: ''accounts/{accountId}/email/{domainName}''. Please see: [[Accounts-account-email-domain:GET]]
:: for Exchange type: ''accounts/{accountId}/exchange/{domainName}/mailboxes''. Please see: [[GET Exchange Mailboxes list]]
:: for Dedicated Server type: ''accounts/{accountId}/dedicatedServers/{serverId}''. Please see: [[Accounts-account-dedicatedServers-server:GET]]

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

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

Accounts-accountNumber-web-domainName-php:PUT

2015-04-20T14:24:08Z

Velimira.metodieva: /* Examples */

= PUT /accounts/{accountNumber}/web/{domainName}/php =
Adds PHP feature to a domain.

__TOC__

== Request ==
<code>PUT /accounts/{accountNumber}/web/{domainName}/php</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name belongs

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

=== Request Body ===
<nowiki>
{}
</nowiki>

== Response ==
=== Status Code ===
; 202 Accepted
: Success

; 400 Bad Request
: The format of the request body is invalid.

; 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
: The feature already exists(on create) or domain is disabled(on update).

== Examples ==

=== Try to add PHP feature to a not existing domain ===
'''Request'''
<nowiki>
PUT /accounts/test-account/email/test.com/php
</nowiki>

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

{"itemNotFound": {"guid": "", "message": "Resource not found", "code": 404, "details": ""}}

</nowiki>

=== Successfully adding PHP feature ===
'''Request'''
<nowiki>
PUT /accounts/test-account/email/test.com/php
</nowiki>

'''Response'''
<nowiki>
202 Accepted

{
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/php/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/action/", "rel": "submit"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/quote/", "rel": "quote"}]
}
</nowiki>

'''Request'''
<nowiki>
POST /orders/123/action

{"action": "submit"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

=== ===

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

Accounts-accountNumber-web-domainName-error404:PUT

2015-04-20T14:22:35Z

Velimira.metodieva: /* Examples */

= PUT /accounts/{accountNumber}/web/{domainName}/error404 =
Adds/updates error page for a domain.

__TOC__

== Request ==
<code>PUT /accounts/{accountNumber}/web/{domainName}/error404</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name belongs

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

=== Request Body ===
<nowiki>
{
"pageContent": "{pageContent}"
}
</nowiki>

==== Parameters ====
; pageContent - ''string''
: MD5-ed content of error page. Required.

== Response ==
=== Status Code ===
; 202 Accepted
: Success

; 400 Bad Request
: The format of the request body is invalid.

; 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
: The error page already exists(on create) or domain is disabled(on update).

== Examples ==

=== Try to add error page to a not existing domain ===
'''Request'''
<nowiki>
PUT /accounts/test-account/email/test.com/error404

{"pageContent": "PGh0bWw+PGhlYWQ+PHRpdGxlPlRlc3QgZXJyb3IgNDA0IHBhZ2UgdGl0bGU8L3RpdGxlPjwvaGVhZD48Ym9keT5UZXN0IGVycm9yIDQwNCBwYWdlIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg=="}
</nowiki>

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

{"itemNotFound": {"guid": "", "message": "Resource not found", "code": 404, "details": ""}}

</nowiki>

=== Successfully adding error page ===
'''Request'''
<nowiki>
PUT /accounts/test-account/email/test.com/error404

{"pageContent": "PGh0bWw+PGhlYWQ+PHRpdGxlPlRlc3QgZXJyb3IgNDA0IHBhZ2UgdGl0bGU8L3RpdGxlPjwvaGVhZD48Ym9keT5UZXN0IGVycm9yIDQwNCBwYWdlIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg=="}
</nowiki>

'''Response'''
<nowiki>
202 Accepted

{
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/error404/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/action/", "rel": "submit"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/quote/", "rel": "quote"}]
}
</nowiki>

'''Request'''
<nowiki>
POST /orders/123/action

{"action": "submit"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

=== ===

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

Accounts-accountNumber-web-domainName-error404:GET

2015-04-20T14:01:49Z

Velimira.metodieva: /* Examples */

= GET /accounts/{accountNumber}/web/{domainName}/error404 =
Gets error page content and status

__TOC__

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

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the error page belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

== Response ==
=== Response Body ===
<nowiki>
{
"status": "{status}",
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/error404/", "rel": "self"}]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Status of the page.

; links - ''list''
: [[Hypermedia|Hypermedia]] for this resource

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

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

== Examples ==

=== Check if error page is set for a domain ===
'''Request'''
<nowiki>
GET /accounts/{account}/email/test.com/error404
</nowiki>

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

{
"status": "open",
"links": links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/error404/", "rel": "self"}]
}

</nowiki>

=== Try to get error page for a not existing domain ===
'''Request'''
<nowiki>
GET /accounts/{account}/email/test.com/error404
</nowiki>

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

{"itemNotFound": {"guid": "", "message": "Resource not found", "code": 404, "details": ""}}

</nowiki>
=== ===

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

Accounts-accountNumber-web-domainName-php:GET

2015-04-20T13:53:42Z

Velimira.metodieva: /* Check if PHP feature is enabled for a domain */

= GET /accounts/{accountNumber}/web/{domainName}/php =
Checks if PHP feature is enabled for a domain

__TOC__

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

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the PHP feature belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

== Response ==
=== Response Body ===
<nowiki>
{
"status": "{status}",
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/php/", "rel": "self"}]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Status of the page.

; links - ''list''
: [[Hypermedia|Hypermedia]] for this resource

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

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

== Examples ==

=== Check if PHP feature is enabled for a domain ===
'''Request'''
<nowiki>
GET /accounts/test-account/email/test.com/php
</nowiki>

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

{
"status": "active",
"links": links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/php/", "rel": "self"}]
}

</nowiki>

=== Try to check PHP feature for not existing domain ===
'''Request'''
<nowiki>
GET /accounts/test-account/email/test.com/php
</nowiki>

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

{"itemNotFound": {"guid": "", "message": "Resource not found", "code": 404, "details": ""}}

</nowiki>

=== ===

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

Accounts-accountNumber-web-domainName-subdomains:POST

2015-04-20T13:51:12Z

Velimira.metodieva: /* POST /accounts/{accountNumber}/web/{domainName}/subdomains */

= POST /accounts/{accountNumber}/web/{domainName}/subdomains =
Creates subdomain.

__TOC__

== Request ==
<code>POST /accounts/{accountNumber}/web/{domainName}/subdomains</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the subdomain belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

=== Request Body ===
<nowiki>
{
"subdomain": "{subdomain}"
}
</nowiki>

==== Parameters ====
; subdomain - ''string''
: A valid subdomain. Required.

== Response ==

=== Status Code ===
; 202 Accepted
: Success

; 400 Bad Request
: The format of the request body is invalid or the subdomain 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
: The sub domain already exists(on create) or domain is disabled(on update).

== Examples ==

=== Failure creating a subdomain when required parameter is missing ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

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

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

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"subdomain": "Required"}}}

</nowiki>

=== Failure creating a subdomain when passing invalid parameter ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

{"subdomain": "subtest4-subtest4-subtest4-subtest4-subtest4-subtest4-subtest4ab"}
</nowiki>

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

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"subdomain": "Invalid subdomain name: subtest4-subtest4-subtest4-subtest4-subtest4-subtest4-subtest4ab"}}}

</nowiki>

=== Successfully creating a subdomain ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

{"subdomain": "sub"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted

{
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.dom/subdomains/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/action/", "rel": "submit"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/quote/", "rel": "quote"}]
}
</nowiki>

'''Request'''
<nowiki>
POST /orders/123/action

{"action": "submit"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

=== ===

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

Accounts-accountNumber-web-domainName-php:DELETE

2015-04-20T13:46:43Z

Velimira.metodieva: /* DELETE /accounts/{accountNumber}/web/{domainName}/php */

= DELETE /accounts/{accountNumber}/web/{domainName}/php =
Deletes PHP feature from domain.

__TOC__

== Request ==
<code>DELETE /accounts/{accountNumber}/web/{domainName}/php</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account owning the domain name

; domainName - ''string''
: The target domain name (domain name where the site is actually hosted)

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

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

== Response ==

=== Status Code ===
; 202 Accepted
: Success

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

; 403 Forbidden
: The authenticated user is not allowed to delete this feature.

; 404 Not Found
: The domain name or the feature do not exist for the account.

== Examples ==

=== Success deleting subdomain ===
'''Request'''
<nowiki>
DELETE /accounts/test-account/web/test.com/php
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

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

Accounts-accountNumber-web-domainName-error404:DELETE

2015-04-20T13:46:03Z

Velimira.metodieva: Created page with "= DELETE /accounts/{accountNumber}/web/{domainName}/error404 = Deletes error page from domain. __TOC__ == Request == <code>DELETE /accounts/{accountNumber}/web/{domainName}/..."

= DELETE /accounts/{accountNumber}/web/{domainName}/error404 =
Deletes error page from domain.

__TOC__

== Request ==
<code>DELETE /accounts/{accountNumber}/web/{domainName}/error404</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account owning the domain name

; domainName - ''string''
: The target domain name (domain name where the site is actually hosted)

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

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

== Response ==

=== Status Code ===
; 202 Accepted
: Success

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

; 403 Forbidden
: The authenticated user is not allowed to delete this page.

; 404 Not Found
: The domain name or the error page do not exist for the account.

== Examples ==

=== Success deleting error page===
'''Request'''
<nowiki>
DELETE /accounts/test-account/web/test.com/error404
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

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

Accounts-accountNumber-web-domainName-subdomains:GET

2015-04-20T13:40:28Z

Velimira.metodieva: /* GET /accounts/{accountNumber}/web/{domainName}/subdomains */

= GET /accounts/{accountNumber}/web/{domainName}/subdomains =
Returns a list of the subdomains.

__TOC__

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

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the subdomains belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

== Response ==

=== Response Body ===
<nowiki>
{
"list": [{"status": "{status}", "domain": "{domain}", "subdomain": "{subdomain}"},
{"status": "{status}", "domain": "{domain}", "subdomain": "{subdomain}"},
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/subdomains",
"rel": "self"}]
}
</nowiki>

==== Parameters ====
:; list - ''list''
:: A list, containing the status, the domain and the corresponding subdomain.

::; status - ''string''
::: Status of the subdomain. Currently only subdomains with status '''open''' are listed.

::; domain - ''string''
::: The domain name of the main web hosting product.

::; subdomains - ''string''
::: The subdomain.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name does not exist for the account

== Examples ==

=== Successful retrieving subdomains ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/subdomains
</nowiki>

'''Response'''
<nowiki>
{
"list":
[
{"status": "open", "domain": "test.com", "subdomain": "sub.test.com"},
{"status": "open", "domain": "test.com", "subdomain": "sub1.test.com"},
{"status": "open", "domain": "test.com", "subdomain": "sub1.v.test.com"}
],
"links":
[
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/subdomains/", "rel": "self"}
]
}
</nowiki>

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

Accounts-accountNumber-web-domainName-aliases:GET

2015-04-06T14:25:35Z

Velimira.metodieva: /* Examples */

= GET /accounts/{accountNumber}/web/{domainName}/aliases =
Returns a list of the domain name aliases.

__TOC__

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

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

== Response ==

=== Response Body ===
<nowiki>
{
"list": [{"status": "{status}", "domain": "{domain}", "alias": "{alais}"},
{"status": "{status}", "domain": "{domain}", "alias": "{alais}"},
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases",
"rel": "self"}]
}
</nowiki>

==== Parameters ====
:; list - ''list''
:: A list, containing the status, the domain and the corresponding alias values.

::; status - ''string''
::: Current status of the domain name alias. Currently only aliases with status '''open''' are listed.

::; domain - ''string''
::: The domain name of the main web hosting product.

::; alias - ''string''
::: The alias name.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving domain name alias ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/aliases
</nowiki>

'''Response'''
<nowiki>
{
"list":
[
{"status": "open", "domain": "test.com", "alias": "alias1-test.com"},
{"status": "open", "domain": "test.com", "alias": "alias2-test.com"}
],
"links":
[
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/web/{domainName}/aliases/", "rel": "self"}
]
}
</nowiki>

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

Accounts-accountNumber-web-domainName-subdomains-subDomain:GET

2015-04-06T14:22:44Z

Velimira.metodieva: /* Response */

= GET /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain} =
Returns details of the subdomain.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the subdomain belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

; subDomain - ''string''
: The subdomain

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

== Response ==

=== Response Body ===
<nowiki>
{
"status": "{status}",
"domain": "{domainName}",
"subdomain": "{subDomain}",
"links": [
{
"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{subDomain}", "rel": "self",
"href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}", "rel": "product",
"href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}/services/{serviceSpecificationId}", "rel": "service"
}
]
}
</nowiki>

==== Parameters ====
:; status - ''string''
:: Status of the subdomain. Currently only subdomains with status '''open''' are listed.

:; domain - ''string''
:: The domain name of the main web hosting product.

:; subdomains - ''string''
:: The subdomain.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource. The list includes a link to the web hosting product and a link to the subdomain service.

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the subdomain do not exist for the account

== Examples ==

=== Successful retrieving subdomain ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/subdomains/sub
</nowiki>

'''Response'''
<nowiki>
{
"domain": "test.com",
"subdomain": "sub.test.com",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/web/test.com/subdomains/sub", "rel": "self",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/", "rel": "product",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/services/acct1234-0000014c8e39bf39a2fc8945007f00000001000/", "rel": "service"
}
]
}

</nowiki>

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

Accounts-accountNumber-web-domainName-aliases:POST

2015-04-06T14:20:35Z

Velimira.metodieva: /* Examples */

= POST /accounts/{accountNumber}/web/{domainName}/aliases =
Creates domain name alias.

__TOC__

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

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

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

=== Request Body ===
<nowiki>
{
"alias": "{alias}"
}
</nowiki>

==== Parameters ====
; alias - ''string''
: A valid domain name. Required.

== Response ==

=== Status Code ===
; 202 Accepted
: Success

; 400 Bad Request
: The format of the request body is invalid or the alias 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
: The alias already exists(on create) or domain is disabled(on update).

== Examples ==

=== Failure creating a domain alias when required parameter is missing ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/aliases

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

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

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"alias": "Required"}}}

</nowiki>

=== Failure creating a domain alias when passing invalid parameter ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/aliases

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

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

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"alias": "Invalid domain name in alias: test"}}}

</nowiki>

=== Successfully creating a domain alias ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/aliases

{"alias": "alias.com"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted

</nowiki>
=== ===

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

Accounts-accountNumber-web-domainName-aliases-alias:DELETE

2015-04-06T13:56:49Z

Velimira.metodieva: moved Accounts-accountNumber-web-domainName-aliases-AliasDomainName:DELETE to Accounts-accountNumber-web-domainName-aliases-alias:DELETE

= DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{alias} =
Deletes domain name alias.

__TOC__

== Request ==
<code>DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{alias}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account owning the domain name and the domain name alias

; domainName - ''string''
: The target domain name (domain name where the site is actually hosted)

; alias - ''string''
: The domain name that will act as an alias to the target domain.

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

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

== Response ==

=== Status Code ===
; 202 Accepted
: Success

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

; 403 Forbidden
: The authenticated user is not allowed to delete this alias.

; 404 Not Found
: The domain name or the domain name alias do not exist for the account.

== Examples ==

=== Success deleting domain name alias ===
'''Request'''
<nowiki>
DELETE /accounts/test-account/web/test.com/aliases/test-alias.com
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

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

Accounts-accountNumber-web-domainName-aliases-alias:GET

2015-04-06T13:56:03Z

Velimira.metodieva: moved Accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET to Accounts-accountNumber-web-domainName-aliases-alias:GET

= GET /accounts/{accountNumber}/web/{domainName}/aliases/{alias} =
Returns details of the domain name alias.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/aliases/{alias}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

; alias - ''string''
: The domain name that will act as alias to the target domain

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

== Response ==

=== Response Body ===
<nowiki>
{
"status": "{status}",
"domain": "{domainName}",
"alias": "{alias}",
"links": [
{
"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{alias}", "rel": "self",
"href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}", "rel": "product",
"href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}/services/{serviceSpecificationId}", "rel": "service"
}
]
}
</nowiki>

==== Parameters ====
:; status - ''string''
:: Current status of the domain name alias. Currently only aliases with status '''open''' are listed.

:; domain - ''string''
:: The domain name of the main web hosting product.

:; alias - ''string''
:: The alias name.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource. The list includes a link to the web hosting product and a link to the domain alias service.

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

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

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving domain name alias ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/aliases/test-alias.com
</nowiki>

'''Response'''
<nowiki>
{
"status": "open",
"domain": "test.com",
"alias": "test-alias.com",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/web/test.com/aliases/test-alias.com", "rel": "self",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/", "rel": "product",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/services/acct1234-0000014c8e39bf39a2fc8945007f00000001000/", "rel": "service"
}
]
}
</nowiki>

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

Accounts-accountNumber-web-domainName-subdomains-subDomain:DELETE

2015-04-06T13:48:55Z

Velimira.metodieva: /* Success deleting subdomain */

= DELETE /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain} =
Deletes subdomain.

__TOC__

== Request ==
<code>DELETE /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account owning the domain name and the subdomain

; domainName - ''string''
: The target domain name (domain name where the site is actually hosted)

; subDomain - ''string''
: The subdmain.

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

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

== Response ==

=== Status Code ===
; 202 Accepted
: Success

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

; 403 Forbidden
: The authenticated user is not allowed to delete this subdomain.

; 404 Not Found
: The domain name or the subdomain do not exist for the account.

== Examples ==

=== Success deleting subdomain ===
'''Request'''
<nowiki>
DELETE /accounts/test-account/web/test.com/subdomains/sub.test.com
</nowiki>

'''Response'''
<nowiki>
202 Accepted
</nowiki>

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

Web API

2015-03-23T13:21:32Z

Velimira.metodieva: /* Aliases */

The Web API provides access to information about the web hosting products.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Websites ==
<blockquote>
=== Websites ===
* [[accounts-accountNumber-web-:GET|GET /accounts/{accountNumber}/web]] - Returns a list of websites
* [[accounts-accountNumber-web-domainName:GET|GET /accounts/{accountNumber}/web/{domainName}]] - Returns a detailed information about a website
</blockquote>

== Domain Names ==
<blockquote>
=== Aliases ===
* [[accounts-accountNumber-web-domainName-aliases:POST|POST /accounts/{accountNumber}/web/{domainName}/aliases]] - Adds domain name alias
* [[accounts-accountNumber-web-domainName-aliases:GET|GET /accounts/{accountNumber}/web/{domainName}/aliases]] - Returns a list of the domain name aliases
* [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET|GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}]] - Returns details of the domain name alias
* [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}]] - Deletes domain name alias
</blockquote>

== FTP Accounts ==
<blockquote>
=== FTP Accounts ===
* [[accounts-accountNumber-web-domainName-ftp:GET|GET /accounts/{accountNumber}/web/{domainName}/ftp]] - Returns list of ftp accounts for the web site
* [[accounts-accountNumber-web-domainName-ftp-FtpUsername:GET|GET /accounts/{accountNumber}/web/{domainName}/ftps/{FtpUsername}]] - Returns details of the ftp account
</blockquote>

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

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

Email API

2015-01-14T13:51:05Z

Velimira.metodieva: /* Domain Black/White List */

== Mailboxes ==
* [[Accounts-account-email-domain-usernames:GET|GET /accounts/{account}/email/{domain}/usernames]] - Retrieves a list of mailboxes
* [[Accounts-account-email-domain-usernames-mailboxName:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}]] - Details about a username
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - 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
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox-action:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/action]] - Apply action on a mailbox, e.g. reset password

== Exchange ==
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Create or update exchange mailbox
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Get exchange mailbox info
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Delete exchange mailbox
* [[Accounts-account-email-domain-usernames-mailboxName-exchange-action:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/action]] - Apply action on exchange mailbox, e.g. reset password

== Aliases ==
* [[Accounts-account-email-domain-alaises:GET|GET /accounts/{account}/email/{domain}/aliases]] - Retrieves a list of domain aliases

== 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
* [[Email-domain-usernames-mailboxName-webmail:GET|GET /email/{domain}/usernames/{mailboxName}/webmail]] - Getting OX account
* [[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 OX account
* [[Email-domain-usernames-mailboxName-webmail:PUT|PUT /email/{domain}/usernames/{mailboxName}/webmail]] - Update OX account

== Black/White List ==
* [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist]] - Retrieves black/whitelisted addresses
* [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist]] - Adds address(es) to black/white list
* [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist-address:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address}]] - Get particular address info
* [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist-address:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address}]] - Deletes an address from black/white list

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

== Mailbox Message Count ==
* [[Accounts-account-email-domain-usernames-mailboxName-messagestats:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats]] - Get mailbox message count for INBOX, SENT and SPAM folders

== Exchange Message Count ==
* [[Accounts-account-email-domain-usernames-mailboxName-exchange-messagestats:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/exchange/messagestats]] - Get exchange message count for INBOX, SENT and SPAM folders

== Email Domain ==
* [[Accounts-account-email-domain:GET|GET /accounts/{account}/email/{domain}]] - Gets specific email domain's info

== Domain Black/White List ==
* [[Accounts-account-email-domain-blackwhitelist:GET|GET /accounts/{account}/email/{domain}/blackwhitelist]] - Retrieves black/whitelisted addresses for domain
* [[Accounts-account-email-domain-blackwhitelist:PUT|PUT /accounts/{account}/email/{domain}/blackwhitelist]] - Adds address(es) to black/white list for domain
* [[Accounts-account-email-domain-blackwhitelist-address:GET|GET /accounts/{account}/email/{domain}/blackwhitelist/{address}]] - Get particular address info
* [[Accounts-account-email-domain-blackwhitelist-address:DELETE|DELETE /accounts/{account}/email/{domain}/blackwhitelist/{address}]] - Deletes an address from black/white list

== Secret Questions ==
* [[Accounts-account-email-domain-usernames-mailboxName-secrets:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Retrieves a list of mailbox(alias) secret questions
* [[Accounts-account-email-domain-usernames-mailboxName-secrets:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Set or update all secret questions and answers for mailbox(alias)

== Secret Question Settings ==
* [[Email-secretQuestionSettings:GET|GET /email/secretQuestionSettings]] - Get franchise specific secret question settings (e.g. '''minimum''' required number of secret questions, etc.)

== Supported Secret Questions ==
* [[Email-secretQuestions:GET|GET /email/secretQuestions]] - Get dictionary of supported secret questions with text keys



=== Templates ===
* [[Template:resetPassword|resetPassword]]

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

Accounts-account-email-domain-statistics-mailboxTypeCount:GET

2014-12-17T12:51:01Z

Velimira.metodieva: /* Parameters */

= GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount =
Retrieves per domain statistics about webmail usage
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount</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

== 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>
{
"numStandard": {numStandard},
"numActiveSync": {numActiveSync},
"numPremium": {numPremium},
"numExchange2013Standard": {numExchange2013Standard},
"numExchange2013Premium": {numExchange2013Premium}
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; numStandard - ''integer''
: Number of mailboxes for the domain with standard webmail access

; numActiveSync - ''integer''
: Number of mailboxes for the domain with activesync webmail access

; numPremium - ''integer''
: Number of mailboxes for the domain with premium webmail access

; numExchange2013Standard - ''integer''
: Number of mailboxes for the domain with standard exchange access

; numExchange2013Premium - ''integer''
: Number of mailboxes for the domain with premium exchange access

; 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/statistics/mailboxTypeCount
</nowiki>

'''Response'''
<nowiki>
{
"numStandard": 1,
"numActiveSync": 0,
"numPremium": 0,
"numExchange2013Standard": 5,
"numExchange2013Premium": 2
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/statistics/mailboxTypeCount/",
"rel": "self"
}
]
}
</nowiki>

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

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

Accounts-account-email-domain-statistics-mailboxTypeCount:GET

2014-12-15T13:58:30Z

Velimira.metodieva: /* Examples */

= GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount =
Retrieves per domain statistics about webmail usage
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount</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

== 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>
{
"numStandard": {numStandard},
"numActiveSync": {numActiveSync},
"numPremium": {numPremium},
"numExchange2013Standard": {numExchange2013Standard},
"numExchange2013Premium": {numExchange2013Premium}
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; numStandard - ''integer''
: Number of mailboxes for the domain with standard webmail access

; numActiveSync - ''integer''
: Number of mailboxes for the domain with activesync webmail access

; numPremium - ''integer''
: Number of mailboxes for the domain with premium webmail access

; numExchange2013Standard - ''integer''
: Number of mailboxes for the domain with standard Exchange 2013 access

; numExchange2013Premium - ''integer''
: Number of mailboxes for the domain with premium Exchange 2013 access

; 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/statistics/mailboxTypeCount
</nowiki>

'''Response'''
<nowiki>
{
"numStandard": 1,
"numActiveSync": 0,
"numPremium": 0,
"numExchange2013Standard": 5,
"numExchange2013Premium": 2
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/statistics/mailboxTypeCount/",
"rel": "self"
}
]
}
</nowiki>

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

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

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

2014-11-04T10:52:48Z

Velimira.metodieva:

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

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/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}/exchange/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}/exchange/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}/exchange/messagestats/", "rel": "self"}]
}
</nowiki>

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

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

Email API

2014-11-04T10:29:45Z

Velimira.metodieva:

== 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}/mailbox]] - 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

<blockquote>
=== Mailbox Actions ===
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox-action:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/action]] - Apply action on a mailbox, e.g. reset password
* [[Email-domain-usernames-mailboxName-mailbox-action:POST|POST /email/{domain}/usernames/{mailboxName}/mailbox/action]] - Apply action on a mailbox, e.g. reset password (shortcut)

=== Secret Questions ===
* [[Accounts-account-email-domain-usernames-mailboxName-secrets:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Retrieves a list of mailbox(alias) secret questions
* [[Email-domain-usernames-mailboxName-secrets:GET|GET /email/{domain}/usernames/{mailboxName}/secrets]] - Retrieves a list of mailbox(alias) secret questions (shortcut)

* [[Accounts-account-email-domain-usernames-mailboxName-secrets:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Set or update all secret questions and answers for mailbox(alias)
* [[Email-domain-usernames-mailboxName-secrets:PUT|PUT /email/{domain}/usernames/{mailboxName}/secrets]] - Set or update all secret questions and answers for mailbox(alias) (shortcut)
</blockquote>

== Exchange ==
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Create or update exchange mailbox
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Get exchange mailbox info
* [[Accounts-account-email-domain-usernames-mailboxName-exchange:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange]] - Delete exchange mailbox

== Aliases ==
* [[Accounts-account-email-domain-alaises:GET|GET /accounts/{account}/email/{domain}/aliases]] - Retrieves a list of domain aliases

== 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
* [[Email-domain-usernames-mailboxName-webmail:GET|GET /email/{domain}/usernames/{mailboxName}/webmail]] - Getting OX account
* [[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 OX account
* [[Email-domain-usernames-mailboxName-webmail:PUT|PUT /email/{domain}/usernames/{mailboxName}/webmail]] - Update 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

== Mailbox Message Count ==
* [[Accounts-account-email-domain-usernames-mailboxName-messagestats:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats]] - Get mailbox message count for INBOX, SENT and SPAM folders

== Exchange Message Count ==
* [[Accounts-account-email-domain-usernames-mailboxName-exchange-messagestats:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/exchange/messagestats]] - Get exchange message count for INBOX, SENT and SPAM folders

== Email Domain ==
* [[Accounts-account-email-domain:GET|GET /accounts/{account}/email/{domain}]] - Gets specific email domain's info

== Supported Secret Questions ==
* [[Email-secretQuestions:GET|GET /email/secretQuestions]] - Get dictionary of supported secret questions with text keys



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

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

2014-10-30T16:29:18Z

Velimira.metodieva: /* Parameters */

= 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},
"resetPassword": {resetPassword},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}",
"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.
; resetPassword - ''boolean''
: Returns if customer will be forced to reset mailbox password the next time he logs in to his OX account
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== 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,
"resetPassword": false,
"theme": "test_theme",
"language": "en_US",
"timezone": "America/Chicago",
"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-webmail:PUT

2014-10-30T16:22:17Z

Velimira.metodieva:

= 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},
"resetPassword": {resetPassword},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</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.
: The account owner(with admin-user credentials) can make changes between account types regardless of the allowUpgrade settings.
: If the call is made with the end-user credentials and allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
: If the call is made with the end-user credentials and type is already different than standard and allowUpgrade is set to ''false'' the response is ''400 Bad Request''
: If current usage is more than new type quota the response is ''400 Bad Request''
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
; resetPassword - ''boolean''
: Forces customer to reset his password the next time he logs in to his OX account.
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Response ==

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

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

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

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

== Examples ==

=== Failure updating account type with missing required parameter ===
'''Request'''
<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 upgrading 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>

=== Failure upgrading account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

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

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

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

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

=== Failure downgrading account due to current usage greater than new quota ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

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

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

{"message": "Current mailbox usage is larger than the new quota value"}
</nowiki>
=== Success updating resetPassword flag ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"resetPassword": true}
</nowiki>

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

=== Success updating timezone, language and theme ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"theme": "new_theme", "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

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

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

Accounts-accountId-Contacts-contactType:PUT

2014-08-08T12:14:17Z

Velimira.metodieva: /* Request for updating contact type with not valid data */

= PUT /accounts/''{accountId}''/contacts/''{contactType}'' =
Set specific contact type for an account
__TOC__

== Request ==
<code>PUT /accounts/''{accountId}''/contacts/''{contactType}''</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.
;contactType - ''string''
: Contact type. One of 'regular', 'billing', 'administrator', 'technical'

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"city": "{city}",
"company": "{company}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"email2": "{email2}",
"fax": "{fax}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"middleName": "{middleName}",
"phone1": "{phone1}",
"phone2": "{phone2}",
"postalCode": "{postalCode}",
"salutation": "{salutation}",
"stateOrProvince": "{stateOrProvince}",
"street1": "{street1}",
"street2": "{street2}"
}
</nowiki>

==== Parameters ====
; city - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; company - ''string''
: ''(OPTIONAL)''
: May be up to 200 characters long. May contain only alphanumeric, white space and the following characters: -.'

; countryCode - ''string''
: ''(REQUIRED)''
: ISO 3166-1 alpha-2[http://www.iso.org/iso/iso-3166-1_decoding_table.html] country code.

; email1 - ''string''
: ''(REQUIRED)''
: May be up to 100 characters long. Must contain a valid e-mail address.

; email2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, must contain a valid e-mail address.

; fax - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; firstName - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; lastName - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; middleName - ''string''
: ''(OPTIONAL)''
: May be up to 50 characters long. If provided, may contain only alphanumeric, white space and the following characters: -.'

; phone1 - ''string''
: ''(REQUIRED)''
: May be up to 20 characters long. Must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; phone2 - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; postalCode - ''string''
: ''(OPTIONAL)''
: May be up to 30 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''postalCode'' must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the value of ''countryCode'' is "CA", then ''postalCode'' must be in format "A#A#A#" or "A#A-#A#" or "A#A #A#" (where "A" represents any latin alphabet character and "#" represents any numeric digit).

; salutation - ''string''
: ''(OPTIONAL)''
: May contain one of the salutations provided by [[Salutations:GET|GET /salutations]]

; stateOrProvince - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''stateOrProvince'' must be a valid two-letter US state abbreviation. If the value of ''countryCode'' is "CA", then ''stateOrProvince'' must be a valid two-letter Canadian province abbreviation.

; street1 - ''string''
: ''(REQUIRED)''
: May be up to 100 characters long. May contain only alphanumeric, white space and the following characters: -.'

; street2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, may contain only alphanumerics, white space and the following characters: -.'

== Response ==

=== Status Code ===
; 204 No Content
: Successfully updated contact information

; 400 Bad Request
: Contact information was not updated because either the request body was malformed, or some element of the request body did not meet the requirements.

; 401 Unauthorized
: The request was sent without an ''Authorization'' header, or the user represented by the value of this header was not properly authenticated.

; 403 Forbidden
: The user authenticated for this request is not allowed to access the resource.

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

=== Response Body ===
None.

== Examples ==
=== Successful update of contact information ===
''Request''
<nowiki>
PUT /accounts/{accountId}/contacts/regular

Authorization: Basic {Base64-encoded username & password string}

{
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

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

=== Request for updating non-existent contact type ===
''Request''
<nowiki>
PUT /accounts/{accountId}/contacts/fake

Authorization: Basic {Base64-encoded username & password string}

{
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "USS",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

''Response''
<nowiki>
404 Not Found

{
"itemNotFound": {
"guid": {identifier},
"message": "Resource not found",
"code": 404,
"details": ""
}
}
</nowiki>

=== Request for updating contact type with not valid data ===
''Request''
<nowiki>
PUT /accounts/{accountId}/contacts/regular

Authorization: Basic {Base64-encoded username & password string}

{
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

''Response''
<nowiki>
400 Bad Request

{
"badRequest": {
"guid": {identifier},
"message": "POST data error",
"code": 400,
"details": {
"countryCode": "Invalid Country Code"
}
}
}
</nowiki>

=== Request for updating contact type with missing or empty required data ===
''Request''
<nowiki>
PUT /accounts/{accountId}/contacts/regular

Authorization: Basic {Base64-encoded username & password string}

{
"city": "Chicago",
"company": "TestCo, Inc.",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

''Response''
<nowiki>
400 Bad Request

{
"badRequest": {
"guid": {identifier},
"message": "POST data error",
"code": 400,
"details": {
"countryCode": "Required",
"firstName": "Required"
}
}
}
</nowiki>

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

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

Accounts-accountId-Contacts-contactType:GET

2014-08-08T12:01:22Z

Velimira.metodieva: /* Parameters */

= GET /accounts/''{accountId}''/contacts/''{contactType}'' =
Get specific contact type for an account
__TOC__

== Request ==
<code>GET /accounts/''{accountId}''/contacts/''{contactType}''</code>

==== Request Parameters ====
;accountId - ''string''
: The unique account Id.
;contactType - ''string''
: Contact type. One of 'regular', 'billing', 'administrator', 'technical'

=== URI Parameters ===
None.

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

== Response ==

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

; 401 Unauthorized
: The request was sent without an ''Authorization'' header, or the user represented by the value of this header was not properly authenticated.

; 403 Forbidden
: The user authenticated for this request is not allowed to access the resource.

; 404 Not Found
: Contact type does not match allowed values or the specified account Id does not exist or is purged.

=== Response Body ===
<nowiki>
{
"city": "Chicago",
"company": "Widget Corp.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"emailVerified": 1,
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

==== Parameters ====
; city - ''string''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; company - ''string''
: ''(OPTIONAL)''
: May be up to 200 characters long. May contain only alphanumeric, white space and the following characters: -.'

; countryCode - ''string''
: ISO 3166-1 alpha-2[http://www.iso.org/iso/iso-3166-1_decoding_table.html] country code.

; email1 - ''string''
: May be up to 100 characters long. Must contain a valid e-mail address.

; email2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, must contain a valid e-mail address.

; emailVerified - ''integer''
: Provides information whether the '''email''' is verified for a Zendesk access. Valid values are '''0''' or '''1'''.

; fax - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; firstName - ''string''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; lastName - ''string''
: May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'

; middleName - ''string''
: ''(OPTIONAL)''
: May be up to 50 characters long. If provided, may contain only alphanumeric, white space and the following characters: -.'

; phone1 - ''string''
: May be up to 20 characters long. Must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; phone2 - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; postalCode - ''string''
: ''(OPTIONAL)''
: May be up to 30 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''postalCode'' must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the value of ''countryCode'' is "CA", then ''postalCode'' must be in format "A#A#A#" or "A#A-#A#" or "A#A #A#" (where "A" represents any latin alphabet character and "#" represents any numeric digit).

; salutation - ''string''
: ''(OPTIONAL)''
: May contain one of the salutations provided by [[Salutations:GET|GET /salutations]]

; stateOrProvince - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''stateOrProvince'' must be a valid two-letter US state abbreviation. If the value of ''countryCode'' is "CA", then ''stateOrProvince'' must be a valid two-letter Canadian province abbreviation.

; street1 - ''string''
: May be up to 100 characters long. May contain only alphanumeric, white space and the following characters: -.'

; street2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, may contain only alphanumeric, white space and the following characters: -.'

== Examples ==

=== Successful Request ===
''Request''
<nowiki>
GET /accounts/{accountId}/contacts/regular
Authorization: Basic {Base64-encoded username & password string}
</nowiki>

''Response''
<nowiki>
200 OK

{
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"emailVerified": 1,
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
</nowiki>

=== Request for non-existent contact type ===
''Request''
<nowiki>
GET /accounts/{accountId}/contacts/fake
Authorization: Basic {Base64-encoded username & password string}
</nowiki>

''Response''
<nowiki>
404 Not Found

{
"itemNotFound": {
"guid": {identifier},
"message": "Resource not found",
"code": 404,
"details": ""
}
}
</nowiki>

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

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

Account

2014-08-08T11:40:20Z

Velimira.metodieva: /* Contacts Management */

= 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
* [[Accounts-accountId-Contacts-contactType:GET|GET /accounts/{accountId}/contacts/{contactType}]] - Returns specific contact type for an account
* [[Accounts-accountId-Contacts:PUT|PUT /accounts/{accountId}/contacts]] - Set all contacts for an account
* [[Accounts-accountId-Contacts-contactType:PUT|PUT /accounts/{accountId}/contacts/{contactType}]] - Set specific contact type for an account

=== Actions ===
*[[Initiate-Email-Verification-Action:POST|POST /accounts/{account_number}/contacts/action]] - Initiate Email Verification Action

=== ZenDesk SSO Link ===
*[[ZenDesk-SSO-Link-Per-Contact-Type:GET|GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink]] - Returns ZendDesk SSO Link Per Contact Type

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

== Payment info ==
* [[Accounts-accountId-paymentInfo:GET|GET /accounts/{accountId}/paymentInfo]] - Get a list of active payment methods
* [[Accounts-accountId-paymentInfo:POST|POST /accounts/{accountId}/paymentInfo]] - Add a payment method for a given account
* [[Accounts-accountId-paymentInfo-default:PUT|PUT /accounts/{accountId}/paymentInfo/default]] - Set the default payment method
* [[Accounts-accountId-paymentInfo-default:DELETE|DELETE /accounts/{accountId}/paymentInfo/default]] - Unset the default payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:GET|GET /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Get information about an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:DELETE|DELETE /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Remove an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId-payment:POST|POST /accounts/{accountId}/paymentInfo/{paymentInfoId}/payment]] - Make a one-time payment toward the account balance

== Transactions ==
* [[Accounts-accountId-transactionsInfo:GET|GET /accounts/{accountId}/transaction]] - Get a list of account's transactions
* [[Accounts-accountId-transactionsInfo-filtered-type:GET|GET /accounts/{accountId}/transaction?filterType={filterType}]] - Get a list of account's transactions filtered by Transaction type
* [[Accounts-accountId-transactionsInfo-sorted:GET|GET /accounts/{accountId}/transaction?sortField={sortField}]] - Get a list of account's transactions sorted by sortField param

== Invoices ==
* [[Accounts-accountId-invoicesInfo:GET|GET /accounts/{accountId}/invoices]] - Get a list of account's invoices
* [[Accounts-accountId-invoicesInfo-filtered-status:GET|GET /accounts/{accountId}/invoices?filterStatus={filterStatus}]] - Get a list of account's invoices filtered by Invoice status
* [[Accounts-accountId-invoicesInfo-sorted:GET|GET /accounts/{accountId}/invoices?sortField={sortField}]] - Get a list of account's invoices sorted by sortField param
* [[Accounts-accountId-invoicesInfo-invoiceId:GET|GET /accounts/{accountId}/invoices/{invoiceId}]] - Get invoice info or pdf

== Invoice Transactions ==
* [[Accounts-accountId-invoices-invoiceId-transactions:GET|GET /accounts/{accountId}/invoices/{invoiceId}/transactions]] - Get a list of invoice transactions

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

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

Heartbeat:GET

2014-08-05T14:13:00Z

Velimira.metodieva: Created page with "= GET /heartbeat = __TOC__ == Request == <code>GET /heartbeat</code> == Response == === Status Codes === ; 200 OK : Success ; 500 Internal Server Error : Internal error oc..."

= GET /heartbeat =

__TOC__

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

== Response ==

=== Status Codes ===
; 200 OK : Success
; 500 Internal Server Error : Internal error occurred.

== See also ==
* [[Miscellaneous|Miscellaneous APIs]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

POST Exchange Email Alias

2014-07-15T14:28:38Z

Velimira.metodieva: /* Examples */

Create an Email Alias

'''POST''' <code>''{server_name}''/accounts/''{account_number}''/exchange/''{domain_name}''/emailAliases</code>

== Parameters ==
; account_number - ''string''
: The account-number that the Exchange resource belongs to

; domain_name - ''string''
: The domain-name that is associated with the Exchange resource

== Request Body ==
<nowiki>{
"emailalias" : {
"username": "john",
"emailForward": "johnjello@domainname.com"
}
}
</nowiki>

; username - ''string''
: - Username of email address. Allowed are only letters, numbers, underscores, dashes and nonconsecutive dots. Dots cannot be at the beginning or the end of the value. From 1 to 52 characters long.

; emailForward - ''string''
: - Target email address. Must be a valid email address. The domain-name of the address must be the same as the domain-name associated with the Exchange resource.

=== Expected Response Codes ===
;201
: Created

;400
: External forward; Email forwarding to the same address; Validation error

;405
: Unsupported method

;409
: Username already exists

;502
: Internal server error

== Examples ==
'''POST {server_name}/accounts/account300021/exchange/ng-test-hwus-120120b.com/emailAliases'''

''- Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''- Request Body:''
<nowiki>{
"emailalias" : {
"username": "john",
"emailForward": "johnjello@ng-test-hwus-120120b.com"
}
}
</nowiki>

''- Response:''
''Created (201)'':
Server : nginx/0.6.32
Date : Fri, 01 Jun 2012 23:51:29 GMT
Connection : keep-alive
Location : http://coreapi01.ote.chicago.hostway:8098/accounts/popescu300021/exchange/ng-test-hwus-petre-120120b.com/emailAliases/john/
Content-Length : 0

*There will be a Location in the response header pointing to the newly created resource.

----

''- Request Body with Invalid data:''
<nowiki>{
"emailalias": {
"username": "new_alias",
"emailForward": "new_alias@ng-test-hwus-petre-120120b.com"
}
}
</nowiki>

''- Response:''
''BadRequest (400)'':
<nowiki>{
"computeFault": {
"message": "Email forwarding to the same address is not allowed",
"code": 400, "details": ""
}
}
</nowiki>

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

DNS

2014-07-10T14:44:36Z

Velimira.metodieva: /* Misc */

= DNS API =
The DNS API supports operations of managing DNS zones.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Zone Management ==
* [[Dns-zone:GET|GET /dns/{zone}]] - Gets DNS zone details

== Zone Records Management ==
* [[Dns-zone-records:GET|GET /dns/{zone}/records]] - Gets the resource records of a DNS zone
* [[Dns-zone-records:POST|POST /dns/{zone}/records]] - Adds new resource record to a DNS zone
* [[Dns-zone-records-recordId:PUT|PUT /dns/{zone}/records/{recordId}]] - Updates resource record in a DNS zone
* [[Dns-zone-records-recordId:DELETE|DELETE /dns/{zone}/records/{recordId}]] - Deletes resource record from a DNS zone

== Misc ==
* [[Dns-heartbeat:GET|GET /dns/heartbeat]] - Gets heartbeat
* [[Dns-healthcheck:GET|GET /dns/healthcheck]] - Gets healthcheck

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

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

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

2014-06-25T11:55:32Z

Velimira.metodieva: /* 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}
}
</nowiki>

==== Parameters ====
; password - ''string''
: The password. Required. 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.

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

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

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

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

Email-domain-usernames-mailboxName-webmail:PUT

2014-06-17T13:31:45Z

Velimira.metodieva: /* Parameters */

= 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},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</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''
: If current usage is more than new type quota the response is ''400 Bad Request''
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Response ==

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

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

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

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

== Examples ==

=== Failure updating account type with 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 upgrading 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>

=== Failure upgrading account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

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

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

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

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

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

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

=== Failure downgrading account due to current usage greater than new quota ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

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

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

{"message": "Current mailbox usage is larger than the new quota value"}
</nowiki>

=== Success updating timezone, language and theme ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"theme": "new_theme", "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

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

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

Email-domain-usernames-mailboxName-webmail:POST

2014-06-17T13:28:45Z

Velimira.metodieva: /* Failure creating account when mailbox qty for OX type is exceeded */

= 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},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</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.
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account. If not provided , default theme is set.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

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

=== Failure creating account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

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

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

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

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

{"type": "activesync", "allowUpgrade": false, "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

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

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

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

2014-06-17T13:28:27Z

Velimira.metodieva: /* Failure creating account when mailbox qty for OX type is exceeded */

= 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},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}"
}
</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.
: If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account. If not provided, default theme is set.
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

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

=== Failure creating account when mailbox qty for OX type is exceeded ===
'''Request'''
<nowiki>
POST /accounts/test/email/test.com/usernames/john.smith/webmail

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

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

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

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

{"type": "standard", "allowUpgrade": false, "language": "en_US", "timezone": "America/Chicago"}
</nowiki>

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

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

Accounts-accountId-transactionsInfo:GET

2014-06-13T14:29:45Z

Velimira.metodieva: /* Request Headers */

= GET /accounts/''{accountId}''/transactions =
Retrieves a list of all account's transactions
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/transactions</code>

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}
; Accept - ''HTTP Accept header. Possible values are application/json, text/csv. If omitted json will be returned'' [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]

== Response ==

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

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

;403 Forbidden
: The user lacks the necessary permissions to access the resource

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

=== Response Body ===
<nowiki>
{
{
"list": [{
"startDate": "{startDate}",
"endDate": "{endDate}",
"amount": {amount},
"description": "{description}",
"currency": "{currency}",
"date": "{date}",
"productSpecification": "",
"serviceNumber": "{serviceNumber}",
"type": "{type}",
"number": {number}
}],
"links" : [{
"href" : "https://api.hostway.com/accounts/{account_id}/transactions",
"rel" : "self"
}]
}
</nowiki>

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

:; startDate - ''string''
:: Start date of transaction

:; endDate - ''string''
:: End date of transaction

:; ammount - ''integer''
:: Amount of transaction

:; description - ''string''
:: Description of transaction

:; currency - ''string''
:: Currency symbol of transaction

:; date - ''string''
:: Date of transaction

:; productSpecification - ''link''
:: URL link to the product specification

:; serviceNumber - ''string''
:: Service number info

:; type - ''string''
:: Type of transaction. Possible values are: 'charge', 'charge_back', 'payment', 'fee', 'refund', 'credit', 'cc_chargeback', 'charge_adjustment', 'discount', 'credit_adjustment', 'credit_proration', 'charge_proration', 'payment_adjustment', 'tax', 'cc_chargeback_reversal', 'usage_charge', 'write_off', 'undo_write_off', 'usage_discount'

:; number - ''int''
:: Transaction's number

:; links - ''list''
:: [[Hypermedia]] for the individual payment method

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

== Examples ==

=== GET paginated transaction list call ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/transactions?page=1&pageSize=10
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"list" : [ {
"startDate": "2012-04-23",
"amount": 0.87,
"endDate": "2012-05-18",
"description": "Recurring fee Exchange 2010 Archiving, core.email.exchange2010.archiving 04/23/2012 through 05/18/2012",
"currency": "USD",
"date": "2012-04-23",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test731993-00000137a32daee9e2b08715000a30fe33d32c",
"serviceNumber": "test731993-00000136dedf26dfd9ec22fd000a1ddba01da1",
"type": "charge",
"number": 101393524
}],
"links" : [
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=1&pageSize=10",
"rel" : "self"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=2&pageSize=10",
"rel" : "next"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?page=44&pageSize=10",
"rel" : "last"
}]
}
</nowiki>

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

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

Accounts-accountId-invoicesInfo-invoiceId:GET

2014-06-13T14:28:00Z

Velimira.metodieva: /* GET invoice */

= GET /accounts/''{accountId}''/invoces/''{invoiceId}'' =
Retrieves an individual invoice.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/invoces/''{invoiceId}''</code>

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

; invoiceId - ''string''
: The Id of the invoice.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}
; Accept - ''HTTP Accept header. Possible values are application/json, application/pdf. If omitted json will be returned'' [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]

== Response ==

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

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

;403 Forbidden
: The user lacks the necessary permissions to access the resource

;404 Not Found
: The account or invoice was not found

=== Response Body ===
<nowiki>
{
"status": "{status}",
"currency": "{currency}",
"amount": "{amount}",
"amountDue": "{amountDue}",
"description": "{description}",
"links": [{
"href": "https://api.hostway.com/accounts/{accountId}/invoices/{invoiceId}/",
"rel": "self"
}],
"date": "{date}",
"statusName": "{statusName}",
"invoiceNumber": "{invoiceNumber}"
}
</nowiki>

==== Parameters ====
; status - ''string''
: Status of invoice

; currency - ''string''
: Currency of invoice

; ammount - ''string''
: Amount of invoice

; amountDue - ''string''
: Amount due of invoice

; description - ''string''
: Description of invoice

; date - ''string''
: Date of invoice

; statusName - ''string''
: Status of invoice

; invoiceNumber - ''string''
: Invoice number

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

== Examples ==

=== GET invoice ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/invoices/123456
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "invoice_paid",
"currency": "USD",
"amount": "1113.7500",
"amountDue": "0.0000",
"description": "Invoice #123456",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test731993/invoices/123456/",
"rel": "self"
}
],
"date": "2011-11-10",
"statusName": "Invoice Paid",
"invoiceNumber": "123456"
}
</nowiki>

=== GET invoice PDF ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/invoices/123456
Accept: application/pdf
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
'''Content-Type : application/pdf'''
<nowiki>
%PDF-1.4
....
%%EOF
</nowiki>

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

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

Account

2014-06-13T13:47:41Z

Velimira.metodieva: /* Invoices */

= 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
* [[Accounts-accountId-Contacts:PUT|PUT /accounts/{accountId}/contacts]] - Set all contacts for an account

===Contacts Actions===
*[[Initiate-Email-Verification-Action:POST|POST Initiate Email Verification Action]]

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

== Payment info ==
* [[Accounts-accountId-paymentInfo:GET|GET /accounts/{accountId}/paymentInfo]] - Get a list of active payment methods
* [[Accounts-accountId-paymentInfo:POST|POST /accounts/{accountId}/paymentInfo]] - Add a payment method for a given account
* [[Accounts-accountId-paymentInfo-default:PUT|PUT /accounts/{accountId}/paymentInfo/default]] - Set the default payment method
* [[Accounts-accountId-paymentInfo-default:DELETE|DELETE /accounts/{accountId}/paymentInfo/default]] - Unset the default payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:GET|GET /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Get information about an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:DELETE|DELETE /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Remove an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId-payment:POST|POST /accounts/{accountId}/paymentInfo/{paymentInfoId}/payment]] - Make a one-time payment toward the account balance

== Transactions ==
* [[Accounts-accountId-transactionsInfo:GET|GET /accounts/{accountId}/transaction]] - Get a list of account's transactions
* [[Accounts-accountId-transactionsInfo-filtered-type:GET|GET /accounts/{accountId}/transaction?filterType={filterType}]] - Get a list of account's transactions filtered by Transaction type
* [[Accounts-accountId-transactionsInfo-sorted:GET|GET /accounts/{accountId}/transaction?sortField={sortField}]] - Get a list of account's transactions sorted by sortField param

== Invoices ==
* [[Accounts-accountId-invoicesInfo:GET|GET /accounts/{accountId}/invoices]] - Get a list of account's invoices
* [[Accounts-accountId-invoicesInfo-filtered-status:GET|GET /accounts/{accountId}/invoices?filterStatus={filterStatus}]] - Get a list of account's invoices filtered by Invoice status
* [[Accounts-accountId-invoicesInfo-sorted:GET|GET /accounts/{accountId}/invoices?sortField={sortField}]] - Get a list of account's invoices sorted by sortField param
* [[Accounts-accountId-invoicesInfo-invoiceId:GET|GET /accounts/{accountId}/invoices/{invoiceId}]] - Get invoice info or pdf

== Invoice Transactions ==
* [[Accounts-accountId-invoices-invoiceId-transactions:GET|GET /accounts/{accountId}/invoices/{invoiceId}/transactions]] - Get a list of invoice transactions

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

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

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

2014-05-14T13:11:01Z

Velimira.metodieva: /* Response */

= 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},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}",
"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.
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== 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,
"theme": "test_theme",
"language": "en_US",
"timezone": "America/Chicago",
"links": [
{
"href": "{APIBaseURL}/accounts/test/email/test.com/usernames/john.smith/webmail/",
"rel": "self"
}
]
}
</nowiki>

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

Email-domain-usernames-mailboxName-webmail:GET

2014-05-14T13:09:35Z

Velimira.metodieva: /* Success getting account type */

= 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},
"theme": "{theme}",
"language": "{language}",
"timezone": "{timezone}",
"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.
; theme - ''string''
: Theme identifier for setting a specific theme when creating an OX account
; language - ''string''
: OpenXchange account locale of type 'en_US'.
; timezone - ''string''
: OpenXchange account timezone of type 'America/Chicago'.

== Examples ==

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

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

{"type": "standard", "allowUpgrade": true, "theme": "test_theme", "language": "en_US", "timezone": "America/Chicago", "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}
</nowiki>

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

Accounts-accountId-invoices-invoiceId-transactions:GET

2014-04-25T13:38:36Z

Velimira.metodieva: /* GET /accounts/{accountId}/invoices/{invoiceID}/transctions */

= GET /accounts/{accountId}/invoices/{invoiceId}/transctions =
Retrieves a list of transactions for a specific account and and invoice
__TOC__

== Request ==
<code>GET /accounts/{accountId}/invoices/{invoiceId}/transctions</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the invoice
; invoiceId - ''string''
: The specific invoice for which the call will retrieve the list

=== URI Parameters ===

; filterFrom - ''date''
: Only transactions having startDate after the value of the parameter will be returned

; filterTo - ''date''
: Only transactions having startDate before the value of the parameter will be returned

; filterType - ''string''
: Only transactions having type matching the value of the parameter will be returned. Possible values are: 'charge', 'credit', 'discount'

; 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 '''amount''', '''from''', '''to'''

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

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

=== Response Body ===
<nowiki>
{
"list": [
{
"startDate": "{startDate}",
"endDate": {endDate},
"currency": {currency},
"amount": "{amount}",
"description": "{description}",
"date": "{date}",
"productSpecification": "{productSpecification}",
"serviceNumber": "{serviceNumber}",
"type": "{type}",
"number": "{number}"
}
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; startDate - ''string''
: Start date of transaction

; endDate - ''string''
: End date of transaction

; currency - ''string''
: Currency of transaction

; amount - ''string''
: Amount of transaction

; description - ''string''
: Description of transaction

; date - ''string''
: Date of transaction

; productSpecification - ''string''
: Product specification of transaction

; serviceNumber - ''string''
: Service number of transaction

; type - ''string''
: Type of transaction. Possible values are: 'charge', 'credit', 'discount'

; number - ''string''
: Number of transaction

; 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-account/invoices/111111/transactions/
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"startDate": "2011-06-19",
"amount": 34.65,
"endDate": "2011-07-18",
"description": "Usage Fee test@test.com Rate Type = Exchange mailbox usage, Usage amount = 7",
"currency": "USD", "date": "2011-11-10",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test-acount-000001311f19185dc1df5d10000a000a000800",
"serviceNumber": "test-account-0000013128ec0f17330329ef000a000a000800",
"type": "charge",
"number": 101378490
},
...
],
"links": [
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=1&pageSize=100", "rel": "self"},
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=2&pageSize=100", "rel": "next"},
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=5&pageSize=100", "rel": "last"}
]
}
</nowiki>

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

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

Account

2014-04-25T12:43:14Z

Velimira.metodieva: /* Invoices */

= 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
* [[Accounts-accountId-Contacts:PUT|PUT /accounts/{accountId}/contacts]] - Set 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

== Payment info ==
* [[Accounts-accountId-paymentInfo:GET|GET /accounts/{accountId}/paymentInfo]] - Get a list of active payment methods
* [[Accounts-accountId-paymentInfo:POST|POST /accounts/{accountId}/paymentInfo]] - Add a payment method for a given account
* [[Accounts-accountId-paymentInfo-default:PUT|PUT /accounts/{accountId}/paymentInfo/default]] - Set the default payment method
* [[Accounts-accountId-paymentInfo-default:DELETE|DELETE /accounts/{accountId}/paymentInfo/default]] - Unset the default payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:GET|GET /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Get information about an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId:DELETE|DELETE /accounts/{accountId}/paymentInfo/{paymentInfoId}]] - Remove an active payment method
* [[Accounts-accountId-paymentInfo-paymentInfoId-payment:POST|POST /accounts/{accountId}/paymentInfo/{paymentInfoId}/payment]] - Make a one-time payment toward the account balance

== Transactions ==
* [[Accounts-accountId-transactionsInfo:GET|GET /accounts/{accountId}/transaction]] - Get a list of account's transactions
* [[Accounts-accountId-transactionsInfo-filtered-type:GET|GET /accounts/{accountId}/transaction?filterType={filterType}]] - Get a list of account's transactions filtered by Transaction type
* [[Accounts-accountId-transactionsInfo-sorted:GET|GET /accounts/{accountId}/transaction?sortField={sortField}]] - Get a list of account's transactions sorted by sortField param

== Invoices ==
* [[Accounts-accountId-invoicesInfo:GET|GET /accounts/{accountId}/invoices]] - Get a list of account's invoices
* [[Accounts-accountId-invoicesInfo-filtered-status:GET|GET /accounts/{accountId}/invoices?filterStatus={filterStatus}]] - Get a list of account's invoices filtered by Invoice status
* [[Accounts-accountId-invoicesInfo-sorted:GET|GET /accounts/{accountId}/invoices?sortField={sortField}]] - Get a list of account's invoices sorted by sortField param

== Invoice Transactions ==
* [[Accounts-accountId-invoices-invoiceId-transactions:GET|GET /accounts/{accountId}/invoices/{invoiceId}/transactions]] - Get a list of invoice transactions

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

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

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

2014-03-28T11:11:25Z

Velimira.metodieva: /* Request Body */

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

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

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

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

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

=== Create mailbox with specified quota===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/john.smith/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.smith/mailbox

{"quota": 85}
</nowiki>

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

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

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

Email-domain-usernames-mailboxName-webmail:PUT

2014-03-28T10:49:16Z

Velimira.metodieva: /* Success updating account type */

= 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''
: If current usage is more than new type quota 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>

=== Failure when downgrading the account due to current usage greater than new quota ===
'''Request'''
<nowiki>
PUT /accounts/test/email/test.com/usernames/john.smith/webmail

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

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

{"message": "Current mailbox usage is larger than the new quota value"}
</nowiki>

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

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

2014-03-28T10:31:20Z

Velimira.metodieva: /* Success updating account type */

Orders

2014-02-28T11:39:57Z

Velimira.metodieva: /* Email Products */

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

== Order Attributes ==
Custom attributes for an Order.
* [[Orders-orderId-attributes:PUT|PUT /orders/{orderId}/attributes]] - Sets order attributes
* [[Orders-orderId-attributes:GET|GET /orders/{orderId}/attributes]] - Returns order attributes

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

= Order Flow Examples =
== Email Products ==
* [[Order-Email-Domain|Order Email Domain]] - Example order flow for purchasing an email domain
* [[Order-Domain-Alias|Order Domain Alias]] - Example order flow for purchasing an email domain alias

== Cloud Products ==
* [[Order-cloud-drive|Order Cloud Drive]] - Example order flow for purchasing a Cloud Drive
* [[Order-cloud-backup|Order Cloud Backup]] - Example order flow for purchasing a Cloud Backup

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

Accounts:GET

2014-02-04T16:04:02Z

Velimira.metodieva: /* Examples */

= GET /accounts =
Retrieves a list of all accounts authorized for access with the provided credentials.
__TOC__
== Request ==
<code>GET /accounts</code>

=== URI Parameters ===
; filterStatus - ''string''
: Optional. Only accounts with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

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

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

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

== Response ==

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

;400 Bad Request
:

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

; 403 Forbidden
: Forbidden access to a user not authorized for such access.

; 415 Unsupported Media Type
: The Content-Type header was not specified or the specified type is not supported. Use application/json.

=== Response Body ===
<nowiki>
{
"list" : [{
"status" : "{status}",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/",
"rel" : "self"
}],
"accountNumber" : "{account-number}",
"createdDate" : "{created-date}"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "last"
}]
}
</nowiki>

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

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

:; accountNumber - ''string''
:: The Id of the account

:; createdDate - ''date''
:: The date account was created in format Y-m-d

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

; links - ''list''
: [[Hypermedia]] Link to self and other resources relevant to the account lists

== Examples ==

=== Listing current account only when provided credentials don't give elevated access ===
'''Request'''
<nowiki>
GET /accounts
</nowiki>

'''Response'''
<nowiki>
{
"list": [{
"status": "open",
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/",
"rel": "self"
}],
"accountNumber": "test-account",
"createdDate": "2009-12-07"
}],
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts",
"rel": "self"
}]
}
</nowiki>

=== Paginated request when more then one account is returned ===
'''Request'''
<nowiki>
GET /accounts?pageSize=2&page=1
</nowiki>

'''Response'''
<nowiki>
{
"list" : [{
"status" : "open",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-1/",
"rel" : "self"
}],
"accountNumber" : "test-account-1",
"createdDate": "2009-12-07"
},
"status" : "closed",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-2/",
"rel" : "self"
}],
"accountNumber" : "test-account-2",
"createdDate": "20012-11-01"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize=2&page=1",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=2",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=11637",
"rel" : "last"
}]
}
</nowiki>

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

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

Accounts-accountId:GET

2014-02-04T15:59:03Z

Velimira.metodieva: /* Parameters */

= GET /accounts/''{accountId}'' =
Get details about an account.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''</code>

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

=== URI Parameters ===
None.

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

== Response ==

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

;403 Forbidden
: Forbidden access to '''closed''' and '''suspended''' accounts by a user not authorized for such access.

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

=== Response Body ===
<nowiki>
{
"accountNumber": "{accountId}",
"cratedDate": "{createdDate}",
"status": "open",
"products": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/products", "rel": "related"}
],
"exchange": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/exchange", "rel": "related"}
],
"dedicatedServers": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/dedicatedServers", "rel": "related"}
],
"contacts": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/contacts", "rel": "related"}
],
"email": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/email", "rel": "related"}
],
"domains": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/domains", "rel": "related"}
],
"attributes": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/attributes", "rel": "related"}
],
"flexcloud": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/flexcloud", "rel": "related"}
],
"user": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/user", "rel": "related"}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/", "rel": "self"}
]
}
</nowiki>

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

; createdDate - ''date''
: The date account was created in format Y-m-d

; status - ''string''
: status of the account. Valid values are '''open''', '''closed''' or '''suspended'''. Accounts with certain status may not be accessible by regular users.

; products - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the products of the account. This value will appear depending on the user's access rights.

; dedicatedServers - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the dedicated server products of the account.

; exchange - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the Exchange domains of the account.

; contacts - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource handling the contact details of the account.

; email - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a resource containing all the email domains of the account.

; domains - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] linking to the domain name management of the account.

; attributes - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to a partner attributes of the account.

; flexcloud - ''list''
: ''(OPTIONAL)''
: [[Hypermedia]] to the Flexcloud management of the account.

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

== Conditional Hypermedia ==
Hypermedia fields marked as optional will appear on the basis of the accessing user's permissions.

== Alternative with partner Id ==
As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute [[Orders-orderId-account-attributes:PUT|partner_account_id]]. The response to this request is the same as the response to a request using the account Id.

<code>GET /partnerAccounts/''{partnerAccountId}''</code>

==== Parameters ====
; partnerAccountId - ''string''
: Partner account Id set via the [[Orders-orderId-account-attributes:PUT|partner_account_id]] attribute.

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

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

Accounts:GET

2014-01-30T11:59:44Z

Velimira.metodieva: /* Paginated request when more then one account is returned */

= GET /accounts =
Retrieves a list of all accounts authorized for access with the provided credentials.
__TOC__
== Request ==
<code>GET /accounts</code>

=== URI Parameters ===
; filterStatus - ''string''
: Optional. Only accounts with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

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

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

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

== Response ==

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

;400 Bad Request
:

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

; 403 Forbidden
: Forbidden access to a user not authorized for such access.

; 415 Unsupported Media Type
: The Content-Type header was not specified or the specified type is not supported. Use application/json.

=== Response Body ===
<nowiki>
{
"list" : [{
"status" : "{status}",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/",
"rel" : "self"
}],
"accountNumber" : "{account-number}"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "last"
}]
}
</nowiki>

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

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

:; accountNumber - ''string''
:: The Id of the account

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

; links - ''list''
: [[Hypermedia]] Link to self and other resources relevant to the account lists

== Examples ==

=== Listing current account only when provided credentials don't give elevated access ===
'''Request'''
<nowiki>
GET /accounts
</nowiki>

'''Response'''
<nowiki>
{
"list": [{
"status": "open",
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/",
"rel": "self"
}],
"accountNumber": "test-account"
}],
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts",
"rel": "self"
}]
}
</nowiki>

=== Paginated request when more then one account is returned ===
'''Request'''
<nowiki>
GET /accounts?pageSize=2&page=1
</nowiki>

'''Response'''
<nowiki>
{
"list" : [{
"status" : "open",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-1/",
"rel" : "self"
}],
"accountNumber" : "test-account-1"
},
"status" : "closed",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-2/",
"rel" : "self"
}],
"accountNumber" : "test-account-2"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize=2&page=1",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=2",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=11637",
"rel" : "last"
}]
}
</nowiki>

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

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