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

From Hostway API Documentation
Jump to: navigation, search

OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes

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}/notes

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 request was not properly authorized.
403 Forbidden Unauthorized: NotesView failed permission check The client does not have permissions for this operation.
404 Not Found Resource not found The order, product or service doesn't 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:

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox