Accounts-accountId-products:GET - Revision history

Mike.robski: 1 revision: Release 100

2014-11-19T05:07:12Z

1 revision: Release 100

Mike.robski at 18:04, 20 October 2014

2014-10-20T18:04:20Z

Mike.robski: 1 revision: Release 99

2014-10-14T15:07:20Z

1 revision: Release 99

Emanuela.mitreva: /* GET /accounts/{accountId}/products */

2014-10-01T14:02:17Z

GET /accounts/{accountId}/products

Mike.robski: 1 revision: Release 98

2014-09-15T13:50:37Z

1 revision: Release 98

Emanuela.mitreva: /* Response Body */

2014-09-05T08:51:11Z

Response Body

Mike.robski: 1 revision: Release 97

2014-08-20T17:49:06Z

1 revision: Release 97

Velko.hristov at 12:07, 13 August 2014

2014-08-13T12:07:54Z

Mike.robski: 1 revision

2013-02-20T15:28:54Z

1 revision

Mike.robski at 00:24, 20 February 2013

2013-02-20T00:24:16Z

New page

= GET /accounts/''{accountId}''/products =
Retrieves a list of all products associated with a given account.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

== 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 ===
<nowiki>
{
"list": [
{
"name": "Product 1",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/{productId1}", "rel": "self"}
]
},
{
"name": "Product 2",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}", "rel": "self"}
],
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products", "rel": "self"}
]
}
</nowiki>

==== 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 [[Orders-orderId-account-attributes:PUT|partner_account_id]]. The response to this request is the same as the response to a request using the account Id.

<code>GET /partnerAccounts/''{partnerAccountId}''/products</code>

==== Parameters ====
; partnerAccountId - ''string''
: Partner account Id set via the [[Orders-orderId-account-attributes:PUT|partner_account_id]] attribute.

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

@@ Line 42: / Line 42: @@
        "name": "Product 1",
        "displayName": "My custom product name",
-       "partnerId": "Partner purchased plan Id",
+       "partnerId": "Partner Id",
        "productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
        "bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId1}/bandwidth/",
@@ Line 55: / Line 55: @@
        "name": "Product 2",
        "displayName": "My custom product name",
-       "partnerId": "Partner purchased plan Id",
+       "partnerId": "Partner Id",
        "productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
        "bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}/bandwidth/",

@@ Line 81: / Line 81: @@
 :; name - ''string''
 :: Descriptive name of the product
 :; billingCycle - ''integer''

@@ Line 44: / Line 44: @@
        "partnerId": "Partner purchased plan Id",
        "productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
        "status": "open",
        "billingCycle": 1,
@@ Line 55: / Line 57: @@
        "partnerId": "Partner purchased plan Id",
        "productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
        "status": "open",
        "billingCycle": 1,
@@ Line 83: / Line 87: @@
 :; productSpecification - ''string''
 :: [[Hypermedia]] for this product resource. Link to the product's specification.
 :;  links - ''list''