Custom questionnaires

A custom questionnaire is a set of custom questions that are asked during sign in, sign out, or visitor pre-registration. The custom questionnaire API retrieves your custom questionnaires and can return single records based on an ID.

Learn more about custom questionnaires in the OnLocation Help Center.

List all custom questionnaires

Returns a list of all custom questionnaire records. The endpoint is limited to a maximum of 5,000 records.

A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.

Request
query Parameters
q
string <string>

Filter by any custom questionnaire value.

Example: q=498
order
string <string>

Specifies an element to order by. To order in reverse order, prepend the element with '-'.

Example: order=id
limit
integer <int32>

Limits the amount of records to return

Example: limit=10
page
integer <int32>

Specifies which page of results to return, most effective when used together with the 'limit' parameter

header Parameters
If-Modified-Since
string <int32>

A UTC timestamp (yyyy-mm-ddThh:mm:ss). Only entities created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Responses
200

List of custom questionnaire records

403

Access denied to this resource

404

Resource not found

get/custom-questionnaire
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/custom-questionnaire?q=string&order=string&limit=0&page=0' \
  -H 'If-Modified-Since: string'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Retrieve a custom questionnaire

Returns a custom questionnaire record filtered by the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the custom questionnaire to look for

Responses
200

The custom questionnaire element matching the passed in ID

403

Access denied to this resource.

404

Resource not found.

get/custom-questionnaire/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/custom-questionnaire/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 498,
  • "created": "2021-11-25T12:45:45+13:00",
  • "modified": "2021-11-25T12:51:48+13:00",
  • "active": true,
  • "name": "Health Check",
  • "record_type": "visitor",
  • "setup_by": 823,
  • "frequency": "every",
  • "frequency_days": 1,
  • "location_id": 301
}