Orders-orderId-account-products-productId-services-serviceId-notes:GET
From Hostway API Documentation
GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes
Get all notes for a given service.
Contents |
Request
GET /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 product
URI Parameters
None.
Request Headers
Response
Status Code
| Status Code | Error Message | Description |
|---|---|---|
| 200 OK | - | The notes for the service (if any) are successfully returned. |
| 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 to get information about the notes. |
| 404 Not Found | Resource not found | The client is trying to get the notes for non existing order, product or service. |
| 502 Bad Gateway | - | Unexpected backend response. |
Response Body
Successful response
200 OK
{
"notes": ["xx", "zz"],
"links": [
{"href": "https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{serviceId}/notes", "rel": "self"}
]
}
Parameters
- notes - list
- List of the notes for the given service.
- links - list
- Hypermedia for the list of notes resources
Error responses
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.
403 Forbidden - the client does not have access to get the information about the notes for a service.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: NotesView failed permission check",
"code": 403,
"details": ""
}
}
404 Not Found - the order, the product or the service doesn't exist.
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}
See also
