Orders:POST - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:12:21Z

1 revision: Release 109

Jerry.dimitrov: /* Create without permission to pass client IP */

2015-07-01T11:51:45Z

Create without permission to pass client IP

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:30Z

1 revision: Release 98

Pa.dinh at 09:35, 5 September 2014

2014-09-05T09:35:46Z

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:46Z

1 revision: Release 85

Kj.lee at 22:53, 11 July 2013

2013-07-11T22:53:19Z

Mike.robski: 1 revision

2013-02-17T06:58:57Z

1 revision

Mike.robski at 22:59, 15 February 2013

2013-02-15T22:59:07Z

New page

= POST /orders =
Creates a new order and returns the unique order URI.
__TOC__

== Request ==
<code>POST /orders</code>

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

; Cookie
: Optional. A cookie named '''OwnerId''' may be specified 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 a previous request for this resource (in the '''Set-Cookie''' response header).

=== Request Body ===
<nowiki>
{}
</nowiki>

== Response ==

=== Status Code ===
;201 Created
: The new order was created.

;409 Conflict
: The client already has an open order. If the '''OwnerId''' cookie was passed in the request headers, a 409 will be returned if there's already an open (unsubmitted) order for the same client.

=== Response Headers ===
; Location
: Returned with successful response. Contains the order URI. The client must use this URI for all subsequent operations with the order.

; Set-Cookie
: Returned with successful response. Contains an '''OwnerId''' value which must be submitted with all subsequent requests for this order. The '''OwnerId''' identifies the client and prohibits it from having more than one open (unsubmitted) orders.

=== Response Body ===
<nowiki>
{
"orderId": "{orderId}",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}", "rel": "item"}
]
}
</nowiki>

==== Parameters ====
; orderId - ''string''
: The Id of the new order

; links - ''list''
: [[Hypermedia]] for this resource. Links to self and the newly created order.

== Example ==

=== 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>

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

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

@@ Line 103: / Line 103: @@
 POST /orders
 Content-Type: application/json; charset=UTF-8
-Authorization: Basic ZHBlbmV2MTMwMjEyYkBwYXJ0bmVyX2FwaV9jb21jYXN0X3VzX21haW46cXdlcXdlMTIzNA==
+Authorization: Basic AuthString
-−
+{
    "clientIp": "1.2.3.4"
@@ Line 121: / Line 120: @@
+   }
 }</nowiki>
 === An open order already exists ===

@@ Line 30: / Line 30: @@
 === Status Code ===
-;201 Created
+{| class="wikitable"
-: The new order was created.
+! Status Code
+! Error Message
-;400 Bad Request
+! Description
-: The client attempted to pass the client IP address and is not allowed.  Use of this parameter requires elevated permissions.
+|-
+| 201 Created
-;409 Conflict
+| align="center" | -
-: The client already has an open order. If the '''OwnerId''' cookie was passed in the request headers, a 409 will be returned if there's already an open (unsubmitted) order for the same client.
+| The new order was created.
 === Response Headers ===
@@ Line 54: / Line 63: @@
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}", "rel": "item"}
+   ]
 }</nowiki>
- </nowiki>
 ==== Parameters ====
@@ Line 66: / Line 74: @@
 == Example ==
-=== Request ===
+=== Create Order successfully ===
   <nowiki>
 POST /orders
 Content-Type: application/json; charset=UTF-8
-{}
+{}</nowiki>
- </nowiki>
-=== Response ===
+'''Response'''
   <nowiki>
 Created
@@ Line 82: / Line 90: @@
+{
- "orderId": "0000013ad6dd95746a399f90000a71384bf242cf",
+  "orderId": "0000013ad6dd95746a399f90000a71384bf242cf",
- "links": [
+  "links": [
-  {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
+    {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/", "rel": "self"},
-  {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ad6dd95746a399f90000a71384bf242cf", "rel": "item"}
+    {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000013ad6dd95746a399f90000a71384bf242cf", "rel": "item"}
-−
+  ]
+}</nowiki>
   </nowiki>
 == See also ==