ProductSpecifications-productSpecificationId-offerings-offeringId:GET - Revision history

Corinne.chui: 1 revision

2016-05-30T19:36:49Z

1 revision

Emanuela.mitreva at 11:38, 15 October 2015

2015-10-15T11:38:58Z

Mike.robski: 1 revision: Release 96

2014-07-31T14:42:44Z

1 revision: Release 96

Dinh.anh: /* URI Parameters */

2014-07-08T15:11:17Z

URI Parameters

Mike.robski: 1 revision: Release 85

2013-09-27T21:57:49Z

1 revision: Release 85

Mike.robski at 22:53, 15 February 2013

2013-02-15T22:53:25Z

Mike.robski at 22:50, 15 February 2013

2013-02-15T22:50:21Z

Mike.robski: 1 revision

2013-02-15T22:40:50Z

1 revision

Mike.robski at 19:42, 15 February 2013

2013-02-15T19:42:27Z

New page

= GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}'' =
Retrieves product specification offering details.
__TOC__

== Request ==
<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''</code>

== Response ==
Returns a dictionary of product specification offering details

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

;404 Not Found
: Returned if the product specification Id or the offering Id could not be found.

=== Response Body ===
<nowiki>
{
"billingPeriod": 3,
"currency": "USD",
"default": 1,
"prices": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/prices",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; billingPeriod - ''integer''
: Price's billing period in months

; currency - ''string''
: Price's currency

; default - ''integer''
: Specifies whether the offering uses the default billing cycle. Allowed values are '''0''' and '''1'''

; prices - ''link''
: Hyperlink to the product's offerings prices

; links - ''list''
: [[Hypermedia]] for this resource.

== See also ==
* [[Products|Product Catalog API]]
* [[Common Features]]

[[Category:Hostway API]]
[[Category:Product Catalog API]]

@@ Line 83: / Line 83: @@
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/", "rel": "self"}
+   ]
 } </nowiki>
- </nowiki>
 ==== Parameters ====
@@ Line 123: / Line 122: @@
 '''Request'''
   <nowiki>
-GET /productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=2 </nowiki>
+GET /productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=2&pageSize=10 </nowiki>
 '''Response'''
@@ Line 134: / Line 133: @@
+     {
        "type": "fee"
        "name": "recurring",
        "amount": 1125.0,
        "billingPeriod": 3,

@@ Line 4: / Line 4: @@
 == Request ==
-<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''</code>
+<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}'' </code>
 == Response ==
@@ Line 12: / Line 66: @@
 ;200 OK
 : Success
 ;404 Not Found
 : Returned if the product specification Id or the offering Id could not be found.
-−
 === Response Body ===
   <nowiki>
@@ Line 41: / Line 98: @@
 ; prices - ''link''
 : Hyperlink to the product's offerings prices
+: If request contains '''details''' parameter - response will return [[ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET#Parameters|prices parameters]] instead of hyperlink
 ; links - ''list''
 : [[Hypermedia]] for this resource.
 == See also ==

@@ Line 49: / Line 49: @@
 * [[Common Features]]
 [[Category:Hostway API]]
 [[Category:Product Catalog API]]