A survey that can be answered by the user

PUT 
/surveys/:id

Returns a survey compatible with the format supported by SurveyJS (https://surveyjs.io/survey-creator)

Request

Path Parameters

id stringrequired

Possible values: non-empty and <= 100 characters

Query Parameters

branding string

Possible values: <= 100 characters

If you have a branded content version, please supply it here

language LanguageCode

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[a-z]{2}$

application/json

Body

profile

object

Represents a Climate Profile for a User.

activities object

Tracks which activities have been suggested

attributes

object

required

Attributes defining this profile

country stringrequired

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

ISO 3166-1 alpha-2 format country code

demo integerrequired

Possible values: <= 9007199254740991

diet integerrequired

Possible values: <= 9007199254740991

energy integerrequired

Possible values: <= 9007199254740991

lifestyle integerrequired

Possible values: <= 9007199254740991

transport integerrequired

Possible values: <= 9007199254740991

benchmarks object

Tracks benchmark data

comparisons object

Tracks comparison data

created date-timerequired

Created date

insights object

Tracks which insights have been displayed

persona stringrequired

Possible values: non-empty and <= 100 characters

ID of the persona

surveys object

Tracks surveys data

traits

object

required

Scores for knowledge, lifestyle and motivation

knowledge numberrequired

Possible values: <= 1

Knowledge score

lifestyle numberrequired

Possible values: <= 1

Lifestyle score

motivated numberrequired

Possible values: <= 1

Motivation score

v stringrequired

Possible values: non-empty and <= 100 characters

Version for this profile

Responses

200

Adjusted transactions based on you profile

application/json

Schema

Schema

payload

object

required

id stringrequired

Possible values: non-empty and <= 50 characters

Id of survey

survey

object

required

SurveyJS compatible survey. See https://surveyjs.io/

completedHtml string

Possible values: <= 1048576 characters

Example:

Thank you

description string

Possible values: non-empty and <= 999 characters

Description

loadingHtml string

Possible values: <= 1048576 characters

Example: Loading

logo string

Possible values: <= 4194304 characters

Base64 encoded data url

logoFit string

Possible values: [contain, cover, fill, none]

css object-fit property

pages

object[]

required

Pages containing questions

Array [

elements

object[]

required

Array containing the questions for this page

Array [

choices

object[]

dropdown or choice

Array [

text stringrequired

Possible values: non-empty and <= 999 characters

Display value

value stringrequired

Possible values: non-empty and <= 50 characters

Value stored when answering

]

choicesByUrl

object

if fetching options from a REST service

titleName stringrequired

Possible values: non-empty and <= 999 characters

display value

url stringrequired

Possible values: non-empty and <= 2048 characters

REST service endpoint

valueName stringrequired

Possible values: non-empty and <= 50 characters

value stored when answering

description stringrequired

Possible values: non-empty and <= 999 characters

Description

name stringrequired

Possible values: non-empty and <= 50 characters

rateValues

object[]

rate

Array [

text stringrequired

Possible values: non-empty and <= 999 characters

Display value

value stringrequired

Possible values: non-empty and <= 50 characters

Value stored when answering

]

title stringrequired

Possible values: non-empty and <= 999 characters

Question

type stringrequired

Possible values: [boolean, dropdown, radiogroup, rating]

radiogroup, dropdown, rating, boolean

]

name stringrequired

Possible values: non-empty and <= 50 characters

Name of this page default: pageNN ex page3

visibleIf string

Possible values: <= 200 characters

Please see https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#conditional-visibility

]

title string

Possible values: non-empty and <= 100 characters

Title of survey

version stringrequired

Possible values: non-empty and <= 50 characters

Survey version number

profile

object

Represents a Climate Profile for a User.

activities object

Tracks which activities have been suggested

attributes

object

required

Attributes defining this profile

country stringrequired

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

ISO 3166-1 alpha-2 format country code

demo integerrequired

Possible values: <= 9007199254740991

diet integerrequired

Possible values: <= 9007199254740991

energy integerrequired

Possible values: <= 9007199254740991

lifestyle integerrequired

Possible values: <= 9007199254740991

transport integerrequired

Possible values: <= 9007199254740991

benchmarks object

Tracks benchmark data

comparisons object

Tracks comparison data

created date-timerequired

Created date

insights object

Tracks which insights have been displayed

persona stringrequired

Possible values: non-empty and <= 100 characters

ID of the persona

surveys object

Tracks surveys data

traits

object

required

Scores for knowledge, lifestyle and motivation

knowledge numberrequired

Possible values: <= 1

Knowledge score

lifestyle numberrequired

Possible values: <= 1

Lifestyle score

motivated numberrequired

Possible values: <= 1

Motivation score

v stringrequired

Possible values: non-empty and <= 100 characters

Version for this profile

Example (from schema)

{
  "payload": {
    "id": "string",
    "survey": {
      "completedHtml": "string",
      "description": "string",
      "loadingHtml": "string",
      "logo": "string",
      "logoFit": "contain",
      "pages": [
        {
          "elements": [
            {
              "choices": [
                {
                  "text": "string",
                  "value": "string"
                }
              ],
              "choicesByUrl": {
                "titleName": "string",
                "url": "string",
                "valueName": "string"
              },
              "description": "string",
              "name": "string",
              "rateValues": [
                {
                  "text": "string",
                  "value": "string"
                }
              ],
              "title": "string",
              "type": "boolean"
            }
          ],
          "name": "string",
          "visibleIf": "string"
        }
      ],
      "title": "string"
    },
    "version": "string"
  },
  "profile": {
    "activities": {},
    "attributes": {
      "country": "string",
      "demo": 0,
      "diet": 0,
      "energy": 0,
      "lifestyle": 0,
      "transport": 0
    },
    "benchmarks": {},
    "comparisons": {},
    "created": "2024-07-29T15:51:28.071Z",
    "insights": {},
    "persona": "string",
    "surveys": {},
    "traits": {
      "knowledge": 0,
      "lifestyle": 0,
      "motivated": 0
    },
    "v": "string"
  }
}

400

Bad request

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

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

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

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

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "BAD_REQUEST",
      "description": "Bad input parameter",
      "recoverable": false
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

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

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

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

Example

{
  "errors": [
    {
      "reasonCode": "FORBIDDEN",
      "description": "Access denied",
      "recoverable": false,
      "details": "You do not have access to this resource",
      "source": "Engagement Services"
    }
  ]
}

403

Insufficient scope for accessing this resource

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

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

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

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

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "FORBIDDEN",
      "description": "Access denied",
      "details": "Insufficient scope for accessing this resource",
      "recoverable": false
    }
  ]
}

404

Not found

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

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

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

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

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "BAD_REQUEST",
      "description": "The requested resource was not found. Please verify the resource path.",
      "recoverable": false
    }
  ]
}

500

Unexpected server error

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

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

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

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

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "INTERNAL_SERVER_ERROR",
      "description": "Internal server error",
      "details": "An error occurred",
      "recoverable": false
    }
  ]
}

Loading...