Accounts-accountId-products-productId-services-serviceId:GET
From Hostway API Documentation
Revision as of 12:23, 31 January 2014 by Mike.robski (Talk | contribs)
GET /accounts/{accountId}/products/{productId}/services/{serviceId}
Get service information.
Contents |
Request
GET /accounts/{accountId}/products/{productId}/services/{serviceId}
Parameters
- accountId - string
- The Id of the account.
- productId - string
- The Id of the product.
- serviceId - string
- The Id of the service.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Status Code
- 200 OK
- Success.
- 401 Unauthorized
- Authorization credentials not submitted or invalid.
- 404 Not Found
- The account, product Id or service Id not found.
Response Body
{
"status": "open",
"name": "Service Name",
"billingCycle": 12,
"serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecificationId}",
"links": [
{"href": "https://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}", "rel": "self"}
]
}
Parameters
- status - string
- Current status of the service. Allowed values are new, pending, open, suspended, close_pending, closed and purge_pending.
- name - string
- Name of the service.
- billingCycle - integer
- Billing cycle of the service in months.
- serviceSpecification - string
- Link to the specification of the current service.
- links - list
- Hypermedia for the service resource
See also
