Orders-orderId-account-products-productId-services-serviceId-attributes:OPTIONS

(Difference between revisions)
Jump to: navigation, search
(See also)
m (1 revision: Release 85)

Revision as of 16:31, 27 September 2013

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

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.

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


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox