Orders-orderId-account-products-productId-services-serviceId:GET
From Hostway API Documentation
Revision as of 01:58, 17 February 2013 by Mike.robski (Talk | contribs)
GET /orders/{orderId}/account/products/{productId}/services/{serviceId}
Get details about a specific service in a given product.
Contents |
Request
GET /orders/{orderId}/account/products/{productId}/services/{serviceId}
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
- productId - string
- UUID specifying the product
- serviceId - string
- UUID specifying the service
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, product or service does not exist.
Response Body
{ "status": "new", "name": "john.smith1", "links": [ {"href": "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{serviceId}/", "rel": "self"} ], "relatedTo": [ "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{relatedServiceId}" ], "serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecificationId}", "billingCycle": 1, "attributes": "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes" }
Parameters
- status - string
- Current status of the service. Allowed values are new, pending, open, suspended, close_pending, closed and purge_pending
- name - string
- The name of the specific service
- links - list
- Hypermedia for the product resource
- relatedTo - list
- A list containing other services related in some way to the current service
- serviceSpecification - string
- Link to the product catalogue specification describing the given service
- billingCycle - integer
- Billing cycle of the service. Allowed values are from 1 to 120
- attributes - string
- A link to the attributes of the service
See also