Orders-orderId-account-products-productId-services-serviceId-attributes:OPTIONS
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) m (1 revision: Release 99) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 18: | Line 18: | ||
=== Response Status Code === | === Response Status Code === | ||
| − | + | {| class="wikitable" | |
| − | + | ! Status Code | |
| − | + | ! Error Message | |
| − | + | ! Description | |
| − | + | |- | |
| − | + | | 200 OK | |
| − | + | | - | |
| − | : The client does not have permissions | + | | The operation was successfully completed. |
| − | + | |- | |
| − | + | | 401 Unauthorized | |
| − | + | | 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 was not specified or is incorrect. | ||
| + | |- | ||
| + | | 403 Forbidden | ||
| + | | Unauthorized: Attributes failed permission check | ||
| + | | The client does not have permissions for this operation. | ||
| + | |- | ||
| + | | 404 Not Found | ||
| + | | Resource not found | ||
| + | | The client is trying to add attribute for non existing order, product or service. | ||
| + | |- | ||
| + | | 502 Bad Gateway | ||
| + | | - | ||
| + | | Unexpected backend response. | ||
| + | |} | ||
=== Response Headers === | === Response Headers === | ||
| Line 36: | Line 50: | ||
=== Response Body === | === Response Body === | ||
A dictionary whose keys/values are specific to the service category of the service. Rather than returning actual service data, the body will contain a dictionary that provides hints for how to build the request body for a PUT request, for example: | A dictionary whose keys/values are specific to the service category of the service. Rather than returning actual service data, the body will contain a dictionary that provides hints for how to build the request body for a PUT request, for example: | ||
| + | |||
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 53: | Line 68: | ||
* [[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]] | ||
Latest revision as of 10:07, 14 October 2014
OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes
Get list of supported methods for this resource, plus some hints on the expected resource structure.
Contents |
Request
OPTIONS /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
Response
Response Status Code
| Status Code | Error Message | Description |
|---|---|---|
| 200 OK | - | The operation was successfully completed. |
| 401 Unauthorized | 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 was not specified or is incorrect. |
| 403 Forbidden | Unauthorized: Attributes failed permission check | The client does not have permissions for this operation. |
| 404 Not Found | Resource not found | The client is trying to add attribute for non existing order, product or service. |
| 502 Bad Gateway | - | Unexpected backend response. |
Response Headers
- Allow
- Contains a comma-separated list of methods that are allowed on this resource. For services that do not support attributes, this will contain only the OPTIONS method.
Response Body
A dictionary whose keys/values are specific to the service category of the service. Rather than returning actual service data, the body will contain a dictionary that provides hints for how to build the request body for a PUT request, for example:
{
"name": "String",
"numWidgets": "Integer",
"widgets": [
{
"id": "String",
"widgetType": "String",
"otherAttribute": "String"
}
]
}
See also
