Hostway API Documentation - User contributions [en]

Domain Name Registration

2016-06-17T18:49:06Z

Petre.popescu: /* Reset/Retry domain transfer */

= Domain Name Registration API =
Public API to manage domain name registration records including domain availability check, domain registration, renewal, transfer, whois editing, name server changes, host record creation, locking, additional features, special; registration attributes, domain security, supported TLDs and more.

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Top level domains ==
=== Get a list of available tlds ===
* [[domains-tlds:GET | GET /domains/tlds]] - Get a list of available tlds.
=== Get a list of registry agreements ===
* [[domains-tlds-registryagreements:GET | GET /domains/tlds/registryagreement]] - Get a list of registry agreements
=== Get the additional TLD parameters ===
* [[domains-tlds-extparams:GET | GET /domains/tlds/{tld}/extparams]] - Get info on the extra parameters (if any) for the tld

== Domain Name Availability Check ==
=== Check availability of a domain ===
* [[domains-domainName:GET | GET /domains/{domainName}]] - Check a domain name for availability
=== Name suggestions search (Name Spinner) ===
* [[domains-domainName-namespinner:GET | GET /domains/{domainName}/namespinner]] - Get availability results for suggested names

== Domain Name Transfers ==
=== Check transferability of a domain ===
* [[domains-domainName-transfer:GET | GET /domains/{domainName}/transfer]] - Check a domain name for transferability
=== Get status of pending transfer ===
* [[accounts-accountNumber-domains-transfer-domainName:GET | GET /accounts/{accountNumber}/domains/transfers/{domainName}]] - Check transfer status for a domain

=== Reset/Retry domain transfer ===
* [[accounts-accountNumber-domains-transfer-domainName:PUT | PUT /accounts/{accountNumber}/domains/transfers/{domainName}]] - Reset a domain transfer that is blocked for various reasons

== Ordering domain ==
=== Ordering API ===
* [[OrderingDomain|Ordering Domain]] - Order domain name using the Ordering API
* [[OrderingTransferDomain|Ordering Transfer Domain]] - Order transfer domain name using the Ordering API
=== Order domain shortcut ===
Register
* [[accounts-accountId-domains-domainName:PUT|PUT /accounts/{accountId}/domains/{domainName}]] - Order domain name for an existing account using the "shortcut" command
Transfer
* [[accounts-accountId-transfer-domains-domainNames:PUT|PUT /accounts/{accountId}/domains/{domainName}]] - Order transfer domain name for an existing account using the "shortcut" command

== Domain Name Management ==

=== Search for domains in account ===
* [[accounts-accountNumber-domains:GET | GET /accounts/{accountNumber}/domains]] - Search for domains in client's account.

=== Get domain details ===
* [[domains-domainName-details:GET | GET /domains/{domainName}/details]] - Get information about the given domain name such as creation date, name servers, lock status and whois info.

=== Lock / Unlock ===
* [[domains-domainName-lock:GET | GET /domains/{domainName}/lock]] - Get the current lock status of a domain name
* [[domains-domainName-lock:PUT | PUT /domains/{domainName}/lock]] - Place a lock on a domain name that prevents unauthorized transfer or changes
* [[domains-domainName-lock:DELETE | DELETE /domains/{domainName}/lock]] - Remove a lock on a domain

=== Hold / Unhold ===
* [[domains-domainName-hold:GET | GET /domains/{domainName}/hold]] - Get the current domain hold status.
* [[domains-domainName-hold:PUT | PUT /domains/{domainName}/hold]] - Place a hold on a domain name that prevents the domain from resolving
* [[domains-domainName-hold:DELETE | DELETE /domains/{domainName}/hold]] - Remove a hold on a domain

=== Name Servers ===
* [[domains-domainName-nameservers:GET | GET /domains/{domainName}/nameservers]] - Get the name servers used to serve the DNS of the domain
* [[domains-domainName-nameservers:PUT | PUT /domains/{domainName}/nameservers]] - Change the name servers used to serve the DNS of the domain

=== Whois contacts ===
* [[domains-domainName-contactType:GET|GET /domains/{domainName}/{contactType}]] - Gets the contact info for the specified contact
* [[domains-domainName-contactType:PUT|PUT /domains/{domainName}/{contactType}]] - Changes the contact info of a domain name

=== Domain authorization code ===
* [[domains-domainName-authInfo:GET|GET /domains/{domainName}/authInfo]] - Gets the authorization code (authInfo).
* [[domains-domainName-authInfo:PUT|PUT /domains/{domainName}/authInfo]] - Sets or generates the authorization info

=== Auto-renewal status ===
* [[domains-domainName-autoRenew:GET|GET /domains/{domainName}/autoRenew]] - Gets the current auto-renewal status
* [[domains-domainName-autoRenew:PUT|PUT /domains/{domainName}/autoRenew]] - Sets the auto-renewal status
* [[domains-domainName-autoRenew:OPTIONS|OPTIONS /domains/{domainName}/autoRenew]] - Check whether the auto-renewal status can be set.

=== Domain hosts ===
* [[domains-domainName-hosts:GET|GET /domains/{domainName}/hosts]] - Gets the current hosts
* [[domains-domainName-hosts:PUT|PUT /domains/{domainName}/hosts]] - Replace the hosts
* [[domains-domainName-hosts:POST|POST /domains/{domainName}/hosts]] - Add or update hosts
* [[domains-domainName-hosts:DELETE|DELETE /domains/{domainName}/hosts/{hostName}]] - Delete a host

=== Domain contact verification ===
* [[domains-domainName-contactverification:GET|GET /domains/{domainName}/contactverification]] - Gets the status of the contact verification for {domainName} or Send email contact verification for {domainName}

=== Private registration ===
* [[domains-domainName-privateregistration:GET|GET /domains/{domainName}/privateregistration]] - Gets the privateregistration info for the domain
* [[domains-domainName-privateregistration:POST|POST /domains/{domainName}/privateregistration]] - Update the privateregistration - change forwarding e-mail address, upgrade or downgrade between "full" and "light" version of the privateregistration product.
* [[domains-domainName-privateregistration:DELETE|DELETE /domains/{domainName}/privateregistration]] - Remove the privateregistration

== Renew Domain ==
* [[domains-domainName-renewTerms:GET|GET /domains/{domainName}/renewTerms]] - get available renewal terms and pricing
* [[domains-domainName-renew:POST|POST /domains/{domainName}/renew]] - renew a domain for a specific registration period

== Domain Pricing ==
* [[domains-domainName-prices:GET|GET /domains/{domainName}/prices]] - get domain prices
* [[domains-domainName-prices/register:GET|GET /domains/{domainName}/prices/register]] - get domain register prices
* [[domains-domainName-prices/renew:GET|GET /domains/{domainName}/prices/renew]] - get domain renew prices
* [[domains-domainName-prices/transfer:GET|GET /domains/{domainName}/prices/transfer]] - get domain transfer prices

== Private Registration Availability By TLD ==
* [[domains-domainName-privateregistration-:GET|GET /domains/privateregistration]] - Is private registration available for tld's

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

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

FlexCloud Server

2016-05-25T21:31:07Z

Petre.popescu:

= FlexCloud Server API =
FlexCloud Server is a web service that provides compute capacity in the cloud. It is designed to allow you to quickly scale capacity as your computing requirements change. You can setup and provision [[Server]] Instances and other computing resources in minutes programmatically via the FlexCloud Server API. You have full control over your computing resources and you only pay for what you use.

The base URL for the FlexCloud Server API https://api.hostwayenterprise.com/

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

'''Please feel free to post any feedback and/or questions you may have in the “Comments” section on the bottom of each page.'''

== Flavor ==
A Flavor is a set of resource constraints including RAM, disk size and number of CPUs. They are used to describe [[Server]], [[ServerListDetails]] and [[ServerCreate]].
* [[FlavorList]]
* [[FlavorListDetails]]
* [[Flavor]]

== Image ==
An Image is a disk template that is used to create new servers [[ServerCreate]]. They are also used to inspect running [[ServerListDetails]] and [[Server]] instances.
* [[ImageList]]
* [[ImageListDetails]]
* [[Image]]

== Zone ==
* [[Zone]]

== Server ==
A Server is a virtual machine instance in the cloud infrastructure. [[Flavor]], [[Image]] and [[Zone]] are requisite elements when creating a server.
* [[ServerList]]
* [[ServerListDetails]]
* [[Server]]
* [[ServerCreate]]
* [[ServerActions]]
**[[ServerActionReboot]]
**[[ServerActionStop]]
**[[ServerActionStart]]
**[[ServerActionResize]]
**[[ServerActionAddFlexibleIP]]
**[[ServerActionRemoveFlexibleIP]]
**[[ServerActionUpgradePlesk]]
* [[ListServerIPs]]
* [[AttachVolumeToServer]]
* [[ListVolumeAttachmentsForServer]]
* [[ListVolumeDetailsForServerVolumeAttachment]]
* [[DetachVolumeFromServer]]
* [[ServerMonitoringDetails]]
**[[ServerMonitoringDetailsCPU]]
**[[ServerMonitoringDetailsDisk]]
**[[ServerMonitoringDetailsBandwidth]]
* [[ServerSnapshotList]]
* [[ServerSnapshot]]
* [[ServerSnapshotCreate]]
* [[ServerSnapshotActions]]
** [[ServerSnapshotActionRestore]]
* [[AssignSecurityGroupToServer]]

== Flexible IP ==
A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.
* [[Allocate Flexible IP]]
* [[List Flexible IPs]]
* [[View Allocated Flexible IP]]
* [[Delete Allocated Flexible IP]]

== Volume ==
A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.
* [[Create Volume]]
* [[View Single Volume]]
* [[List Volumes]]
* [[List Volumes Detail]]
* [[Delete Volume]]

== Security/Firewall Group ==
A Security/Firewall Group defines firewall rules for your Server. You have the ability to configure your firewall connections and secure your network as required. You may have one or multiple servers behind a firewall group. Hostway provides a default firewall group, and typical firewall rules are already configured. You can create multiple firewall groups as needed.
* [[Create Firewall Group]]
* [[List Firewall Groups]]
* [[View Firewall Group Details]]
* [[Edit Firewall Group]]
* [[Delete Firewall Group]]
* [[Create Firewall Group Rule]]
* [[List Firewall Group Rules]]
* [[Delete Firewall Group Rule]]

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

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Authentication

2015-10-21T16:41:03Z

Petre.popescu:

Authentication is done with Basic Authentication. It is described in [http://tools.ietf.org/html/rfc2617#section-2 RFC 2617 Section 2].

To access the API using SiteControl credentials, use Users Name in the format <sitecontrol_username>@<domain_key>. Passwords are the same as the SiteControl password.

{|style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
|+Domain Keys
|-
!style="border-style: solid; border-width: 1px"| SiteControl domain || domain_key || API URL
|-
|style="border-style: solid; border-width: 1px"| dev.sitecontrol.spstaging.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_developer_us_main (for account owners), partner_api_developer_us_main (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://dev.api.spstaging.hostway.com
|-
|style="border-style: solid; border-width: 1px"| enterprise.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_hostway_us_enterprise (for account owners), partner_api_hostway_us_enterprise (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://api.hostwayenterprise.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.bwp.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_costco_us_main (for account owners)
|style="border-style: solid; border-width: 1px"| https://api.bwp.hostway.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.cableonehosting.net
|style="border-style: solid; border-width: 1px"| sitecontrol_cableone_us_main (for account owners)
|style="border-style: solid; border-width: 1px"| https://api.cableonehosting.net
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.domainpeople.com
|style="border-style: solid; border-width: 1px"| sitecontrol_domainpeople_us_main (for account owners), partner_api_domainpeople_us_main (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://api.domainpeople.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.officedepot.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_officedepot_us_main (for account owners)
|style="border-style: solid; border-width: 1px"| https://api.officedepot.hostway.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.rpd.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_hostway_us_rpd (for account owners), partner_api_hostway_us_rpd (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://api.rpd.hostway.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.twtelecom.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_xspedius_us_main (for account owners)
|style="border-style: solid; border-width: 1px"| https://api.twtelecom.hostway.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol.valueweb.com
|style="border-style: solid; border-width: 1px"| sitecontrol_valueweb_us_main (for account owners)
|style="border-style: solid; border-width: 1px"| https://api.valueweb.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol-sp.gate.com
|style="border-style: solid; border-width: 1px"| sitecontrol_gate_us_main (for account owners), partner_api_gate_us_main (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://api.gate.com
|-
|style="border-style: solid; border-width: 1px"| sitecontrol-sp.hostway.com
|style="border-style: solid; border-width: 1px"| sitecontrol_hostway_us_main (for account owners), partner_api_hostway_us_main (for franchise-level agents)
|style="border-style: solid; border-width: 1px"| https://api.hostway.com
|-
|}

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

{{disqus}}
[[Category:Common Features]]
[[Category:Hostway API]]

Orders-orderId-account-paymentInfo:PUT

2015-06-17T20:09:18Z

Petre.popescu: /* Offline payment for supported franchises with agent access */

= PUT /orders/''{orderId}''/account/paymentInfo =
Set the account's payment information for a given order.
__TOC__

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

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

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
The request format depends on the type of payment method that is added. The following format is required for credit cards.
<nowiki>
{
"paymentInfoType": "credit_card",
"accountNumber": "4111111111111111",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "2012-08",
"verificationNumber": "123",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

==== Parameters ====
; paymentInfoType - ''string''
: The type of payment method that will be used. Allowed value(s) are:
:: '''credit_card'''
:: '''offline''' (Available only for agents on supported franchises)

; accountNumber - ''string''
: Credit card number. Must consist of numbers only. Required if paymentInfoType is set to '''credit_card'''.

; cardHolderName - ''string''
: The owner name as it appears on the card. Required if paymentInfoType is set to '''credit_card'''.

; creditCardType - ''string''
: The type of credit card - '''visa''', '''mastercard''', '''discover''', '''amex'''. Required if paymentInfoType is set to '''credit_card'''.

; expirationDate - ''string''
: The credit card expiration date in YYYY-MM format. Should exceed the current date. Required if paymentInfoType is set to '''credit_card'''.

; verificationNumber - ''string''
: The credit card security code. This is only used to validate the credit card and will not be stored. Required if paymentInfoType is set to '''credit_card'''.

; billingAddress - ''dictionary''
: Contains the credit card's billing address. Required if paymentInfoType is set to '''credit_card'''.

== Response ==
=== Status Code ===
{| class='wikitable'
|-
! Status Code
! Error Message
! Description
|-
| 204 No Content
| align="center" | -
| The operation was successfully completed.
|-
| rowspan="10" | 400 Bad Request
| rowspan="2" | POST data error
| A required attribute for the payment info type is missing.
|-
| paymentInfoType can only be credit_card.
|-
| declined
| Invalid verificationNumber
|-
| Invalid date format
| Wrong expirationDate format
|-
| rowspan="4" | invalid number or type
| creditCardType can be only one of visa, mastercard, amex, discover.
|-
| Credit card number with wrong length
|-
| Credit card number does not comply with visa rules
|-
| expirationDate set in past
|-
| Incorrect padding
| Hyphens or spaces in credit card number are not allowed
|-
| Input strings must be a multiple of 16 in length
| Credit card number length should be 16.
|-
| 401 Unauthorized
| align="center" | -
| No owner Id specified or the specified owner is not authorized to add payment info.
|-
| 403 Forbidden
| Unauthorized: PaymentInfo failed permission check
| An unauthorized user cannot set or get payment info.
|-
| 404 Not Found
| Resource not found
| The specified order does not exist.
|-
| rowspan="2" | 502 Bad Gateway
| rowspan="2" align="center" | -
| An account has not been added to the given order.
|-
| Unexpected backend error.
|}

=== Response Body ===
None.

== Example ==
=== Success ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName":
"John Jello",
"expirationDate":
"2015-06",
"verificationNumber": "505",
"billingAddress": {
"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

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

=== Offline payment for supported franchises with agent access ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/
Authorization: Basic Auth_String

{
"paymentInfoType": "offline"
}</nowiki>

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

=== Invalid payment info type ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "direct_debit",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName":
"John Jello",
"expirationDate":
"2015-06",
"verificationNumber": "505",
"billingAddress": {
"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "7ca8b2cc-88d5-4e5b-aab8-e4015a5b3ad8",
"message": "POST data error",
"code": 400,
"details": {
"paymentInfoType": "\"direct_debit\" is not one of credit_card, vz_payment"
}
}
}</nowiki>

=== Missing attribute for paymentInfoType credit_card ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"accountNumber": "4111111111111111",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "2012-08",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "2829e9e2-04e1-4fe2-8e05-be738b4c467c",
"message": "POST data error",
"code": 400,
"details": {
"verificationNumber": "Required"
}
}
}</nowiki>

=== Credit card number length exceeds 16 characters ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"accountNumber": "4111-1111-1111-1111",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "2012-08",
"verificationNumber": "505",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "f5ed5738-086d-4751-8ad5-0dfead39ea3a",
"message": "Input strings must be a multiple of 16 in length",
"code": 400,
"details": ""
}
}</nowiki>

=== Credit card number cannot contain hyphens ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"accountNumber": "4111-111-111-111",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "2012-08",
"verificationNumber": "505",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"computeFault": {
"guid": "5a757a5a-870e-4d4f-acdf-aed95e066b3d",
"message": "Incorrect padding",
"code": 400,
"details": ""
}
}</nowiki>

=== Credit card number with wrong length ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"accountNumber": "411111111111111122",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "2012-08",
"verificationNumber": "505",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "ced1a8a8-21dc-4a10-9d36-5a201214a5ce",
"message": "invalid number or type",
"code": 400,
"details": ""
}
}</nowiki>

=== Invalid verification number ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName": "John Jello",
"expirationDate": "2015-06",
"verificationNumber": "0000",
"billingAddress": {"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"computeFault" : {
"guid" : "031b8bc2-8da3-41c7-860c-ca3743cef135",
"message" : "declined",
"code" : 400,
"details" : ""
}
}</nowiki>

=== Invalid date format ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"accountNumber": "4111111111111111",
"cardHolderName": "John Smith",
"creditCardType": "visa",
"expirationDate": "15-06",
"verificationNumber": "505",
"billingAddress": {
"city": "Chicago",
"countryCode": "US",
"postalCode": "60606",
"stateOrProvince": "IL",
"street1": "100 N Riverside",
"street2": ""
}
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "30e66cfe-649c-4b1c-bfaf-c65caf47b99d",
"message": "Invalid date format",
"code": 400,
"details": ""
}
}</nowiki>

=== No authorization ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={wrong_owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName":
"John Jello",
"expirationDate":
"2015-06",
"verificationNumber": "505",
"billingAddress": {
"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
Content-Type : text/plain; charset=UTF-8

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.</nowiki>

=== Unauthorized user ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Authorization: Basic {wrong_user_authorization}

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName":
"John Jello",
"expirationDate":
"2015-06",
"verificationNumber": "505",
"billingAddress": {
"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

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

{
"forbidden": {
"guid": "5a199170-843a-44fc-bbb0-87155eb15fc6",
"message": "Unauthorized: PaymentInfo failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

=== Unset account for the order ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/paymentInfo
Cookie: OwnerId={owner_id}; Path=/

{
"paymentInfoType": "credit_card",
"creditCardType": "visa",
"accountNumber": "4111111111111111",
"cardHolderName":
"John Jello",
"expirationDate":
"2015-06",
"verificationNumber": "505",
"billingAddress": {
"street1": "100 n riverside",
"street2": "ste 800",
"city": "Chicago",
"stateOrProvince": "IL",
"postalCode": "60606",
"countryCode": "US"
}
}</nowiki>

'''Response'''
<nowiki>
502 Bad Gateway
Content-Type : application/json; charset=UTF-8

{
"computeFault": {
"guid": "a4f6b310-11d9-4263-8482-81bccf261df7",
"timestamp": "2014-09-08 08:34:20",
"code": 502,
"errorRefId":
"a4f6b310-11d9-4263-8482-81bccf261df7"
}
}</nowiki>
== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

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

Pagination

2015-06-16T21:16:18Z

Petre.popescu: /* Sample response */

Large resources lists require pagination. Pagination is controlled by two query parameters, '''page''' and '''pageSize'''. If they are not specified (meaning, the client is requesting the full list), the API will attempt to return the full list. If there are more than 100 elements in the full list, the API will instead return a response code of 303 "See Other", with a '''Location''' header in the response containing the URL for the first page of the equivalent paginated call (where pageSize = 100).

'''GET''' /<url>?page=1&pageSize=20

;page
: ''Optional'' The 1-based index of the page of results requested. '''page''' is required if '''pageSize''' has been provided.

;pageSize
: ''Optional'' The maximum number of resources to be returned on each page of the paginated request. This value cannot currently exceed 400; any requests with pageSize > 400 will result in a response code of 303 "See Other", with a '''Location''' header in the response containing the URL for the same page of a paginated call with pageSize=400. '''pageSize''' is required if '''page''' has been provided.

== Sample response ==

<nowiki>
{
"list": [
{... resource 1 ...},
{... resource 2 ...},
...
],
"links": [
{"rel": "self", "href": "/<url>?page=5&pageSize=20"},
{"rel": "previous", "href": "/<url>?page=4&pageSize=20"},
{"rel": "first", "href": "/<url>?page=1&pageSize=20"},
{"rel": "next", "href": "/<url>?page=6&pageSize=20"},
{"rel": "last", "href": "/<url>?page=231&pageSize=20"},
]
}
</nowiki>

The '''previous''' and '''first''' links will be omitted if the current page is the first page, and the '''next''' and '''last''' links will be omitted if the current page is the last page.

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

{{disqus}}
[[Category:Common Features]]
[[Category:Hostway API]]

Release 108

2015-06-12T15:15:14Z

Petre.popescu:

= Release 108 - 07/01/2015 =
List of changes in Release 108.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this article as a PDF book]

== New API calls ==

== Modified API calls ==

[[Accounts-accountId-paymentInfo-default:DELETE|DELETE /accounts/{accountId}/paymentInfo/default]]: Going forward, this call will only be accessible by users with Agent roles ("Sales User", "Sales Manager", "Partner Sales User"). Users without one of these roles will receive a response code of 403 (Forbidden) when attempting to make this call. Additionally, a response code of 403 will also be returned if the franchise does not support offline payments (checks, cash, credit card over the phone, etc.) as a form of payment.

{{disqus}}
[[Category:Release Notes]]

ServiceAttributes-core.cloud.hscc

2015-04-30T16:28:42Z

Petre.popescu:

= Cloud Compute Service Attributes =
Attributes used when configuring the Cloud computing service:
__TOC__

== Attributes Body ==
<nowiki>
{
"accountNumber": "acct123456",
}
</nowiki>

==== Parameters ====
; accountNumber
: The account Number of the Hostway account.

== See also ==
* [[ServiceAttributesStructure|Service Attributes Structure]]
* [[Orders|Orders API]]
* [[Account|Account Management API]]

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

Accounts-accountId-attributes:POST

2015-04-28T18:22:58Z

Petre.popescu: /* Status Code */

= POST /accounts/''{accountId}''/attributes =
Get attributes list.
__TOC__
== Request ==
<code>POST /accounts/''{accountId}''/attributes</code>

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

=== URI Parameters ===
None.

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

; Content-Type
: application/json

=== Request Body ===
<nowiki>
{
"name": "test_attribute",
"value": "value"
}
</nowiki>

==== Parameters ====
; name - ''string''
: Descriptive name of the attribute

; value - ''dictionary''
: Value of the attribute

== Response ==

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

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

; 404 Not Found
: The account Id or attribute were not found.

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
POST /accounts/account-id/attributes

{"name": "test_Account", "value": "test"}
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
POST /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)

{"name": "test_Account", "value": "test"}
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Failure creating attribute for not existing account ===
'''Request'''
<nowiki>
POST /accounts/not-existing-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"name": "test_Account", "value": "test"}
</nowiki>

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

=== Success scenario ===
'''Request'''
<nowiki>
POST /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"name": "test_Account", "value": "test"}
</nowiki>

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

</nowiki>

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

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

Accounts-accountId-attributes-attribute:GET

2015-04-28T18:22:42Z

Petre.popescu: /* Status Code */

= GET /accounts/''{accountId}''/attributes/''{attribute}'' =
Get attribute data.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/attributes/''{attribute}''</code>

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

=== URI Parameters ===
; attribute - ''string''

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

; Content-Type
: application/json

== Response ==

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

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

; 404 Not Found
: The account Id or attribute were not found.

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

=== Response Body ===
<nowiki>
{
"name": "{name}",
"value": {value},
"links": [
{
"location": "{APIBaseURL}/accounts/{accountId}/attributes/{attribute}/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; name - ''string''
: Descriptive name of the attribute

; value - ''string''
: Value of the attribute

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
GET /accounts/account-id/attributes/test_attribute
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
GET /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Requesting not existing attribute ===
'''Request'''
<nowiki>
GET /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

=== Success scenario ===
'''Request'''
<nowiki>
GET /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

{
"name": "test_attribute",
"value": "123",
"links": [{"href": "{{APIBaseURL}}/accounts/account-id/attributes/test_attribute/", "rel": "related"}]
}
</nowiki>

== See also ==
* [[PartnerAccounts-partnerAccountId-attributes-attribute:GET|Partner Account Attributes Management]]
* [[Account|Account Management API]]
* [[Common Features]]

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

Accounts-accountId-attributes-attribute:PUT

2015-04-28T18:22:30Z

Petre.popescu: /* Status Code */

= PUT /accounts/''{accountId}''/attributes/''{attribute}'' =
Updates attribute value.
__TOC__
== Request ==
<code>PUT /accounts/''{accountId}''/attributes/''{attribute}''</code>

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

=== URI Parameters ===
; attribute - ''string''

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

; Content-Type
: application/json

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

==== Parameters ====
; value - ''string''

== Response ==

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

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

; 404 Not Found
: The account Id or attribute were not found.

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
PUT /accounts/account-id/attributes/test_attribute

{"value": "test"}
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
PUT /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)

{"value": "test"}
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Failure updating not existing attribute ===
'''Request'''
<nowiki>
PUT /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"value": "test"}
</nowiki>

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

=== Failure updating attribute with missing required value ===
'''Request'''
<nowiki>
PUT /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{}
</nowiki>

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

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

=== Success scenario ===
'''Request'''
<nowiki>
PUT /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"value": "test"}
</nowiki>

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

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

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

Accounts-accountId-attributes-attribute:DELETE

2015-04-28T18:22:15Z

Petre.popescu: Created page with "= DELETE /accounts/''{accountId}''/attributes/''{attribute}'' = Updates attribute value. __TOC__ == Request == <code>DELETE /accounts/''{accountId}''/attributes/''{attribute}'..."

= DELETE /accounts/''{accountId}''/attributes/''{attribute}'' =
Updates attribute value.
__TOC__
== Request ==
<code>DELETE /accounts/''{accountId}''/attributes/''{attribute}''</code>

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

=== URI Parameters ===
; attribute - ''string''

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

; Content-Type
: application/json

== Response ==

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

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

; 404 Not Found
: The account Id or attribute were not found.

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
DELETE /accounts/account-id/attributes/test_attribute
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
DELETE /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Failure updating not existing attribute ===
'''Request'''
<nowiki>
DELETE /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

=== Success scenario ===
'''Request'''
<nowiki>
DELETE /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

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

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

Accounts-accountId-attributes:GET

2015-04-28T18:13:33Z

Petre.popescu: Created page with "= GET /accounts/''{accountId}''/attributes = Get attributes list. __TOC__ == Request == <code>GET /accounts/''{accountId}''/attributes</code> ==== Parameters ==== ; accountId..."

= GET /accounts/''{accountId}''/attributes =
Get attributes list.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/attributes</code>

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

=== URI Parameters ===
None.

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

; Content-Type
: application/json

== Response ==

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

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

; 404 Not Found
: The account Id or attribute were not found.

; 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": [
"name": "{name}",
"value": "{value}",
"links" : [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/attributes/{name}", "rel": "related"}]
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/attributes", "rel": "self"}
]
}
</nowiki>

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

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

:; value - ''string''
:: Value of the attribute

: NOTE: The "partner_account_id" attribute will not be returned in this list.

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

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
GET /accounts/account-id/attributes
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Getting list of attributes of not existing account ===
'''Request'''
<nowiki>
GET /accounts/not-existing-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

=== Success scenario ===
'''Request'''
<nowiki>
GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

{
"list": [
{
"name": "test_attribute",
"value": "123",
"links": [{"href": "{{APIBaseURL}}/accounts/account-id/attributes/test_attribute/", "rel": "related"}]
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-id/attributes/",
"rel": "self"
}
]
}
</nowiki>

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

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

PartnerAccounts-partnerAccountId-attributes:GET

2015-04-28T16:34:27Z

Petre.popescu: /* Parameters */

= GET /partnerAccounts/''{partnerAccountId}''/attributes =
Get attributes list.
__TOC__
== Request ==
<code>GET /partnerAccounts/''{partnerAccountId}''/attributes</code>

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

=== URI Parameters ===
None.

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

; Content-Type
: application/json

== Response ==

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

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

; 404 Not Found
: The partner account Id or attribute were not found.

; 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": [
"name": "{name}",
"value": "{value}",
"links" : [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/partnerAccounts/{partnerAccountId}/attributes/{name}", "rel": "related"}]
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/partnerAccounts/{partnerAccountId}/attributes", "rel": "self"}
]
}
</nowiki>

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

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

:; value - ''string''
:: Value of the attribute

: NOTE: The "partner_account_id" attribute will not be returned in this list.

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

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
GET /partnerAccounts/partner-account-id/attributes
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
GET /partnerAccounts/partner-account-id/attributes
Authorization: Basic base64_encode(username:password)
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Getting list of attributes of not existing partner ===
'''Request'''
<nowiki>
GET /partnerAccounts/not-existing-partner-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

=== Success scenario ===
'''Request'''
<nowiki>
GET /partnerAccounts/partner-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

{
"list": [
{
"name": "test_attribute",
"value": "123",
"links": [{"href": "{{APIBaseURL}}/partnerAccounts/partner-account-id/attributes/test_attribute/", "rel": "related"}]
}
],
"links": [
{
"href": "{{APIBaseURL}}/partnerAccounts/partner-account-id/attributes/",
"rel": "self"
}
]
}
</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId:GET

2014-12-18T14:54:30Z

Petre.popescu:

= GET /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Get details about a specific service in a given product.
__TOC__

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

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

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

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The services for the order and product (if any) are successfully returned.
|-
| 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.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 403 Forbidden
| Unauthorized: Services failed permission check
| The client does not have assess to get the information about the service.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the information for a service for non existing order, product or service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
{
"status": "new",
"name": "john.smith1",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/",
"rel": "self"
}
],
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{relatedServiceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}</nowiki>

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

; name - ''string''
: The name of the specific service

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

; relatedTo - ''list''
: A list containing other services related in some way to the current service

; serviceSpecification - ''string''
: Link to the product catalogue specification describing the given service

; billingCycle - ''integer''
: Billing cycle of the service. Allowed values are from '''1''' to '''120'''

; attributes - ''string''
: A link to the attributes of the service

==== Error responses ====
<nowiki>
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.</nowiki>

<nowiki>
403 Forbidden - the client does not have assess to get the information about the service.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order, product or service doesn't exist.
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Email-secretQuestionSettings:GET

2014-12-02T17:14:11Z

Petre.popescu: /* Parameters */

= GET /email/secretQuestionSettings =
Get franchise specific secret question settings (e.g. '''minimum''' required number of secret questions, etc.)

__TOC__

== Request ==
<code>GET /email/secretQuestionSettings</code>

== Response ==

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

=== Response Body ===
Retrieves dictionary of secret question settings.
<nowiki>
{
"minimum": 1,
"links": [
{
"location": "</nowiki>{{APIBaseURL}}<nowiki>/email/secretQuestionSettings",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; minimum - ''integer''
:A minimum number of secret questions/answers pairs required to be on file for each email account.
:The minimum value for this parameter is one.
; links - ''list''
:[[Hypermedia]] to the secret question settings resource

== Examples ==

=== Success getting secret question settings ===
'''Request'''
<nowiki>
GET /email/secretQuestionSettings
</nowiki>

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

{
"minimum": 3,
"links": [
{
"location": "</nowiki>{{APIBaseURL}}<nowiki>/email/secretQuestionSettings",
"rel": "self"
}
]
}
</nowiki>

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

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

2014-11-05T21:15:34Z

Petre.popescu:

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

__TOC__

== Request ==
<code>DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}</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)

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

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

2014-09-15T16:11:23Z

Petre.popescu:

= DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/promotion =
Remove promotion code for a service in an order.
__TOC__

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

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

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

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

=== Query String Parameters ===
None.

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

{{Cookie-OwnerId}}

== Response ==
=== Status Code ===
{| class='wikitable'
|-
! Status Code
! Error Message
! Description
|-
| 204 No Content
| align="center" | -
| The operation was successfully completed.
|-
| rowspan="2" | 401 Unauthorized
| rowspan="2" align="center" | -
| No owner Id specified or the specified owner is not authorized to delete the promotion code.
|-
| Only authenticated users may access the order, and no authentication header provided for the current request.
|-
| rowspan="2" | 404 Not Found
| rowspan="2" | Resource not found
| Order does not exist.
|-
| Product or service does not exist.
|-
| 502 Bad Gateway
| align="center" | -
| Unexpected backend response. Cannot delete promotion code.
|}

== Example ==
=== Successfully remove a promotion code for service ===
'''Request'''
<nowiki>
DELETE /orders/{order_id}/account/products/{product_id}/services/{service_id}/promotion
Cookie: OwnerId={owner_id}; Path=/</nowiki>

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

=== No authorization ===
'''Request'''
<nowiki>
DELETE /orders/{orderId}/account/products/{product_id}/services/{serviceId}/promotion
Cookie: OwnerId={wrong_owner_id}; Path=/
</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
Content-Type : text/plain; charset=UTF-8

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.</nowiki>

=== Service does not exist ===
'''Request'''
<nowiki>
DELETE /orders/{order_id}/account/products/{product_id}/services/{non_existing_service_id}/promotion
Cookie: OwnerId={owner_id}; Path=/</nowiki>

'''Response'''
<nowiki>
404 Not found
Content-Type : application/json; charset=UTF-8

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

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

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

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

2014-09-15T16:09:13Z

Petre.popescu:

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

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

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

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

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

=== Query String Parameters ===
None.

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

{{Cookie-OwnerId}}

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

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

== Response ==
=== Status Code ===
{| class='wikitable'
|-
! Status Code
! Error Message
! Description
|-
| 204 No Content
| align="center" | -
| The operation was successfully completed.
|-
| 400 Bad Request
| POST data error
| promoCode was not provided.
|-
| rowspan="2" | 401 Unauthorized
| rowspan="2" align="center" | -
| No owner Id specified or the specified owner is not authorized to add the promotion code.
|-
| Only authenticated users may access the order, and no authentication header provided for the current request.
|-
| rowspan="2" | 404 Not Found
| rowspan="2" | Resource not found
| Order does not exist.
|-
| Product or service does not exist.
|-
| 502 Bad Gateway
| align="center" | -
| Unexpected backend response. Cannot apply promotion code.
|}

== Example ==
=== Successfully add a promotion code for service ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/products/{product_id}/services/{serviceId}/promotion
Cookie: OwnerId={owner_id}; Path=/

{
"promoCode": "ThanksgivingPriceDrop"
}</nowiki>

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

=== Missing promoCode field ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/products/{product_id}/services/{serviceId}/promotion
Cookie: OwnerId={owner_id}; Path=/

{
"code": "ThanksgivingPriceDrop"
}</nowiki>

'''Response'''
<nowiki>
400 Bad Request
Content-Type : application/json; charset=UTF-8

{
"badRequest": {
"guid": "{guid}",
"message": "Resource not found",
"code": 400,
"details": {
"promoCode": "Required"
}
}
}</nowiki>

=== No authorization ===
'''Request'''
<nowiki>
PUT /orders/{orderId}/account/products/{product_id}/services/{serviceId}/promotion
Cookie: OwnerId={wrong_owner_id}; Path=/

{
"promoCode": "ThanksgivingPriceDrop"
}</nowiki>

'''Response'''
<nowiki>
401 Unauthorized
Content-Type : text/plain; charset=UTF-8

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.</nowiki>

=== Order does not exist ===
'''Request'''
<nowiki>
PUT /orders/{non-existing_orderId}/account/products/{product_id}/services/{serviceId}/promotion
Cookie: OwnerId={owner_id}; Path=/

{
"promoCode": "ThanksgivingPriceDrop"
}</nowiki>

'''Response'''
<nowiki>
404 Not found
Content-Type : application/json; charset=UTF-8

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

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

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

Email Validation:POST

2014-06-19T18:22:20Z

Petre.popescu:

POST /validations/email

Validate a registered email.

__TOC__
== Request ==
<code>POST /validations/email/</code>

==== Parameters ====
None.

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: application/json

=== Request Body ===
<nowiki>
{
"authString": "{authentication_token}",
"v": "{initialization_vector}"
}
</nowiki>

==== Parameters ====
; authString - ''string''
: Authentication token

; v - ''string''
: Initialization vector

== Response ==

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

; 404 Bad Request
: One of the required attributes is missing from the request body.

; 409 Conflict
: The supplied authentication token is invalid or expired.

== Example ==

=== Success scenario ===
'''Request'''
<nowiki>
POST /validations/email
Content-Type: application/json

{"authString": "{authentication_token}", "v": "{authentication_vector}"}
</nowiki>

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

</nowiki>

=== Invalid authentication token scenario ===
'''Request'''
<nowiki>
POST /validations/email
Content-Type: application/json

{"authString": "{invalid_authentication_token}", "v": "{authentication_vector}"}
</nowiki>

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

</nowiki>

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

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

DELETE Exchange Mailbox

2014-05-21T11:34:56Z

Petre.popescu:

= DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{useName}'' =
Deletes an Exchange mailbox. The deletion process is asynchronous.

__TOC__

== Request ==
<code>DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{userName}''</code>

==== Request Parameters ====
; accountNumber - ''string''
: the account number of the mailbox owner

; domaiName - ''string''
: the domain name of the mailbox

; userName - ''string''
: the username of the mailbox

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

=== Request Body ===
None

== Response ==

=== Status Code ===
; 202 - ''Accepted''
: the deletion request has been accepted.

; 401 - ''Unauthorized''
: the Authorization credentials are wrong or missing.

; 403 - ''Forbidden''
: the user has been authorized. However, they are not allowed to access the resource. The only user(s) who has access to an Exchange mailbox must be a sales agent or the account owner, or the account technical admin.

; 404 - ''Not Found''
: the mailbox does not exist.

; 409 - ''Conflict''
: the deletion request was rejected due to conflict. Mailboxes with '''pending''', '''close_pending''', '''purge_pending''' status cannot be deleted.

== Examples ==

=== Delete an existent '''open''' or '''closed''' mailbox ===
'''Request'''
<nowiki>
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
</nowiki>

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

no-body
</nowiki>

=== Delete an existent '''pending''' mailbox ===
'''Request'''
<nowiki>
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
</nowiki>

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

{
"conflict" : {
"guid" : "<generated_value>",
"message" : "Cannot delete pending mailboxes",
"code" : 409,
"details" : ""
}
}
</nowiki>

== See also ==

* [[Exchange#Mailbox_Operations|Exchange Mailbox Operations]]
* [[Common Features]]

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

Orders

2014-05-15T11:27:25Z

Petre.popescu: /* Microsoft Exchange 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 =
== Order Account Associations ==
* [[Order-Products-Account|Order Products Account]] - Example order flow with adding initially products and than account
* [[Order-Products-Account-Modify|Order Products Account Modify]] - Example order flow with adding initially products than account and modify it later

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

== Microsoft Exchange Products ==
* [[Order-Exchange|Order Exchange domain]] - Example order flow for purchasing exchange domain
* [[Order-Exchange-mailbox-free|Order Free Exchange Mailbox]]
* [[Order-Exchange-mailbox-paid|Order Paid Exchange Mailbox]]
* [[Order-Exchange-otherproduct|Ordering Other Exchange Products]] - Example order flow that applies to Exchange email encryption, archiving, mailing list and blackberry products

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

== WebsPlanet Products ==
* [[Order-webs-planet|WebsPlanet]] - Example order flow for purchasing a WebsPlanet

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

GET Exchange

2014-05-14T13:45:46Z

Petre.popescu:

= GET /accounts/{accountNumber}/exchange/{domainName} =

Retrieve an Exchange resource by domain name

__TOC__

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

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

; domainName - ''string''
: the domain name under which Exchange is provisioned

=== URI Parameters ===
None.

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

== Response ==

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

;304 Cached
: The resource has not been modified since the client cached it; the client should use the version in its cache

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

;404 Not Found
: The account or payment info was not found

;405 Unsupported Method
: The request method is not supported by this resource

=== Response Headers ===
None.

=== Response Body ===
<nowiki>
{
"domain": "{domainName}",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/",
"rel": "self"
}
],
"mailboxes": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/mailboxes/",
"rel": "related"
}
],
"globalContacts": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/globalContacts/",
"rel": "related"
}
],
"mailingLists": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/exchange/{domainName}/mailingLists/",
"rel": "related"
}
],
"version": "2010"
}
</nowiki>

==== Parameters ====
; domainName - ''string''
: The domain name under which Exchange is provisioned

; accountNumber - ''string''
: The ServicePlex account number

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

Accounts-accountId-Contacts:PUT

2014-04-09T20:12:34Z

Petre.popescu:

= PUT /accounts/''{accountId}''/contacts =
Set the contact details for an account
__TOC__

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

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

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"regular": {
"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}"
},
"billing": {
"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}"
},
"administrator": {
"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}"
},
"technical": {
"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 ====
Note, there are 4 types of contact information that must be sent with the request: "regular", "billing", "administrator" and "technical". All 4 are required.

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

; company - ''string''
: ''(OPTIONAL)''
: May be up to 200 characters long. May contain only alphanumerics, 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 alphanumerics, white space and the following characters: -.'

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

; middleName - ''string''
: ''(OPTIONAL)''
: May be up to 50 characters long. If provided, may contain only alphanumerics, 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 alphanumerics, 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 alphanumerics, 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 alphanumerics, 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

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

{
"regular": {
"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": ""
},
"billing": {
"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": ""
},
"administrator": {
"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": ""
},
"technical": {
"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>

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

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

Accounts-accountId-Contacts:GET

2014-04-09T20:12:31Z

Petre.popescu:

= GET /accounts/''{accountId}''/contacts =
Get contact details for an account.
__TOC__

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

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

=== 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
: The specified account Id does not exist or is purged.

=== Response Body ===
<nowiki>
{
"regular": {
"city": "Chicago",
"company": "Widget Corp.",
"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": ""
},
"billing": {
"city": "Chicago",
"company": "Widget Corp.",
"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": ""
},
"administrator": {
"city": "Chicago",
"company": "Widget Corp.",
"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": ""
},
"technical": {
"city": "Chicago",
"company": "Widget Corp.",
"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>

== Examples ==

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

''Response''
<nowiki>
200 OK

{
"regular": {
"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": ""
},
"billing": {
"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": ""
},
"administrator": {
"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": ""
},
"technical": {
"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>

=== Request for non-existent account Id ===
''Request''
<nowiki>
GET /accounts/{fake_account_number}/contacts
Authorization: Basic {Base64-encoded username & password string}
</nowiki>

''Response''
<nowiki>
404 Not Found

{
"itemNotFound": {
"message": "/accounts/fake-account-id/contacts",
"code": 404,
"details": ""
}
}
</nowiki>

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

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

Accounts-accountId-paymentInfo-paymentInfoId:DELETE

2014-03-25T19:12:22Z

Petre.popescu: /* Status Code */

= DELETE /accounts/''{accountId}''/paymentInfo/''{paymentInfoId}'' =
Removes a given payment method. If the payment method is the current default, it cannot be removed

__TOC__
== Request ==
<code>DELETE /accounts/''{accountId}''/paymentInfo/''{paymentInfoId}'' </code>

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

; paymentInfoId - ''string''
: The Id of the payment method.

=== URI Parameters ===
None.

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

=== Request Body ===
None.

== Response ==

=== Status Code ===
; 204 No Content
: Successful removal

; 403 Forbidden
: The current user is not allowed to delete this payment method

; 404 Not Found
: The account or payment info was not found

; 409 Conflict
: Cannot delete the current default payment method

=== Response Body ===
None.

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

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

Orders-orderId-attributes:PUT

2014-01-29T22:05:39Z

Petre.popescu: Created page with "= PUT /orders/''{orderId}''/attributes = Set the list of attributes for an order. __TOC__ == Request == <code>PUT /orders/''{orderId}''/attributes</code> ==== Request Parame..."

= PUT /orders/''{orderId}''/attributes =
Set the list of attributes for an order.
__TOC__

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

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

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
[
{
"name": "{attributeName}",
"value": "{attributeValue}"
},
{
"name": "{attributeName}",
"value": "{attributeValue}"
}
]
</nowiki>

==== Parameters ====
; attributeName - ''string''
: The unique name of the attribute. The list of supported attribute names is specific to the franchise. The common attributes include:
:: '''AffiliateId''' - identifies an affiliate.

; attributeValue - ''string''
: The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.

== Response ==

=== Status Code ===
;204 No Content : The order attributes were successfully set.

;400 Bad Request : The request body format is invalid, the attribute name is not supported by the franchise, the attribute value is invalid (e.g: too long, contains invalid characters, etc).

;404 Not Found : The specified order does not exist.

;502 Bad Gateway : A critical (unknown) error occurred.

=== Response Body ===
None.

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

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

Miscellaneous

2013-12-04T14:40:28Z

Petre.popescu: /* Supported User Roles */

= Miscellaneous APIs =
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Geographical Locations ==
* [[Countries:GET|GET /countries]] - Returns list of all supported countries
* [[Countries-countryCode-provinces:GET|GET /countries/{countryCode}/provinces]] - Returns list of supported provinces or

== Supported Salutations ==
* [[Salutations:GET|GET /salutations]] - Returns list of supported salutations

== Supported User Roles ==
* [[Roles:GET|GET /roles]] - Returns list of supported user roles

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

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

Orders-orderId-account-contactInfo-contactType:GET

2013-12-04T14:25:47Z

Petre.popescu:

= GET /orders/''{orderId}''/account/contactInfo/''{contactType}'' =
Get specific contact type details for an account in a given order.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/contactInfo/''{contactType}''</code>

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

;contact_type - ''string''
: Contact Type (regular, billing, administrative or technical)

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
;200 OK
: The operation was successfully completed.

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

=== Response Body ===
<nowiki>
{
"contactInfo": {
"name": {
"salutation": "{salutation}",
"firstName": "{firstname}",
"middleName": "{middleName}",
"lastName": "{lastName}",
"company": "{company}"
},
"address": {
"street1": "{street1}",
"street2": "{street2}",
"city": "{city}",
"stateOrProvince": "{stateOrProvince}",
"postalCode": "{postalCode}",
"countryCode": "{countryCode}"
},
"contactMedia": {
"phone1": "{phone1}",
"phone2": "{phone2}",
"fax": "{fax}",
"email1": "{email1}",
"email1Format": "{html|text}",
"email2": "{email2}",
"email2Format": "{html|text}"
}
},
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/contactInfo/{contactType}/", "rel": "self"}]}
]
}
</nowiki>

==== Parameters ====
; salutation
: Contact's salutation

; firstName
: Contact's first name.

; middleName
: Contact's middle name (optional).

; lastName
: Contact's last name.

; company
: Contact's company name (optional).

; street1
: Contact's street address.

; street2
: Contact's street address second line (optional).

; city
: Contact's city.

; stateOrProvince
: Contact's state or province.

; postalCode
: Contact's postal or ZIP code.

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

; phone1
: Contact's primary phone number in ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] format.

; phone2
: Contact's secondary phone number in ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] format (optional).

; fax
: Contact's fax number in ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] format (optional).

; email1
: Contact's primary e-mail address.

; email1Format
: Primary e-mail delivery format: ''html'' or ''text''.

; email2
: Contact's secondary e-mail address (optional).

; email2Format
: Secondary e-mail delivery format: ''html'' or ''text'' (optional).

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

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

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

Accounts-accountId-Contacts:GET

2013-12-04T14:11:28Z

Petre.popescu:

= GET /accounts/''{accountId}''/contacts =
Get contact details for an account.
__TOC__

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

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

=== URI Parameters ===
None.

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

== Response ==

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

;404 Not Found
: The specified account Id does not exist or is purged.

=== Response Body ===
<nowiki>
{
"regular": {
"city": "Chicago",
"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": ""
},
"billing": {
"city": "Chicago",
"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": ""
},
"administrator": {
"city": "Chicago",
"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": ""
},
"technical": {
"city": "Chicago",
"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>

== Examples ==

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

''Response''
<nowiki>
200 OK

{
"regular": {
"city": "Chicago",
"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": ""
},
"billing": {
"city": "Chicago",
"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": ""
},
"administrator": {
"city": "Chicago",
"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": ""
},
"technical": {
"city": "Chicago",
"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>

=== Request for non-existent account Id ===
''Request''
<nowiki>
GET /accounts/{fake_account_number}/contacts
Authorization: Basic {Base64-encoded username & password string}
</nowiki>

''Response''
<nowiki>
404 Not Found

{
"itemNotFound": {
"message": "/accounts/fake-account-id/contacts",
"code": 404,
"details": ""
}
}
</nowiki>

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

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

Accounts-accountId-users-userName-roles:GET

2013-11-13T18:22:18Z

Petre.popescu: Created page with "= GET /accounts/{accountId}/users/{userName}/roles = Retrieve the roles of a user __TOC__ == Request == <code>GET /accounts/{accountId}/users/{userName}/roles</code> ==== Re..."

= GET /accounts/{accountId}/users/{userName}/roles =
Retrieve the roles of a user
__TOC__

== Request ==
<code>GET /accounts/{accountId}/users/{userName}/roles</code>

==== Request Parameters ====
;accountId - ''string''
: The Id of the account
;userName - ''string''
: The username of the user

=== URI Parameters ===
None

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

== Response ==

=== Status Code ===
;200 OK
: Success
;304 Not changed
: The user's roles haven't changed since the last request; the client should use its locally cached copy
;401 Unauthorized
: Authentication failed
;403 Forbidden
: Authentication succeeded, but the authenticated user is not allowed to view this user's roles. The only authenticated users allowed to view these roles are ''this very user'', the account owner(s) of ''this'' account, and sales/support agents. An account owner is a user within the account that has the role "sitecontrol_account_owner".
;404 Not found
: Either the account or the requested user does not exist.

=== Response Body ===
<nowiki>
{
"list": [
"role1",
"role2"
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/users/{userName}/roles", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
;accountId
: The ID of the account
;userName
: The username of this user

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

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

Accounts-accountId-users-userName:DELETE

2013-11-13T18:02:24Z

Petre.popescu: Created page with "= DELETE /accounts/{accountId}/users/{userName} = Delete a user __TOC__ == Request == <code>DELETE /accounts/{accountId}/users/{userName}</code> ==== Request Parameters ====..."

= DELETE /accounts/{accountId}/users/{userName} =
Delete a user
__TOC__

== Request ==
<code>DELETE /accounts/{accountId}/users/{userName}</code>

==== Request Parameters ====
;accountId - ''string''
: The Id of the account
;userName - ''string''
: The username of the user to delete

=== URI Parameters ===
None

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

== Response ==

=== Status Code ===
;204 No Content
: User was successfully deleted
;401 Unauthorized
: Authentication failed
;403 Forbidden
: Authentication succeeded, but the authenticated user is not allowed to delete this user resource. The only authenticated users allowed to delete this user resource are the account owner(s) of ''this'' account, and sales/support agents. Account owners cannot delete themselves. An account owner is a user within the account that has the role "sitecontrol_account_owner".
;404 Not found
: Either the account or the requested user does not exist.

=== Response Headers ===
None

=== Response Body ===
None

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

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

Accounts-accountId-users:GET

2013-11-13T17:17:06Z

Petre.popescu:

= GET /accounts/''{accountId}''/users =
Returns a list of users in an account
__TOC__

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

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

=== URI Parameters ===
None

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

== Response ==

=== Status Code ===
;200 OK
: Success
;304 Not changed
: The list of users hasn't changed since the last request; the client should use its locally cached copy instead.
;401 Unauthorized
: The authorization header contained an invalid value
;403 Forbidden
: Successfully authenticated, but client is not allowed to view the list of users. Access is only permitted for agents and account owners of this account. An account owner is a user with the "sitecontrol_account_owner" role.
;404 Not Found
: The account in question does not exist

=== Response Body ===
<nowiki>
{
"list": [
{
"userName": "{userName}",
"details": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/users/{userName}"
},
...
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/users", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
;accountNumber
: the Id of the account
;userName
: the username of the user

== See Also ==
* [[Account]]
* [[Common Features]]

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

Orders-orderId-account-contactInfo-contactType:PUT

2013-06-25T16:19:48Z

Petre.popescu:

= PUT /orders/''{orderId}''/account/contactInfo/''{contactType}'' =
Set the account contact details for a given contact type in an order.
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/contactInfo/''{contactType}''</code>

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

;contact_type - ''string''
: Contact Type (regular, billing, administrator or technical)

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"name": {
"firstName": "{firstname}",
"middleName": "{middleName}",
"lastName": "{lastName}",
"company": "{company}"
},
"address": {
"street1": "{street1}",
"street2": "{street2}",
"city": "{city}",
"stateOrProvince": "{stateOrProvince}",
"postalCode": "{postalCode}",
"countryCode": "{countryCode}"
},
"contactMedia": {
"phone1": "{phone1}",
"phone2": "{phone2}",
"fax": "{fax}",
"email1": "{email1}",
"email1Format": "{html|text}",
"email2": "{email2}",
"email2Format": "{html|text}"
}
}
</nowiki>

==== Parameters ====
; firstName - ''string''
: Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'

; middleName - ''string''
: Optional string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'

; lastName - ''string''
: Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'

; company - ''string''
: Optional string max 200 characters. May contain only alphanumerics, white space and the following characters: -.'

; street1 - ''string''
: Required string max 100 characters. May contain only alphanumerics, white space and the following characters: -.'

; street2 - ''string''
: Optional string max 100 characters. May contain only alphanumerics, white space and the following characters: -.'

; city - ''string''
: Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'

; stateOrProvince - ''string''
: Required string max 20 characters. May contain only alphanumerics, white space and the following characters: -.'

; postalCode - ''string''
: Required string max 30 characters. May contain only alphanumerics, white space and the following characters: -.'

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

; phone1 - ''string''
: Required string ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number max 50 characters.

; phone2 - ''string''
: Optional string ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number max 50 characters.

; fax - ''string''
: Optional string ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number max 50 characters.

; email1 - ''string''
: Required string valid e-mail address max 100 characters.

; email1Format - ''string''
: Required string – one of ''html'' or ''text''.

; email2 - ''string''
: Optional string valid e-mail address max 100 characters.

; email2Format - ''string''
: Optional string – one of ''html'' or ''text''.

== Response ==

=== Status Code ===
;204 No Content
: The operation was successfully completed.

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

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

=== Response Body ===
None.

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

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