Accounts-accountNumber-web-domainName-sitebuilder:GET

From Hostway API Documentation
Jump to: navigation, search

GET /accounts/{accountNumber}/web/{domainName}/siteBuilder

Checks if CM4All product is enabled for a domain

Contents


Request

GET /accounts/{accountNumber}/web/{domainName}/siteBuilder

URI Parameters

accountNumber - string
The user account to which the domain name and the CM4All product belong
domainName - string
The target domain name (domain name under which the site is actually hosted)

Request Headers

Authorization - HTTP Authorization header [1]
The Authentication credentials of the client application.


Response

Response Body

{
"status": "{status}",
"productNumber": "{productNumber}",
"details": "{details}",

"links": [
          {"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/siteBuilder/", "rel": "self"},
          {"href": "http://{server_name}/accounts/{accountNumber}/products/{productId}/services/{serviceId}/?getTargetServiceSpecifications=1",
           "rel": "change"}
         ]
}
 

Parameters

status - string
Status of the page.
productNumber - string
The number of the product.
details - string
Details about the CM4All product, such as install version.
links - list
Hypermedia for this resource

Status Code

200 OK
Success
401 Unauthorized
The supplied credentials are invalid or do not provide permissions for this operation.
403 Forbidden
The authenticated user is not allowed to access this resource
404 Not Found
The domain name does not exist.


Examples

Check if CM4All is set for a domain

Request

GET /accounts/{account}/email/test.com/siteBuilder
 

Response

200 OK

{
"status": "open",
"productNumber": "test213",
"details": "CM4All_3.5",
"links": links": 
 [
  {"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/siteBuilder/", "rel": "self"}, 
  {"href": "http://{server_name}/accounts/{accountNumber}/products/{producitId}/services/{serviceId}/?getTargetServiceSpecifications=1", "rel": "change"}
 ]
}

 

blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox