Latest revision as of 13:16, 24 July 2015

[edit] GET /accounts/{accountNumber}/web/{domainName}/websiteBuilder

Checks if WebsPlanet product is enabled for a domain

[edit] Request

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

[edit] URI Parameters

accountNumber - string

The user account to which the domain name and the WebsPlanet product belong

domainName - string

The target domain name (domain name under which the site is actually hosted)

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

[edit] Response

[edit] Response Body

{
"status": "{status}",
"sso": "{sso}",
"trialAccount": "{trialAccount}",
"productNumber": "{productNumber}",

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

[edit] Parameters

status - string

Status of the page.

sso - string

A link for a Single Sign On

trialAccount - boolean

Returns "true" if the acccount is of a type trial, otherwise false.

productNumber - string

The number of the product.

links - list

Hypermedia for this resource

[edit] 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.

[edit] Examples

[edit] Check if WebsPlanet is set for a domain

Request

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

Response

200 OK

{
"status": "open",
"sso": "http://echo.wpb.stg.tam.us.siteprotect.com?seed=123"
"productNumber": "test123"
"links": links": 
 [
  {"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/websiteBuilder/", "rel": "self"}, 
  {"href": "http://{server_name}/accounts/{accountNumber}/products/{producitId}/services/{serviceId}/?getTargetServiceSpecifications=1", "rel": "change"}
 ]
}

 

[edit]