Mike.robski: 1 revision: Release 91

2014-03-11T16:57:23Z

1 revision: Release 91

Mike.robski at 20:02, 7 March 2014

2014-03-07T20:02:52Z

New page

= Order a new cloud backup =
This example provides the steps to order cloud backup through the Hostway [[Orders|Ordering API]].
== Create a new ord
er ==
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/0000013ad6dd95746a399f90000a71384bf242cf
Set-Cookie : OwnerId=b0d6352a-f66a-476d-8e1d-2f3f9dea5c49; Path=/

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

== Create a new account 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/0000013ad6dd95746a399f90000a71384bf242cf/account
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=b0d6352a-f66a-476d-8e1d-2f3f9dea5c49; Path=/

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

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

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

=== Request ===
<nowiki>
POST /orders/0000013ad6dd95746a399f90000a71384bf242cf/account/products
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=b0d6352a-f66a-476d-8e1d-2f3f9dea5c49; Path=/

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

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

== Add the cloud backup service to the new product ==
The service specification offerings can be determined using the Hostway [[Products|Product Catalog API]] for the core.plan.linux.webstart product. Then add the new cloud backup service to the order by using [[Orders-orderId-account-products-productId-services:POST|POST /orders/{order_id}/account/products/{product_id}/services]].

=== Request ===
<nowiki>
POST /orders/0000013ad6dd95746a399f90000a71384bf242cf/account/products/0000013fd6dd95726c399e90000a71384bf242cf/services

Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=b0d6352a-f66a-476d-8e1d-2f3f9dea5c49; Path=/

{
"name": "test-domain.com",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.cloudbackup.hs2.2gb",
"billingCycle": 12,
"attributes": { "displayName": "test-domain.com" }
}
</nowiki>

=== Response ===
<nowiki>
201 Created
Content-Type: application/json; charset=UTF-8
Location : </nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ad6dd95746a399f90000a71384bf242cf/account/products/0000013fd6dd95726c399e90000a71384bf242cf/services/0000013fe6dd95726c399e54500a71384bf242cf
</nowiki>

== Submit the order ==
Use [[Orders-orderId-action:POST|POST /orders/{order_id}/action]] to submit the order and invoke the cloud backup provisioning.

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

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

=== Response ===
<nowiki>
202 Accepted
</nowiki>

'''See also'''
* [[Products|Product Catalog API]]
* [[Orders|Ordering API]]
* [[Common Features]]

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

Order-cloud-backup - Revision history

Mike.robski: 1 revision: Release 91

Mike.robski at 20:02, 7 March 2014