Accounts-accountId-products-productId-services-serviceId:GET
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 90) |
(→Response Body) |
||
| Line 36: | Line 36: | ||
"status": "open", | "status": "open", | ||
"name": "Service Name", | "name": "Service Name", | ||
| + | "displayName": "service-related-domain.com", | ||
"billingCycle": 12, | "billingCycle": 12, | ||
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}", | "serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}", | ||
"links": [ | "links": [ | ||
| − | {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId}", "rel": "self"} | + | { |
| + | "href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/services/{serviceId}", | ||
| + | "rel": "self" | ||
| + | }, | ||
| + | { | ||
| + | "href": "</nowiki>{{APIBaseURL}}<nowiki>/{detailsLink}", | ||
| + | "rel": "manage" | ||
| + | } | ||
] | ] | ||
} | } | ||
| Line 50: | Line 58: | ||
; name - ''string'' | ; name - ''string'' | ||
: Name of the service. | : Name of the service. | ||
| + | |||
| + | ; displayName - ''string'' | ||
| + | : Domain name for the service if any exists. | ||
; billingCycle - ''integer'' | ; billingCycle - ''integer'' | ||
| Line 58: | Line 69: | ||
; links - ''list'' | ; links - ''list'' | ||
| − | : [[Hypermedia]] for the service resource | + | : ''self'' - [[Hypermedia]] for the service resource |
| + | : ''manage'' - [[Hypermedia]] for some service types. ''detailsLink'' format is: | ||
| + | :: for Domain type: ''domains/{domainName}/details''. Please see: [[Domains-domainName-details:GET]] | ||
| + | :: for Email type: ''accounts/{accountId}/email/{domainName}''. Please see: [[Accounts-account-email-domain:GET]] | ||
| + | :: for Exchange type: ''accounts/{accountId}/exchange/{domainName}/mailboxes''. Please see: [[GET Exchange Mailboxes list]] | ||
| + | :: for Dedicated Server type: ''accounts/{accountId}/dedicatedServers/{serverId}''. Please see: [[Accounts-account-dedicatedServers-server:GET]] | ||
== See also == | == See also == | ||
Revision as of 10:05, 11 September 2014
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",
"displayName": "service-related-domain.com",
"billingCycle": 12,
"serviceSpecification": "https://api.hostway.com/serviceSpecifications/{serviceSpecificationId}",
"links": [
{
"href": "https://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}",
"rel": "self"
},
{
"href": "https://api.hostway.com/{detailsLink}",
"rel": "manage"
}
]
}
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.
- displayName - string
- Domain name for the service if any exists.
- billingCycle - integer
- Billing cycle of the service in months.
- serviceSpecification - string
- Link to the specification of the current service.
- links - list
- self - Hypermedia for the service resource
- manage - Hypermedia for some service types. detailsLink format is:
- for Domain type: domains/{domainName}/details. Please see: Domains-domainName-details:GET
- for Email type: accounts/{accountId}/email/{domainName}. Please see: Accounts-account-email-domain:GET
- for Exchange type: accounts/{accountId}/exchange/{domainName}/mailboxes. Please see: GET Exchange Mailboxes list
- for Dedicated Server type: accounts/{accountId}/dedicatedServers/{serverId}. Please see: Accounts-account-dedicatedServers-server:GET
See also
