Mike.robski: 1 revision: Release 97

2014-08-20T17:48:44Z

1 revision: Release 97

Mike.robski at 18:54, 5 August 2014

2014-08-05T18:54:23Z

New page

== Order a new Exchange domain ==

This example provides the steps for ordering a new Exchange domain

== 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 an Exchange product to the order ==
The Exchange 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.email.exchange2010/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 an Exchange service to the new product ==

=== 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": "myexchangedomain.com",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.email.exchange2010",
"billingCycle": 1,
"attributes": {
"domain": "myexchangedomain.com"
}
}
</nowiki>

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

== Obtain a quote ==

=== Request ===
<nowiki>
GET /orders/00000143d407b34742ee26ae007f000000010001/quote
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/
</nowiki>

=== Response ===
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8
{
"quote" : {
"Hash" : "b6a714a2ba76b6f15df9e46964df21ca726594a0",
"Currency" : "USD",
"Total" : "0.00",
"SubTotal" : "0.00",
"OneTimeFeeAmount" : "0",
"TaxTotal" : "0"
},
"links" : {
"self" : {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000143d407b34742ee26ae007f000000010001/quote/",
"rel" : "self"
}
}
}
</nowiki>

== Submit the order ==

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

=== Response ===
<nowiki>
202 Accepted
no-body
</nowiki>

== Check for status ==

=== Request ===
<nowiki>
GET /orders/00000143d407b34742ee26ae007f000000010001
Cookie: OwnerId=09185e9b-2ea0-4bef-950e-fc9f8b89861f; Path=/
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm <- credentials that have access to the account
</nowiki>

=== Response ===
<nowiki>
200 OK
{
"order" : {
"Status" : "Processing", <- "Completed" means that everything has provisioned successfully
"Account" : "http://coreapi01.ote.chicago.hostway:8092/accounts/acct999999"
},
"links" : [ {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000143d407b34742ee26ae007f000000010001/",
"rel" : "self"
} ]
}
</nowiki>

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

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

Order-Exchange - Revision history

Mike.robski: 1 revision: Release 97

Mike.robski at 18:54, 5 August 2014