Revision as of 11:49, 20 August 2014

GET /accounts/{accountId}/products

Retrieves a list of all products associated with a given account.

Request

GET /accounts/{accountId}/products

Parameters

accountId - string

The Id of the account.

URI Parameters

filterStatus - string

Optional. Only products with status matching the value of the parameter will be returned. Allowed values are pending, open, suspended, closed.

filterDisplayName - string

Optional. Only products with displayName matching the value of the parameter will be returned.

filterPartnerId - string

Optional. Only products with parnterId matching the value of the parameter will be returned.

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Status Code

200 OK

Success

404 Not Found

The account Id was not found.

403 Forbidden

Access to closed and suspended accounts requires elevated permissions

Response Body

{
  "list": [
    {
      "name": "Product 1",
      "displayName": "My custom product name",
      "partnerId": "Partner purchased plan Id",
      "productSpecification": "https://api.hostway.com/productSpecifications/{productSpecId1}",
      "status": "open",
      "billingCycle": 1,
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/{productId1}", "rel": "self"}
      ]
    },
    {
      "name": "Product 2",
      "displayName": "My custom product name",
      "partnerId": "Partner purchased plan Id",
      "productSpecification": "https://api.hostway.com/productSpecifications/{productSpecId2}"
      "status": "open",
      "billingCycle": 1,
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/products/{productId2}", "rel": "self"}
      ],
    }
  ],
  "links": [
    {"href": "https://api.hostway.com/accounts/{accountId}/products", "rel": "self"}
  ]
}
 

Parameters

list - list

A collection of dictionaries containing information about specific products

status - string

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

name - string

Descriptive name of the product

billingCycle - integer

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

productSpecification - string

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

links - list

Hypermedia for this product resource. Links to the product.

links - list

Hypermedia for this resource. Links to self.

Alternative with partner Id

As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute partner_account_id. The response to this request is the same as the response to a request using the account Id.

GET /partnerAccounts/{partnerAccountId}/products

Parameters

partnerAccountId - string

Partner account Id set via the partner_account_id attribute.

See also

• Account Management API
• Common Features