Custom questions

A custom questionnaire is made up of a set of custom questions. Use the API to list all custom questions created for your organization. View details including the question type (eg multi-choice, waiver, date picker) and the settings (eg if it's mandatory, if answer share is enabled, and who set it up).

Learn more about custom questions in the OnLocation Help Center.

List all custom questions

Returns a list of all custom questions. 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 question 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 questions

403

Access denied to this resource

404

Resource not found

get/custom-questionnaire/question

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api.whosonlocation.com/v1/custom-questionnaire/question?q=string&order=string&limit=0&page=0' \
  -H 'If-Modified-Since: string'

Response samples

[{"id": 976,
"created": "2021-11-25T12:51:26+13:00",
"modified": "2021-11-30T12:51:26+13:00",
"questionnaire_id": 498,
"question": "Example Waiver Question",
"type": "waiver",
"compulsory": true,
"answershare": true,
"order": 9999,
"parent_id": 974,
"parent_key": 0,
"version": 2,
"setup_by": 855,
"settings_options": [["I acknowledge",
"I do not acknowledge"
]
],
"settings_options_unique": [[1,
2
]
],
"settings_waiver": "Example waiver",
"settings_video": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"settings_image": {"title": "Waiver Image",
"thumb": "https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png",
"full": "https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png"
},
"settings_signature": true,
"settings_copy": true,
"settings_copy_host": true,
"settings_send_recipients": [[554,
2754
]
],
"settings_email_non_staff": "example-email@whosonlocation.com"
}
]

Retrieve a custom question

Returns a custom question record filtered by the provided ID.

Request

path Parameters

required

integer <int32>

ID of the question record to look for

Responses

200

The custom question record matching the passed in ID

403

Access denied to this resource.

404

Resource not found.

get/custom-questionnaire/question/{id}

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api.whosonlocation.com/v1/custom-questionnaire/question/:id

Response samples

{"id": 976,
"created": "2021-11-25T12:51:26+13:00",
"modified": "2021-11-30T12:51:26+13:00",
"questionnaire_id": 498,
"question": "Example Waiver Question",
"type": "waiver",
"compulsory": true,
"answershare": true,
"order": 9999,
"parent_id": 974,
"parent_key": 0,
"version": 2,
"setup_by": 855,
"settings_options": [["I acknowledge",
"I do not acknowledge"
]
],
"settings_options_unique": [[1,
2
]
],
"settings_waiver": "Example waiver",
"settings_video": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"settings_image": {"title": "Waiver Image",
"thumb": "https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png",
"full": "https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png"
},
"settings_signature": true,
"settings_copy": true,
"settings_copy_host": true,
"settings_send_recipients": [[554,
2754
]
],
"settings_email_non_staff": "example-email@whosonlocation.com"
}