Getting the default feedback survey

Returns the default feedback survey link.

Warning

This endpoint can only be used after setting a default survey using the root account on the platform.

If no default survey is set, the endpoint will return a success = 0.

Info

icon	false

Status


colour	Yellow
title	GET

/survey/default_scale

Request

Expand

Request

Endpoint: /survey/default_scale

Method:

Status


colour	Yellow
title	GET

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
    "message": "link_to_survey"
}

Success response

Expand

title	Base Object

Base object:

Object property	Description
success	Represents if the call was successful
message	Represents the link to survey to be used for answering the survey

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Assigning / getting the scale for the user

Returns the survey data for the currently assigned scale or assigns a new one if a link is given.

Info

icon	false

Status


colour	Yellow
title	GET

/survey/get

Request

Expand

Request

Endpoint: /survey/get

Method:

Status


colour	Yellow
title	GET

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

survey_link

Status


subtle	true
colour	Red
title	NO

String

Survey link for the survey to be assigned to current user

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
    "instance_id": 28,
    "scale": {
        "id": 15,
        "title": "Feedback form",
        "description": "<p>Please fill out this feedback form!</p>",
        "type": 2
    },
    "items": [
        {
            "id": 20,
            "title": "What do you think about our gym?",
            "position": 1,
            "answers": {
                "2": {
                    "id": 2,
                    "title": "Goodn't :(",
                    "position": 1,
                    "value": 0
                },
                "13": {
                    "id": 13,
                    "title": "Good",
                    "position": 2,
                    "value": 0
                }
            },
            "actual_answer": "",
            "actual_value": ""
        },
        {
            "id": 21,
            "title": "What do you think about our offers?",
            "position": 2,
            "answers": {
                "2": {
                    "id": 2,
                    "title": "Goodn't :(",
                    "position": 1,
                    "value": 0
                },
                "13": {
                    "id": 13,
                    "title": "Good",
                    "position": 2,
                    "value": 0
                }
            },
            "actual_answer": "",
            "actual_value": ""
        }
    ]
}

Success response

Expand

title	Base Object

Base object:

Object property	Description
success	Represents if the call was successful
instance_id	Internal survey instance ID
scale	The survey object containing its data
items	Array containing the survey items to which the user should respond to

Expand

title	scale object

scale object:

Object property	Description
id	Internal ID of the survey
title	Survey title
description	Survey HTML description
type	Internal type of the survey: 1 - Single use per user 2 - Multiple use per user

Expand

title	items object

items object:

Object property	Description
id	Internal ID of the survey item
title	Survey item title
position	Position in the survey
answers	Array of answers for the survey item If it's empty, the user should be able to type in any response he wants.
actual_answer	An old answer given to that item (in case the user abandoned the survey before and now it came back) Internal form - Mosly as an ID, used mostly for fixed answer questions
actual_value	An old answer given to that item (in case the user abandoned the survey before and now it came back) Human readable form - Mostly as a text, used for open response questions

Expand

title	answers object

answers object:

Object of type ID - Properties

Object property	Description
id	Internal ID of the answer
title	Title of the answer
position	Position in the answer group
value	Internal value of the answer

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Responding to a survey

Info

icon	false

Status


colour	Green
title	POST

/survey/save

Request

Expand

Request

Endpoint: /survey/save

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

instance_id

Status


subtle	true
colour	Green
title	YES

Integer

Instance ID given at the Get scale for user endpoint.

items

Status


subtle	true
colour	Green
title	YES

Array of answer objects

Array of answer objects with the survey responses.

Answer object description:

Parameter

Required

Type

Description

id

Status


subtle	true
colour	Green
title	YES

Integer

Survey item ID

actual_answer

Status


subtle	true
colour	Red
title	NO

Integer

Survey answer ID

Used when the answer array is not empty when getting the survey data - Fixed answer question

actual_value

Status


subtle	true
colour	Red
title	NO

String

Survey answer - Plain text

Used when the answer array is empty when getting the survey data - Open response question

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
}

Success response

Expand

title	Base Object

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Canceling a survey

Cancels the survey answers for the given instance

Warning
This endpoint only works for type = 2 surveys

Info

icon	false

Status


colour	Red
title	Delete

/survey/cancel/{survey_instance_id}

Request

Expand

Request

Endpoint: /survey/delete/{survey_instance_id}

Method:

Status


colour	Red
title	delete

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

survey_instance_id

Status


subtle	true
colour	Green
title	YES

Integer

Instance ID given at the Get scale for user endpoint.

Response

Method:

Headers:

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
}

Success response

Expand

title	Base Object

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Expand

Request

Endpoint: /survey/save

Status

colour

Green

title

POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

ExpandParameterRequiredTypeDescriptioninstance_id StatussubtletruecolourGreentitleYESIntegerInstance ID given at the Get scale for user endpoint.items StatussubtletruecolourGreentitleYESArray of answer objects

Array of answer objects with the survey responses.

Answer object description:

ParameterRequiredTypeDescriptionid StatussubtletruecolourGreentitleYESIntegerSurvey item IDactual_answer StatussubtletruecolourRedtitleNOInteger

Survey answer ID

Used when the answer array is not empty when getting the survey data - Fixed answer question

actual_value StatussubtletruecolourRedtitleNOString

Survey answer - Plain text

Used when the answer array is empty when getting the survey data - Open response question

Version	Old Version 6	New Version Current
Changes made by	Flaviu Porutiu	Flaviu Porutiu
Saved on	Jun 26, 2018	Jun 26, 2018

Versions Compared

Key

Getting the default feedback survey

Request

Response

Assigning / getting the scale for the user

Request

Response

Responding to a survey

Request

Response

Canceling a survey

Request

Response

Page Comparison

Versions Compared

Key

Getting the default feedback survey

Request

Response

Assigning / getting the scale for the user

Request

Response

Responding to a survey

Request

Response

Canceling a survey

Request

Response