ServiceSpecifications-serviceSpecificationId:GET

From Hostway API Documentation
Jump to: navigation, search

GET /serviceSpecifications/{serviceSpecificationId}

Retrieves service specification details.

Contents


Request

GET /serviceSpecifications/{serviceSpecificationId}

Response

Returns a dictionary containing product specification details for a particular service specification.

Status Code

200 OK
Success
404 Not Found
Returned if the service specification Id could not be found.

Response Body

{
  "name": ".com Domain",
  "category": "Domain Registration",
  "ranking": 12,
  "attributes": "https://api.hostway.com/servicespecifications/core.dnr.com/attributes",
  "billingCycles": [
    {
      "default": 0,
      "billingCycle": 1
    },
    {
      "default": 0,
      "billingCycle": 12
    }
  ],
  "links": [
    {"href": "https://api.hostway.com/servicespecifications/core.dnr.com/", "rel": "self"}
  ]
}
 

Parameters

name - string
The name of the service
category - string
Service category
ranking - integer
Service ranking value
attributes - string
A link to a resource containing the service's attributes
billingCycles - list
Contains a list of dictionaries, specifying the available billing cycles for the given service
default - integer
Whether the cycle is considered default. Allowed values are 0 and 1
billingCycle - integer
The specific billing cycle in months
links - list
Hypermedia for this resource. Link to self will preserve filtering, sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox