Hostway API Documentation - User contributions [en]

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

2016-01-29T16:10:33Z

Velko.hristov:

= PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Updates a service in order builder.
Currently supports only updating the name and the billing cycle of the service.
__TOC__

== Request ==
<code>PUT /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 ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
A dictionary containing the keys "billingCycle" and "name" and their values.
<nowiki>
{
"billingCycle": 12,
"name": "Service Name",
"associatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}", "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId}" ],
}
</nowiki>

=== Validation Rules ===
:# The service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) should point to a valid service already added to the product.
:# The dictionary key/value pairs should be valid billing cycle and service name.
:# The billingCycle and name parameters are required.
:# Each service URL from the associated services list should point to a valid service already added to the product.
:# Any associated service that already exists on the account must be open.
== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204 No Content
| -
| The operation was successfully completed.
|-
| rowspan="2"| 400 Bad Request
| POST data error
| Trying to update service with empty body or with invalid body.
|-
| Unable to change service: invalid cycle
| Trying to change the billing cycle to value that is not supported by the current service.
|-
|-
| 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 was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Service failed permission check
| The client does not have permissions to update the service.
|-
| 404 Not Found
| Resource not found
| The client is trying to update a non existing service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>
400 Bad Request - invalid or empty body is passed (required field is missing)
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required", "name": "Required"}
}
}

400 Bad Request - missing billingCycle
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required"}
}
}

400 Bad Request - missing name
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"name": "Required"}
}
}

400 Bad Request - invalid billing cycle
{
"computeFault": {
"guid": "7c72847f-5138-44e8-ad93-cc80bb5ba7bc",
"message": "Unable to change service: invalid cycle",
"code": 400,
"details": ""
}
}</nowiki>

<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>
404 Not Found - the order or product was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"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]]

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

2016-01-28T17:09:13Z

Velko.hristov:

= 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}" ],
"associatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"quantity": 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

; associatedTo - ''list'' (optional)
: A list containing other services that are associated in some way to the service. The list may contain links to [[Orders#Services|other new services in the order]] and/or a link to an [[Account#Products_Management|existing service]] that belongs to the same account and product. In most cases the list may be empty unless otherwise stated.

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

; quantity- ''integer''
: Quantity (if multiple services is allowed) of the service.

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

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

2016-01-28T17:07:16Z

Velko.hristov:

= GET /orders/''{orderId}''/account/products/''{productId}''/services =
Get all Services in a given product.
__TOC__

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

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

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

=== 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 permissions to get information about the services.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the services for non existing order or non existing product.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"list": [
{
"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/{serviceId}" ],
"associatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"quantity": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/", "rel": "self"}
]
} </nowiki>

===== Parameters =====
; list - ''list''
: List of the services for the given product. Each element of the list has the following attributes:

:; status - ''string''
:: Current status of the service. Allowed values are '''new''', '''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 in the current order related in some way to the current service

:; associatedTo - ''list'' (optional)
:: A list containing other services that are associated in some way to the service. The list may contain links to [[Orders#Services|other new services in the order]] and/or a link to an [[Account#Products_Management|existing service]] that belongs to the same account and product. In most cases the list may be empty unless otherwise stated.

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

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

:; quantity- ''integer''
:: Quantity (if multiple services is allowed) of the service.

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

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

==== 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 services.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order or the product 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]]

Orders

2015-07-29T11:53:03Z

Velko.hristov:

= 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:PUT|PUT /orders/{orderId}/account/products/{productId}]] - Updates 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:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}]] - Updates 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

== Service Notes ==
Notes for services.
* [[Orders-orderId-account-products-productId-services-serviceId-notes:POST|POST /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Adds a service note
* [[Orders-orderId-account-products-productId-services-serviceId-notes:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Updates the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Gets all the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Deletes the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:OPTIONS|OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Returns information about supported attributes

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

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

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

== VPS Virtuozzo Products ==
* [[Order-vps-virtuozzo|VpsVirtuozzo]] - Example order flow for purchasing VPS Virtuozzo products and services

== Domain Registration Products ==
* [[Order-Domain|Order Domain]] - Example order flow for purchasing a domain
* [[Order-Domain-Shortcut|Order Domain Shortcut]] - Example order flow for purchasing a domain by using the domain shortcut

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

Accounts-account-dedicatedServers-server-ipAddresses-ipaddress:GET

2015-04-01T13:14:46Z

Velko.hristov:

= GET /accounts/{account_number}/dedicatedServers/{serverId}/ipAddresses/{ipAddress} =
Retrieves a list of the IP addresses of a dedicated server
__TOC__

== Request ==
<code>GET /accounts/''{account_number}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddress}''</code>

==== Request Parameters ====
; account_number - ''string''
: The user account owning the dedicated servers
; serverId - ''string''
: The specified dedicated server Id
; ipAddress - ''string''
: The IP address

=== Request Headers ===

{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"monitoring":[{"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/monitoring", "rel": "related"}],
"ipaddressid": "{ipAddress}",
"links": [{"href": "{APIBaseURL}/accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/", "rel": "self"}]
}
</nowiki>

==== Parameters ====
; monitoring- ''list''
: [[Hypermedia]] for a monitor call to the IP address product.

; ipaddressid - ''string''
: The IP address

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

=== Expected Response Codes ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions to access the resource. The only user(s) who has access to the dedicated servers list must be a sales agent, the account owner, or the account technical admin.

; 404 Not Found
: The account or server does not exist.

; 405 Method not allowed
: The HTTP request method is not allowed.

== Examples ==

=== Get a specific dedicated server IP ===
'''Request'''
<nowiki>
GET /accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11
</nowiki>

'''Response'''
<nowiki>
{
"monitoring":
[
{
"href": "http://coreapi01.ote.chicago.hostway:8092/accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11/monitoring",
"rel": "related"
}
],
"ipaddressid": "11.10.13.11",
"links":
[
{
"href": "http://coreapi01.ote.chicago.hostway:8092/accounts/test-ng-809027223/dedicatedServers/test-ng-809027223-00000132ff10f8d8d63e8ce6000ac648/ipAddresses/11.10.13.11/",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Dedicated_Server_API|Dedicated Server API]]

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

Accounts-accountId-products:GET

2014-08-13T12:07:54Z

Velko.hristov:

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

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

=== URI Parameters ===

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

; filterDisplayName - ''string''
: Optional. Only products with displayName matching the value of the parameter will be returned.

; filterPartnerId - ''string''
: Optional. Only products with parnterId matching the value of the parameter will be returned.

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

== Response ==

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

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

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

=== Response Body ===
<nowiki>
{
"list": [
{
"name": "Product 1",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/{productId1}", "rel": "self"}
]
},
{
"name": "Product 2",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}", "rel": "self"}
],
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products", "rel": "self"}
]
}
</nowiki>

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

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

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

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

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

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

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

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

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

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

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

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

Accounts-accountId-products-productId:GET

2014-08-13T11:55:11Z

Velko.hristov:

= GET /accounts/''{accountId}''/products/{productId} =
Get product information and (if requested) possible product changes.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/{productId}</code>

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

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

=== URI Parameters ===
; getTargetProductSpecifications - ''boolean''
: Optional. If set to 1 the response will include valid product specification change targets list.

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

== Response ==

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

; 401 Unauthorized
: Authorization credentials not submitted or invalid.

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

=== Response Body ===
The response body includes product specification change targets list when the ''getTargetProductSpecifications'' URI parameter is set to 1.

<nowiki>
{
"status": "open",
"name": "Product Name",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"billingCycle": 12,
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}",
"changes": [
{
"type": "upgrade",
"id": "{targetProductSpecificationId}",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{targetProductSpecificationId}"
},
]
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/", "rel": "self"}
]
}
</nowiki>

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

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

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

; productSpecification - ''string''
: Link to the specification of the current product.

; changes - ''list''
: A list with the valid product change targets. Returned if ''getTargetProductSpecifications=1'' query parameter is passed

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

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

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

Dns-zone-records-recordId:PUT

2014-04-25T11:54:15Z

Velko.hristov:

= PUT /dns/''{zone}''/records/''{recordId}'' =
Update an existing zone record.
__TOC__

== Request ==
<code>PUT /dns/''{zone}''/records/''{recordId}''</code>

==== Request Parameters ====
; zone - ''string''
: The DNS zone of the record.

; recordId - ''string''
: The uniques Id of the record.

=== URI Parameters ===
None.

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

; Authorization
: Base64-encoded username & password string

=== Request Body ===

Added support for wildcard domain names.
Ex:
*
*.somedomain.com
The wildcard record name is stored in the database as it is supplied.
If it's missing the zone origin(i.e. '*') the API will return it with the zone
appended, i.e. '*.domain.com'.

Added support for @ records, which represent the origin itself.
Ex:
@
The API will return the record with the zone origin appended to the name, i.e. '@.domain.com'

====A record====
<nowiki>
{
"name": {domain},
"type": "A",
"address": {ip_address},
"ttl": 3600
}</nowiki>

====AAAA record====
<nowiki>
{
"name": {domain},
"type": "AAAA",
"address": {ipv6_address},
"ttl": 3600
}</nowiki>

====NS record====
<nowiki>
{
"name": {domain},
"type": "NS",
"nsdname": {ns_domain},
"ttl": 3600
}</nowiki>

====TXT record====
<nowiki>
{
"name": {domain},
"type": "TXT",
"data": {data},
"ttl": 3600
}</nowiki>

====SRV record====
<nowiki>
{
"name": {domain},
"type": "SRV",
"priority": {priority},
"weight": {weight},
"port": {port},
"target": {target},
"ttl": 3600
}</nowiki>

====MX record====
<nowiki>
{
"name": {domain},
"type": "MX",
"preference": {preference},
"exchange": {mx_domain},
"ttl": 3600
}</nowiki>

====CNAME record====
<nowiki>
{
"name": {name},
"type": "CNAME",
"cname": {domain},
"ttl": 3600
}</nowiki>

== Response ==

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

; 400 Bad Request : TTL is below allowed minimum

; 401 Unauthorized :

; 403 Forbidden :

; 409 Conflict :

=== Response Body ===
None.

== Examples ==

=== Unauthorized Request ===
''Request''
<nowiki>
PUT /dns/test.com/records/1234

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}</nowiki>

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

=== Successful Update ===

''Request''
<nowiki>
PUT /dns/test.com/records/1234
Authorization: Basic {base64_encoded(username:password)}

{
"name": "test1",
"type": "CNAME",
"cname": "otherdomain1.com."
}</nowiki>

''Response''
<nowiki>
200 OK

{
"name": "test1",
"type": "CNAME",
"cname": "otherdomain1.com."
}</nowiki>

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

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

Dns-zone-records:POST

2014-04-25T11:53:29Z

Velko.hristov:

= POST /dns/''{zone}''/records =
Creates new DNS zone records.
__TOC__
== Request ==
<code>POST /dns/''{zone}''/records</code>

==== Parameters ====
; zone - ''string''
: The name of the DNS zone.

==== URI Parameters ====
None.

=== Request Headers ===
; Authorization
: Base64-encoded username:password string

; Content-Type
: application/json

=== Request Body ===

Added support for wildcard domain names.
Ex:
*
*.somedomain.com
The wildcard record name is stored in the database as it is supplied.
If it's missing the zone origin(i.e. '*') the API will return it with the zone
appended, i.e. '*.domain.com'.

Added support for @ records, which represent the origin itself.
Ex:
@
The API will return the record with the zone origin appended to the name, i.e. '@.domain.com'
====A record====
<nowiki>
{
"name": "{domain}",
"type": "A",
"address": "{ip_address}",
"ttl": 3600
}</nowiki>

====AAAA record====
<nowiki>
{
"name": "{domain}",
"type": "AAAA",
"address": "{ipv6_address}",
"ttl": 3600
}</nowiki>

====NS record====
<nowiki>
{
"name": "{domain}",
"type": "NS",
"nsdname": "{ns_domain}",
"ttl": 3600
}</nowiki>

====TXT record====
<nowiki>
{
"name": "{domain}",
"type": "TXT",
"data": "{data}",
"ttl": 3600
}</nowiki>

====SRV record====
<nowiki>
{
"name": "{domain}",
"type": "SRV",
"priority": {priority},
"weight": {weight},
"port": {port},
"target": "{target}",
"ttl": 3600
}</nowiki>

====MX record====
<nowiki>
{
"name": "{domain}",
"type": "MX",
"preference": {preference},
"exchange": "{mx_domain}",
"ttl": 3600
}</nowiki>

====CNAME record====
<nowiki>
{
"name": "{name}",
"type": "CNAME",
"cname": "{domain}",
"ttl": 3600
}</nowiki>

== Response ==

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

; 400 Bad Request : TTL is below allowed minimum

; 401 Unauthorized : The server could not verify the credentials from the authorization header.

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

=== Response Header ===
; Location
: The URI of the new DNS record.

== Examples ==

=== Successful Request ===
''Request''
<nowiki>
POST /dns/test.com/records
Authorization: Basic {base64_encoded(username:password)}

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}</nowiki>

''Response''
<nowiki>
201 Created
Location: </nowiki>{{APIBaseURL}}<nowiki>/dns/test.com/records/447
</nowiki>

=== Unauthorized Request ===
''Request''
<nowiki>
POST /dns/test.com/records

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}</nowiki>

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

=== Attempt to create duplicate record ===
''Request''
<nowiki>
POST /dns/test.com/records
Authorization: Basic {base64_encoded(username:password)}

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}</nowiki>

''Response''
<nowiki>
409 Conflict

{
"conflict": {"message": "Data conflict", "code": 409, "details": ""}
}</nowiki>

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

{{disqus}}
[[Category:Hostway API]]
[[Category:DNS API]]
code>POST /dns/''{zone}''/records