Orders-orderId:GET - Revision history

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:30Z

1 revision: Release 98

Pa.dinh at 09:51, 12 September 2014

2014-09-12T09:51:09Z

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:46Z

1 revision: Release 85

Yulia.uzunova: /* Parameters */

2013-08-21T16:11:09Z

Parameters

Mike.robski: 1 revision

2013-02-17T06:58:57Z

1 revision

Mike.robski at 22:59, 15 February 2013

2013-02-15T22:59:28Z

New page

= GET /orders/''{orderId}'' =
Returns the content of an order specified by the URI.
__TOC__
== Request ==
<code>GET /orders/''{orderId}''</code>

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

; Authorization
: Optional. Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

== Response ==

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

;401 Unauthorized
: The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.

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

=== Response Body ===
The response body may contain additional information beyond what is specified in the documentation. Such information should be ignored or treated as volatile, since it may change in the future.

<nowiki>
{
"order": {
"status": "{orderStatus}"
},
"links": {
"self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/", "rel": "self"}
}
}
</nowiki>

==== Parameters ====
; orderStatus - ''string''
: The status of the order.

; links - ''list''
: [[Hypermedia]] for this resource. Link to the order.

== Example ==

=== Request ===
<nowiki>
GET /orders/0000013ca61880fbfc068b33000a02c9d8ef861c
Cookie: OwnerId=948ce0d4-7cf0-43b6-88a5-2b3f1331b689; Path=/
</nowiki>

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

{
"order": {
"status": "new"
},
"links": {
"self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ca61880fbfc068b33000a02c9d8ef861c/", "rel": "self"}
}
}
</nowiki>

== OPTIONS /orders/''{order_id}'' ==
In addition to the GET method the API supports the OPTIONS method for direct browser access to the API. The format of the request is:

<code>OPTIONS /orders/''{order_id}''</code>

==== Parameters ====
; order_id - ''string''
: The unique order Id. The full URI of each order is returned by the [[Orders:POST|POST /orders]] call.

=== Request Headers ===
; Cookie
: A cookie named '''OwnerId''' to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the '''Set-Cookie''' response header.

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

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

=== Response Headers ===
;Access-Control-Allow-Methods
: A comma-separated list of request methods supported on this URI.

;Access-Control-Allow-Origin
: All origins are allowed. This header has value '''*'''.

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

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

@@ Line 20: / Line 20: @@
 === Status Code ===
-;200 OK
+{| class="wikitable"
-: Success.
+! Status Code
+! Error Message
-;401 Unauthorized
+! Description
-: The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
+|-
+| 200 OK
-;404 Not Found
+| align="center" | -
-: The specified order does not exist.
+| Success.
 === Response Body ===
@@ Line 41: / Line 54: @@
      "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/", "rel": "self"}
+   }
 }</nowiki>
- </nowiki>
 ==== Parameters ====
@@ Line 56: / Line 68: @@
 == Example ==
-=== Request ===
+=== Get order information ===
   <nowiki>
 GET /orders/0000013ca61880fbfc068b33000a02c9d8ef861c
-Cookie: OwnerId=948ce0d4-7cf0-43b6-88a5-2b3f1331b689; Path=/
+Cookie: OwnerId=948ce0d4-7cf0-43b6-88a5-2b3f1331b689; Path=/</nowiki>
- </nowiki>
-=== Response ===
+'''Response'''
   <nowiki>
 OK
@@ Line 72: / Line 84: @@
      "Account": "http://accounts/acc20130821"
    },
-   "links": {
+   "links": [ {
-     "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ca61880fbfc068b33000a02c9d8ef861c/", "rel": "self"}
+     "href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ca61880fbfc068b33000a02c9d8ef861c/",
+   }
+}</nowiki>
   </nowiki>
 == OPTIONS /orders/''{order_id}'' ==

@@ Line 35: / Line 35: @@
+{
    "order": {
-     "status": "{orderStatus}"
+     "Status": "{orderStatus}",
    },
    "links": {
@@ Line 46: / Line 47: @@
 ; orderStatus - ''string''
 : The status of the order.
 ; links - ''list''
@@ Line 65: / Line 69: @@
+{
    "order": {
-     "status": "new"
+     "Status": "new",
    },
    "links": {