Latest revision as of 22:50, 16 December 2014

GET /email/secretQuestionSettings

Get franchise specific secret question settings (e.g. minimum required number of secret questions, etc.)

Request

GET /email/secretQuestionSettings

Response

Status Code

200 OK

Success

Response Body

Retrieves dictionary of secret question settings.

{
   "minimum": 1,
   "links": [
      {
         "location": "https://api.hostway.com/email/secretQuestionSettings", 
         "rel": "self"
      }
   ]
}
 

Parameters

minimum - integer

A minimum number of secret questions/answers pairs required to be on file for each email account.

The minimum value for this parameter is one.

links - list

Hypermedia to the secret question settings resource

Examples

Success getting secret question settings

Request

GET /email/secretQuestionSettings
 

Response

200 OK

{
   "minimum": 3,
   "links": [
      {
         "location": "https://api.hostway.com/email/secretQuestionSettings", 
         "rel": "self"
      }
   ]
}