Mike.robski: 1 revision: Release 98

2014-09-15T13:51:37Z

1 revision: Release 98

Mike.robski at 10:02, 15 September 2014

2014-09-15T10:02:32Z

New page

== Order a new WebsPlanet ==

This example provides the steps to order a new webs planet product through the Hostway Ordering API.

== Create a new order ==
Use [[Orders:POST|POST /orders]] to create a new order

=== Request ===
<nowiki>
POST /orders
Content-Type: application/json; charset=UTF-8

{}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001
Set-Cookie : OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/

{
"orderId": "00000143d407b34742ee26ae007f000000010001",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001", "rel": "item"}
]
}
</nowiki>

== Create a new acout for the order ==
Use [[Orders-orderId-account:PUT|PUT /orders/{order_id}/account]] to create an account or add an existing one to the order.

=== Request ===
<nowiki>
PUT /orders/00000143d407b34742ee26ae007f000000010001/account
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/

{
"currency": "USD",
"language": "en-US"
}
</nowiki>

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

== Add a Websplanet product to the order ==
The websplanet product specification offerings can be determined using the Hostway [[Products|Product Catalog API]]. Then add a new websplanet product to the order by using
[[Orders-orderId-account-products:POST|POST /orders/{order_id}/account/products]].

=== Request ===
<nowiki>
POST /orders/00000143d407b34742ee26ae007f000000010001/account/products
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/

{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/core.plan.linux.webstart/offerings/USD-1"
}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001
</nowiki>

== Add a Webhosting service to the new product ==
A Websplanet service needs to be related to either a Windows or a Linux webhosting service. To do that, the webhosting service needs to be created first.
=== Request ===
<nowiki>
POST /orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/
{"name": "Websplanet",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.webhosting.linux.5GB",
"billingCycle": 1}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services/00000143d407b34742ed9lker8007f000000010001
</nowiki>

==Add the Webhosting service attributes==
<nowiki>
PUT /orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services/00000143d407b34742ed9lker8007f000000010001/attributes
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/

{"domain": "ng-test-fitnesse-websplanet-20140505-0505.us"}
</nowiki>
== Add a Websplanet service to the new product ==
Please note that WebsPlanet can be added only as a child service to the webhosting service.
You have to specify webhosting service you want websplanet to be added to.

Assuming you have a webhosting service in your order, you can add websplanet using
[[Orders-orderId-account-products:POST|POST /orders/{order_id}/account/products/{product_id}/services]].
The "relatedTo" attribute should contain the webhosting service's URL.

=== Request ===
<nowiki>
POST /orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/
{"name": "Websplanet",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.websplanet.1",
"billingCycle": 1,
"relatedTo": ["</nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services/00000143d407b34742ed9lker8007f000000010001"]}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services/00000143d407bea7e2b84d37001f000000010001
</nowiki>

==Add the WebsPlanet service attributes==

<nowiki>
PUT /orders/00000143d407b34742ee26ae007f000000010001/account/products/00000143d407b725d9eb9a41007f000000010001/services/00000143d407bea7e2b84d37001f000000010001/attributes
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/

{"domain": "ng-test-fitnesse-websplanet-20140505-0505.us",
"email": "test@example.com"}
</nowiki>

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

Order-webs-planet - Revision history

Mike.robski: 1 revision: Release 98

Mike.robski at 10:02, 15 September 2014