API – List of surveys – LMS Collaborator knowledge base.

Home/Technical requirements/API/API - List of surveys

API – List of surveys

Before making a request - log in as a user with the role of Administrator. How to log in via API is described here API – Authorization

To get the list of surveys you need to send GET request to the following URI http://your-domain.davintoo.com/api/rest.php/polls
The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:

curl 'http://your-domain.davintoo.com/api/rest.php/polls' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8'

Instead of a local address http://your-domain.davintoo.com you need to use the address of your instance.

The request supports filtering by the following fields:

title - Survey title
tags - Survey tags

Example of a request with a search by tag:

curl 'http://your-domain.davintoo.com/api/rest.php/tasks?filter[tags]=sales-manager'

Answer

In case of successful request (HTTP response code - 200), the following result will be returned:

data - survey array
pager - pagination object (information about the number of pages, the current page, the number of surveys)
counts - counter object (information about the number of surveys)

In case of error (HTTP code response - 400) it returns JSON object with information about the error