Latest revision as of 07:53, 15 September 2014

[edit] GET /email/secretQuestions

Get dictionary of supported secret questions with text keys.

[edit] Request

GET /email/secretQuestions

[edit] Request Headers

Content-Type

Required. Set this header to application/json; charset=UTF-8

[edit] Response

[edit] Status Code

200 OK

Success

[edit] Response Body

Retrieves dictionary of secret questions with text keys.

{
   "questions":
      {
         "{tk}": "{question}",
         "{tk}": "{question}",
         ...
      },
   "links": [
      {
         "location": "https://api.hostway.com/email/secretQuestions/", 
         "rel": "self"
      }
   ]
}
 

[edit] Parameters

questions - dictionary

A dictionary of secret questions text-key with their relevant explanation in plain-text

tk - string

Secret question text key.

question - string

The question in plain-text.

links - list

Hypermedia to the secret questions resource

[edit] Examples

[edit] Success getting supported secret questions with text keys

Request

GET /email/secretQuestions
 

Response

200 OK

{
   "questions":
      {
         "tk1": "What is question one?",
         "tk2": "What is question two?",
         "tk3": "What is question three?"
      },
   "links": [
      {
         "location": "https://api.hostway.com/email/secretQuestions/", 
         "rel": "self"
      }
   ]
}

[edit] No secret questions supported

Request

GET /email/secretQuestions
 

Response

200 OK

{
   "questions": {},
   "links": [
      {
         "location": "https://api.hostway.com/email/secretQuestions/", 
         "rel": "self"
      }
   ]
}