Orders-orderId-account-products:GET
From Hostway API Documentation
Revision as of 17:42, 15 February 2013 by Mike.robski (Talk | contribs)
GET /orders/{orderId}/account/products
Get all Product in an account.
Contents |
Request
GET /orders/{orderId}/account/products
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
URI Parameters
None.
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
- The operation was successfully completed.
- 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
{
"list": [
{
"status": "open",
"services": "https://api.hostway.com/orders/{orderId}/account/products/{orderProductId}/services",
"offering" : "https://api.hostway.com/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"links": [
{"href": "https://api.hostway.com/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
]
}
],
"links": [
{"href": "https://api.hostway.com/orders/{orderId}/account/products/", "rel": "self"}
]
}
Parameters
- list - list
- List of the products for the given account order. Each element of the list has the following attributes:
- status - string
- Current status of the product. Allowed values are new, pending, open, suspended, close_pending, closed and purge_pending
- services - string
- A link to the services associated with the product
- links - list
- Hypermedia for the product resource
- offering - string
- Link to the product catalogue offering specifying the given product
- links - list
- Hypermedia for the list of product resources
See also
