Order Shorthand - Revision history

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:31Z

1 revision: Release 98

Pa.dinh at 13:59, 9 September 2014

2014-09-09T13:59:15Z

Mike.robski: 1 revision: Release 86

2013-10-11T16:59:47Z

1 revision: Release 86

Ivailo.shankov at 14:23, 9 October 2013

2013-10-09T14:23:20Z

Mike.robski: 1 revision

2013-02-17T06:58:58Z

1 revision

Mike.robski at 23:00, 15 February 2013

2013-02-15T23:00:31Z

New page

= /order =
A shorthand that allows a user to access directly the current open order with the appropriate OwnerId.
__TOC__

== Request Headers ==
; Cookie
: Required. Any call trying to use the shorthand notation has to have a valid '''OwnerId''' cookie set, with the exception of calls that will create a new order implicitly. A valid '''Set-Cookie''' header is returned with the response of either implicit or explicit order creation calls.

== Order Shorthand ==
Using <code>/order</code> will try to find an order with status ''new'' that is associated with the '''OwnerId''' specified in the cookie header sent with the request. The value of the cookie may be set by either explicit or implicit order creation.

== Available Methods and Child Resources ==
The shorthand supports all the methods that are available when using the <code>/orders/''{orderId}''</code> notation and all of the order's child resources are also accessible using the shortcut. A GET call to the order shorthand itself will include an ''alternate'' link to the explicit URL of the order in the hypermedia section. If an order is submitted using the shorthand URL, a '''Location''' header containing the explicit location of the order will be returned with a successful response for future reference.

== Implicit Order Creation ==
If there is no current order associated with the active user, that is not submitted, a PUT or POST call to a child resource will implicitly create a new order for the user and will populate the data of the actual call to the new order. The final response of the implicitly created order will contain additional '''Set-Cookie''' header as described below. A GET or OPTIONS call to a non-existing order will not create it implicitly, but will return response with 404 status code.

== Response Headers ==
; Set-Cookie
: If an order is created implicitly while accessing a child resource, the final response will include a '''Set-Cookie''' header containing an '''OwnerId''' identifier, in a similar way to explicit creation of an order using [[orders:POST|POST /orders]]. The cookie will be used to identify the end user, if no existing account is associated with the order, and to find which is the currently open order associated with the end client.

== Additional Status Code ==
In addition to the response status codes that can be returned by various <code>/orders/''{orderId}''</code> calls, the order shorthand may also return:
; 409 Conflict
: There is already a new order associated with the same '''OwnerId''' and a second order cannot be created until the existing one is either submitted or deleted.

== Examples ==

=== Implicit Creation ===
'''Request'''
<nowiki>
PUT /order/account
Content-Type: application/json; charset=UTF-8
Authorization: {Base64-encoded username & password string}

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

'''Response'''
<nowiki>
200 OK
Set-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
Set-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/orders

</nowiki>

=== Alternate Hypermedia ===
'''Request'''
<nowiki>
GET /order
Authorization: {Base64-encoded username & password string}
Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
</nowiki>

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

{
"order": {
"OwnerId": "4d84cd13-bbb3-46ba-a40c-8988351e3681"
},
"links": {
"self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/order/", "rel": "self"},
"alternate": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/", "rel": "alternate"}
}
}
</nowiki>

=== Accessing a Child Resource ===
'''Request'''
<nowiki>
GET /order/product/{productId}
Authorization: {Base64-encoded username & password string}
Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
</nowiki>

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

{
"status": "new",
"services": "</nowiki>{{APIBaseURL}}<nowiki>/order/product/{productId}/services",
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId}/offerings/{offering}",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/order/product/{productId}/", "rel": "self"}
]
}
</nowiki>

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

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

@@ Line 14: / Line 14: @@
 == Implicit Order Creation ==
-If there is no current order associated with the active user, that is not submitted, a PUT or POST call to a child resource will implicitly create a new order for the user and will populate the data of the actual call to the new order. The final response of the implicitly created order will contain additional '''Set-Cookie''' header as described below. A GET or OPTIONS call to a non-existing order will not create it implicitly, but will return response with 404 status code.
+If there is no current order associated with the active user, that is not submitted, a PUT or POST call to a child resource will implicitly create a new order for the user and will populate the data of the actual call to the new order. The final response of the implicitly created order will contain additional '''Set-Cookie''' header as described below. A GET or OPTIONS call to a non-existing order will not create it implicitly, but will return response with '''404''' status code.
 == Response Headers ==
@@ Line 22: / Line 22: @@
 == Additional Status Code ==
 In addition to the response status codes that can be returned by various <code>/orders/''{orderId}''</code> calls, the order shorthand may also return:
-; 409 Conflict
+=== Status Code ===
-: There is already a new order associated with the same '''OwnerId''' and a second order cannot be created until the existing one is either submitted or deleted.
+{| class='wikitable'
 == OwnerId cookie ==
@@ Line 59: / Line 72: @@
   "currency": "USD",
   "language": "en-US"
 }</nowiki>
- </nowiki>
 '''Response'''
@@ Line 66: / Line 78: @@
 OK
 Set-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
-Set-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/orders
+Set-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/orders</nowiki>
-−
- </nowiki>
 === Alternate Hypermedia ===
@@ Line 75: / Line 85: @@
 GET /order
 Authorization: {Base64-encoded username & password string}
-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
+Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order</nowiki>
- </nowiki>
 '''Response'''
@@ Line 91: / Line 100: @@
      "alternate": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/", "rel": "alternate"}
+   }
 }</nowiki>
- </nowiki>
 === Accessing a Child Resource ===
@@ Line 99: / Line 107: @@
 GET /order/product/{productId}
 Authorization: {Base64-encoded username & password string}
-Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order
+Cookie: OwnerId=4d84cd13-bbb3-46ba-a40c-8988351e3681; Path=/order</nowiki>
- </nowiki>
 '''Response'''
@@ Line 114: / Line 121: @@
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/order/product/{productId}/", "rel": "self"}
+   ]
 }</nowiki>
- </nowiki>
 == See also ==

@@ Line 11: / Line 11: @@
 == Available Methods and Child Resources ==
-The shorthand supports all the methods that are available when using the <code>/orders/''{orderId}''</code> notation and all of the order's child resources are also accessible using the shortcut. A GET call to the order shorthand itself will include an ''alternate'' link to the explicit URL of the order in the hypermedia section. If an order is submitted using the shorthand URL, a '''Location''' header containing the explicit location of the order will be returned with a successful response for future reference.
+The shorthand supports all the methods that are available when using the <code>/orders/''{orderId}''</code> notation and all of the order's child resources are also accessible using the shorthand. A GET call to the order shorthand itself will include an ''alternate'' link to the explicit URL of the order in the hypermedia section. If an order is submitted using the shorthand URL, a '''Location''' header containing the explicit location of the order will be returned with a successful response for future reference.
 == Implicit Order Creation ==
@@ Line 24: / Line 24: @@
 ; 409 Conflict
 : There is already a new order associated with the same '''OwnerId''' and a second order cannot be created until the existing one is either submitted or deleted.
 == Examples ==