Start a new survey session or restart a current one

POST 
/surveys/sessions

Creates a survey session token, which is returned back to the client along with the id of the first question for this survey

Request

application/json

Body

required

The start survey request

language string

ISO 639-1: two-letter code, defaults to en

token string

Optional token to identify this session. Will be auto-generated if omitted

reset boolean

Resets the answered survey if true

sector string

Possible values: [transport, lifestyle, diet, home, publicservices, intro, personal, summary]

If a specific sector-specific questionnaire is to be created with this session.

Responses

200

Returns a newly created token to be used throughout to identify the session in subsequent requests along with the id of the first question to be answered

application/json

Schema

Schema

token stringrequired

Token identifying this session

firstQuestionId stringrequired

The first unanswered question in the questionnaire

isComplete booleanrequired

Boolean indicating if survey is complete

Example (from schema)

{
  "token": "string",
  "firstQuestionId": "string",
  "isComplete": true
}

400

Bad Request

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

401

Unauthorized client

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

403

Insufficient scope for accessing this resource

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

405

Method not allowed

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

500

Unexpected server error

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

Loading...