Template

Create template

Creates a new template. Requires the ROLE_SURVEY_ADMIN role.

• POST
• /survey/templates

Request body:

Attribute	Type	Description	Nullable
name	String	Template name	false
type	Enum of string	Template type: FORM, PHOTO_REPORT, SURVEY, APPLICATION	true
quick	Boolean	Whether this is a template for quick surveys	true
categoryId	String	Identifier of the template category	false
gradeConditions	List objects	Result grade thresholds (only for surveys with grades). See the gradeConditions field on the Template object	true
showGrades	Boolean	Whether to show grades when taking a survey. Default false	true
withGrades	Boolean	Whether the template uses grades. Default false	true
deleted	Boolean	Whether the template is deleted. Default false	true
hidden	Boolean	Whether the template is hidden from users. Default false	true

Response

Returns the created Template object

Examples

curl --request POST https://api.qvalon.com/v1/survey/templates \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"name":"Cleanliness survey","type":"SURVEY","quick":false,"categoryId":"60826e00f5636740f6ef148a","gradeConditions":[],"showGrades":true,"withGrades":true}'

200 OK

{

"id": "60826e0ef5636740f6ef148b",

"type": "SURVEY",

"categoryId": "60826e00f5636740f6ef148a",

"categoryName": "Merchandising",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey",

"withGrades": true,

"showGrades": true,

"questionsCount": 0,

"gradeConditions": [],

"labels": {},

"quick": false,

"signatureRequired": false,

"withCatalog": false

}

Update template

Updates a template's settings, or deactivates it by passing deleted: true. The template id is part of the request body, not the URL. Requires the ROLE_SURVEY_ADMIN role.

• PUT
• /survey/templates

Request body:

Attribute	Type	Description	Nullable
id	String	Identifier of the template to update	false
name	String	Template name	false
quick	Boolean	Whether this is a template for quick surveys	true
categoryId	String	Identifier of the template category	false
gradeConditions	List objects	Result grade thresholds (only for surveys with grades). See the gradeConditions field on the Template object	true
showGrades	Boolean	Whether to show grades when taking a survey	true
withGrades	Boolean	Whether the template uses grades	true
deleted	Boolean	Whether the template is deleted	true
hidden	Boolean	Whether the template is hidden from users	true

Response

Returns the updated Template object

Examples

curl --request PUT https://api.qvalon.com/v1/survey/templates \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"id":"60826e0ef5636740f6ef148b","name":"Cleanliness survey updated","quick":false,"categoryId":"60826e00f5636740f6ef148a","gradeConditions":[],"showGrades":false,"withGrades":false,"deleted":false,"hidden":false}'

200 OK

{

"id": "60826e0ef5636740f6ef148b",

"type": "SURVEY",

"categoryId": "60826e00f5636740f6ef148a",

"categoryName": "Merchandising",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey updated",

"withGrades": false,

"showGrades": false,

"questionsCount": 0,

"gradeConditions": [],

"labels": {},

"quick": false,

"signatureRequired": false,

"withCatalog": false

}

List templates

Returns a list of Template objects matching the given filter.

• POST
• /survey/templates/all

Request parameters:

Request Parameter	Type	Description	Required
page	Integer	Page number (0-based)	false
size	Integer	Number of elements per page	false

Request body:

Attribute	Type	Description	Nullable
ids	List of strings	Find templates by ids	true
categoryId	String	Find templates by category id	true
type	Set of string	Find templates by type: FORM, PHOTO_REPORT, SURVEY, APPLICATION	true
onlyActive	Boolean	Only return non-deleted templates. Default true	true
withHidden	Boolean	Include hidden templates	true
withQuestionsOnly	Boolean	Only return templates that have at least one question	true
quick	Boolean	Find templates by "quick" flag	true
updateAfter	LocalDateTime	Only return templates modified after this date and time	true
search	String	Find templates by name	true

Examples

curl --request POST https://api.qvalon.com/v1/survey/templates/all?page=0&size=20 \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"search":"Cleanliness"}'

200 OK

[

{

"id": "606ac4f65b784e60cb88cb5b",

"type": "SURVEY",

"categoryId": "606ac4e55b784e60cb88cb5a",

"categoryName": "Merchandising",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey",

"withGrades": false,

"questionsCount": 4,

"updateAt": "2024-05-23T08:34:21.031",

"labels": {},

"quick": false,

"signatureRequired": false,

"withCatalog": false

}

]

Get short templates list

Same filter as List templates, but returns a shorter object per template (just the fields needed to display a picker), which is cheaper for large tenants.

• POST
• /survey/templates/short

Request parameters:

Request Parameter	Type	Description	Required
page	Integer	Page number (0-based)	false
size	Integer	Number of elements per page	false

Request body:

Attribute	Type	Description	Nullable
(body)	Object	Same filter fields as List templates	true

Examples

curl --request POST https://api.qvalon.com/v1/survey/templates/short?page=0&size=20 \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"search":"Cleanliness"}'

200 OK

[

{

"id": "606ac4f65b784e60cb88cb5b",

"name": "Cleanliness survey",

"categoryId": "606ac4e55b784e60cb88cb5a",

"categoryName": "Merchandising"

}

]

Get template by id

Returns a Template object by id

• GET
• /survey/templates/{id}

Examples

curl https://api.qvalon.com/v1/survey/templates/606ac4f65b784e60cb88cb5b \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"id": "606ac4f65b784e60cb88cb5b",

"type": "SURVEY",

"categoryId": "606ac4e55b784e60cb88cb5a",

"categoryName": "Merchandising",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey",

"withGrades": false,

"questionsCount": 4,

"updateAt": "2024-05-23T08:34:21.031",

"labels": {},

"quick": false,

"signatureRequired": false,

"catalogs": [],

"withCatalog": false,

"applications": []

}

Move to category

Moves a template from one category to another.

• PUT
• /survey/templates/{id}/move

Request parameters:

Request Parameter	Type	Description	Required
fromCategory	String	Identifier of the template's current category	true
toCategory	String	Identifier of the destination category	true

Response

Returns the moved Template object

Examples

curl --request PUT https://api.qvalon.com/v1/survey/templates/606ac4f65b784e60cb88cb5b/move?fromCategory=606ac4e55b784e60cb88cb5a&toCategory=608292857eb7af765469e730 \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"id": "606ac4f65b784e60cb88cb5b",

"type": "SURVEY",

"categoryId": "608292857eb7af765469e730",

"categoryName": "HR Surveys",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey",

"withGrades": false,

"questionsCount": 4,

"updateAt": "2024-05-23T09:25:35.020513",

"labels": {},

"quick": false,

"signatureRequired": false,

"withCatalog": false

}

Copy template

Creates a copy of an existing template, including its questions. Requires the ROLE_SURVEY_ADMIN role.

• POST
• /survey/templates/{id}/copy

Request parameters:

Request Parameter	Type	Description	Required
name	String	Name for the copy. Defaults to the original template's name if omitted	false
categoryId	String	Category for the copy. Defaults to the original template's category if omitted	false

Response

Returns the newly created Template object

Examples

curl --request POST https://api.qvalon.com/v1/survey/templates/606ac4f65b784e60cb88cb5b/copy?name=Cleanliness survey (copy) \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"id": "608286647eb7af765469e72f",

"type": "SURVEY",

"categoryId": "606ac4e55b784e60cb88cb5a",

"categoryName": "Merchandising",

"deleted": false,

"hidden": false,

"name": "Cleanliness survey (copy)",

"withGrades": false,

"questionsCount": 4,

"labels": {},

"quick": false,

"signatureRequired": false,

"withCatalog": false

}

Reorder template questions

Sets the display order of the template's questions.

• PUT
• /survey/templates/{id}/order

Request body:

Attribute	Type	Description	Nullable
(body)	List of strings	Question ids, in the order they should appear	false

Examples

curl --request PUT https://api.qvalon.com/v1/survey/templates/606ac4f65b784e60cb88cb5b/order \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '["912","913","914"]'

200 OK

{}