Orders-orderId-account-products:GET - Revision history

Mike.robski: 1 revision: Release 99

2014-10-14T15:06:57Z

1 revision: Release 99

Emanuela.mitreva: /* GET /orders/{orderId}/account/products */

2014-10-01T13:58:25Z

GET /orders/{orderId}/account/products

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:32Z

1 revision: Release 98

Emanuela.mitreva: /* Parameters */

2014-09-05T13:16:02Z

Parameters

Mike.robski: 1 revision

2013-02-17T06:58:59Z

1 revision

Mike.robski at 23:42, 15 February 2013

2013-02-15T23:42:26Z

New page

= GET /orders/''{orderId}''/account/products =
Get all Product in an account.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
;200 OK
: The operation was successfully completed.

; 401 Unauthorized
: The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.

; 404 Not Found
: The specified order does not exist.

=== Response Body ===
<nowiki>
{
"list": [
{
"status": "open",
"services": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}/services",
"offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
]
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; list - ''list''
: List of the products for the given account order. Each element of the list has the following attributes:

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

:; services - ''string''
:: A link to the services associated with the product

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

:; offering - ''string''
:: Link to the product catalogue offering specifying the given product

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

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

@@ Line 30: / Line 30: @@
 | This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
 | The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
 |-
 | 404 Not Found
 | Resource not found
 | The client is trying to get the products for non existing order.
 |}
 === Response Body ===
+==== Successful response ====
   <nowiki>
 OK
@@ Line 47: / Line 55: @@
        "offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
        "displayName": "My custom product name",
-       "partnerId": "Partner purchased plan Id",
+       "partnerId": "PartnerId",
        "links": [
          {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
@@ Line 61: / Line 69: @@
 }</nowiki>
-==== Parameters ====
+===== Parameters =====
 ; list - ''list''
 : List of the products for the given account order. Each element of the list has the following attributes:
 :; status - ''string''
-:: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''
+:: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''closed''' and '''purged'''
 :; services - ''string''
@@ Line 75: / Line 83: @@
 :; partnerId - ''string''
-:: Partner purchased plan id.
+:: Partner id.
 :; links - ''list''
@@ Line 86: / Line 94: @@
 : [[Hypermedia]] for the list of product resources
+==== Error responses ====
   <nowiki>401 Unauthorized
@@ Line 92: / Line 100: @@
   <nowiki>
-Not Found
+Forbidden - the client does not have permission to get the products.
+{
      "itemNotFound": {
@@ Line 99: / Line 118: @@
          "code": 404,
          "details": ""
+     }
 }</nowiki>

@@ Line 18: / Line 18: @@
 === Status Code ===
-;200 OK
+{| class="wikitable"
-: The operation was successfully completed.
+! Status Code
-; 401 Unauthorized
+=== Response Body ===
-: The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
   <nowiki>
+{
    "list": [
@@ Line 35: / Line 46: @@
        "services": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}/services",
        "offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
        "links": [
          {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
@@ Line 41: / Line 54: @@
    ],
    "links": [
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/", "rel": "self"}
+   ]
 }</nowiki>
- </nowiki>
 ==== Parameters ====
@@ Line 55: / Line 70: @@
 :; services - ''string''
 :: A link to the services associated with the product
 :; links - ''list''
@@ Line 64: / Line 85: @@
 ; links - ''list''
 : [[Hypermedia]] for the list of product resources
 == See also ==