Latest revision as of 13:23, 31 January 2014

[edit] GET /accounts/{accountId}/products/{productId}/services

Retrieves a list of all services associated with a given product.

[edit] Request

GET /accounts/{accountId}/products/{productId}/services

[edit] Parameters

accountId - string

The Id of the account.

productId - string

The Id of the product.

[edit] URI Parameters

None.

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

[edit] Response

[edit] Status Code

200 OK

Success

404 Not Found

The account Id or product Id was not found.

403 Forbidden

Access to closed and suspended accounts requires elevated permissions

[edit] Response Body

{
  "list": [
    {
      "name": "Product 1",
      "serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecId1}",
      "status": "open",
      "billingCycle": 1,
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId1}", "rel": "self"}
      ]
    },
    {
      "name": "Product 2",
      "serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecId2}"
      "status": "open",
      "billingCycle": 1,
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId2}", "rel": "self"}
      ],
    }
  ],
  "links": [
    {"href": "https://api.hostway.com/accounts/{accountId}/products/{productId}/services", "rel": "self"}
  ]
}
 

[edit] Parameters

list - list

A collection of dictionaries containing information about specific services

status - string

Describes the status of a service. Valid values are open, closed, pending, or suspended

name - string

Descriptive name of the service

billingCycle - integer

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

serviceSpecification - string

Hypermedia for this service resource. Link to the service's specification.

links - list

Hypermedia for this service resource. Links to the service.

links - list

Hypermedia for this resource. Links to self.

[edit] See also

• Account Management API
• Common Features