Category

Create category#

Creates new category.

POST
/survey/categories

Request body:

Attribute	Type	Description	Nullable
name	String	Category name	false
active	Boolean	Category activity	false
unavailableIfBusinessDirIds	List of integers	Id of business directions which category not available	true
unavailableIfGroupIds	List of integers	Id of groups which category not available	true
unavailableIfUserIds	List of integers	Id of users who category not available	true

Response

Returns Category object

Examples

curl --request POST https://api.qvalon.com/v1/survey/categories \
--header 'Authorization: Bearer <your_token>' \
-d '{"active":true,"name":"test category","unavailableIfBusinessDirIds":[],"unavailableIfGroupIds":[],"unavailableIfUserIds":[100]}'

200 OK

[
  {
    "id": "6082a9737eb7af765469e731",
    "name": "test category",
    "tenant": "yourCompany",
    "active": true,
    "templateIds": [],
    "unavailableIfBusinessDirIds": [],
    "unavailableIfGroupIds": [],
    "unavailableIfUserIds": [
      100
    ]
  }
]

Update category#

Update category.

PUT
/survey/categories/{id}

Request body:

Attribute	Type	Description	Nullable
name	String	Category name	false
active	Boolean	Category activity	false
unavailableIfBusinessDirIds	List of integers	Id of business directions which category not available	true
unavailableIfGroupIds	List of integers	Id of groups which category not available	true
unavailableIfUserIds	List of integers	Id of users who category not available	true

Response

Returns Category object

Examples

curl --request PUT https://api.qvalon.com/v1/survey/categories/6082a9737eb7af765469e731 \
--header 'Authorization: Bearer <your_token>' \
-d '{"active":true,"name":"update test category","unavailableIfBusinessDirIds":[],"unavailableIfGroupIds":[],"unavailableIfUserIds":[100]}'

200 OK

[
  {
    "id": "6082a9737eb7af765469e731",
    "name": "update test category",
    "tenant": "yourCompany",
    "active": true,
    "templateIds": [],
    "unavailableIfBusinessDirIds": [],
    "unavailableIfGroupIds": [],
    "unavailableIfUserIds": [
      100
    ]
  }
]

Get list categories#

Get categories by filter

GET
/survey/categories

Request parameters:

Request Parameter	Type	Description	Required
active	Boolean	Return categories by activity	false
quick	Boolean	Return categories by quick setting	false
notEmpty	Boolean	return categories with templates	false

Response

Returns a list ofCategory objects

Examples

curl https://api.qvalon.com/v1/survey/categories?active=true \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "id": "606ac4f65b784e60cb88cb5b",
    "type": "SURVEY",
    "categoryId": "606ac4e55b784e60cb88cb5a",
    "categoryName": "Test category",
    "deleted": false,
    "hidden": false,
    "tenant": "kot",
    "name": "Test template",
    "withGrades": false,
    "questionsCount": 4,
    "updateAt": "2021-04-23T08:34:21.031",
    "labels": {},
    "quick": false
  }
]