Orders-orderId-account-products-productId-services-serviceId-attributes:GET
(Difference between revisions)
Mike.robski (Talk | contribs) |
(→See also) |
||
Line 42: | Line 42: | ||
=== Response Body === | === Response Body === | ||
− | Will be a dictionary whose keys/values are specific to the service category of the service. | + | Will be a dictionary whose keys/values are specific to the service category of the service. See [[ServiceAttributesStructure | Service Attributes Structure]]. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
== See also == | == See also == | ||
* [[Orders|Orders API]] | * [[Orders|Orders API]] | ||
* [[Common Features]] | * [[Common Features]] | ||
+ | * [[ServiceAttributesStructure | Service Attributes Structure]] | ||
{{disqus}} | {{disqus}} | ||
[[Category:Hostway API]] | [[Category:Hostway API]] | ||
[[Category:Ordering API]] | [[Category:Ordering API]] |
Revision as of 06:01, 23 September 2013
GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes
Get the Attributes of a given Service. Not all services will have attributes; depending on the service, this call may return a response code of 405 (Method not supported). If attributes are supported on the service, but have not yet been set, this call will return an empty dictionary in the response body.
Contents |
Request
GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
- productId - string
- UUID specifying the product
- serviceId - string
- UUID specifying the service
URI Parameters
None.
Request Headers
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Response
Status Code
- 200 OK
- Success.
- 401 Unauthorized
- The OwnerId cookie was not specified or is incorrect.
- 403 Forbidden
- The client does not have permissions to add services.
- 404 Not Found
- An account has not been added to the given order or the order does not exist.
- 405 Method Not Allowed
- The service does not support attributes.
Response Body
Will be a dictionary whose keys/values are specific to the service category of the service. See Service Attributes Structure.
See also