Accounts-accountId-products-productId:GET - Revision history

Mike.robski: 1 revision: Release 100

2014-11-19T05:07:12Z

1 revision: Release 100

Mike.robski at 18:03, 20 October 2014

2014-10-20T18:03:33Z

Mike.robski: 1 revision: Release 99

2014-10-14T15:07:19Z

1 revision: Release 99

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

2014-10-01T14:02:48Z

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

Mike.robski: 1 revision: Release 98

2014-09-15T13:50:37Z

1 revision: Release 98

Emanuela.mitreva: /* Parameters */

2014-09-05T11:25:08Z

Parameters

Mike.robski: 1 revision: Release 97

2014-08-20T17:49:06Z

1 revision: Release 97

Velko.hristov at 11:55, 13 August 2014

2014-08-13T11:55:11Z

Mike.robski: 1 revision

2013-02-20T15:28:54Z

1 revision

Mike.robski at 14:52, 20 February 2013

2013-02-20T14:52:07Z

New page

= GET /accounts/''{accountId}''/products/{productId} =
Get product information and (if requested) possible product changes.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/{productId}</code>

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

; productId - ''string''
: The Id of the product.

=== URI Parameters ===
; getTargetProductSpecifications - ''boolean''
: Optional. If set to 1 the response will include valid product specification change targets list.

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

== Response ==

=== Status Code ===
; 200 OK
: Success.

; 401 Unauthorized
: Authorization credentials not submitted or invalid.

; 404 Not Found
: The account or product Id not found.

=== Response Body ===
The response body includes product specification change targets list when the ''getTargetProductSpecifications'' URI parameter is set to 1.

<nowiki>
{
"status": "open",
"name": "Product Name",
"billingCycle": 12,
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}",
"changes": [
{
"type": "upgrade",
"id": "{targetProductSpecificationId}",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{targetProductSpecificationId}"
},
]
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''.

; name - ''string''
: Name of the product.

; billingCycle - ''integer''
: Billing cycle of the product in months.

; productSpecification - ''string''
: Link to the specification of the current product.

; changes - ''list''
: A list with the valid product change targets. Returned if ''getTargetProductSpecifications=1'' query parameter is passed

; links - ''list''
: [[Hypermedia]] for the product resource

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

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

@@ Line 75: / Line 75: @@
 ; partnerId - ''string''
-: Partner id.
+: Partner Id specified for this product.
 ; links - ''list''

@@ Line 39: / Line 39: @@
    "name": "Product Name",
    "displayName": "My custom product name",
-   "partnerId": "Partner purchased plan Id",
+   "partnerId": "Partner Id",
    "billingCycle": 12,
    "productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}",
@@ Line 75: / Line 75: @@
 ; partnerId - ''string''
-: Partner purchased  plan id.
+: Partner id.
 ; links - ''list''

@@ Line 70: / Line 70: @@
 ; changes - ''list''
 : A list with the valid product change targets. Returned if ''getTargetProductSpecifications=1'' query parameter is passed
 ; links - ''list''