Orders-orderId-account-products-productId-services:GET

GET /orders/{orderId}/account/products/{productId}/services

Get all Services in a given product.

Request

GET /orders/{orderId}/account/products/{productId}/services

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

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": "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/{serviceId}" ],
      "serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecificationId}",
      "billingCycle": 1,
      "attributes": "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
    }
  ],
  "links": [
    {"href": "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/", "rel": "self"}
  ]
}
 

Parameters

list - list

List of the services for the given product. Each element of the list has the following attributes:

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 in the current order related in some way to the current service

serviceSpecification - string

Link to the product catalogue specification describing the given service

billingCycle - integer

Billing cycle (length of billing period in months) of the service. Allowed values are from 1 to 120

attributes - string

A link to the attributes of the service

links - list

Hypermedia for the list of product resources

See also

• Orders API
• Common Features

blog comments powered by Disqus