QuestionType ID:

1

Input - Short Answer

{
"Answer": "Test",
"QuestionId": 325,
"Title": "Input - Short Answer",
"AnswerType": "String (Single Line)",
"QuestionType": {
"ID": 1,
"Description": "Input - Short Answer"
}

{"QuestionId":325,"Answer":"Test"}

Input - Long Answer

{
"Answer": "Test\r\nTest",
"QuestionId": 326,
"Title": "Input - Long Answer",
"AnswerType": "String (Memo)",
"QuestionType": {
"ID": 12,
"Description": "Input - Long Answer"
}

{"QuestionId":326,"Answer":"Test\r\nTest"}

QuestionType ID:

9

Input - Drop-down

Single-select dropdown. Must be linked to either a standard or custom OptionType (use GET /api/options/ to see all OptionTypes). In Eploy, these Question Type may either be rendered as Drop-downs or Multiple Choice (single-select radio buttons), but both are the same QuestionType in the API.

Note that the API response provides the "Id", "Description" and "Reference" for the option that has been selected (also "ArchiveDate" would be populated if the option had been archived since it was answered, and "ParentId" may be populated for certain drop-down fields that have parental structure, such as Locations).

{
"Answer": {
"Id": "147",
"Description": "Test1",
"Reference": "1",
"ArchiveDate": null,
"ParentId": null,
"OptionType": {
"Id": 33,
"Url": "https://integrationsdemo.eploy.net/api/options/custom/33",
"Description": "Test Option Type",
"Type": "custom"
}
},
"QuestionId": 327,
"Title": "Input - Drop-down",
"AnswerType": "Option Group (Related)",
"QuestionType": {
"ID": 9,
"Description": "Input - Drop-down"
}

{"QuestionId":327,"Answer":147}

Input - Drop-down (Text)

Single-select dropdown, with the option to select 'Other - Please Specify' and provide a custom answer as free-text. Must be linked to either a standard or custom OptionType (use GET /api/options/ to see all OptionTypes).

Note that although Dropdown (Text) questions are linked to OptionTypes in Eploy, the API response will only output the Description from the dropdown entry if an option is selected, or the custom text that has been input if the 'Other - Please Specify' was used. If you PATCH a Dropdown (Text) question, you need to pass a string. This will either be mathed against an existing dropdown option in Eploy, or specified as 'Other - Please Specify' with a custom string answer if no match is found.

{
"Answer": "Test",
"QuestionId": 328,
"Title": "Input - Drop-down (Text)",
"AnswerType": "Option Group (Text)",
"QuestionType": {
"ID": 13,
"Description": "Input - Drop-down (Text)"
}

{"QuestionId":328,"Answer":"Test"}

Input - Checkboxes

{
"Answer": [
{
"Id": "147",
"Description": "Test1",
"Reference": "1",
"ArchiveDate": null,
"ParentId": null,
"OptionType": {
"Id": 33,
"Url": "https://integrationsdemo.eploy.net/api/options/custom/33",
"Description": "Test Option Type",
"Type": "custom"
}
},
{
"Id": "148",
"Description": "Test2",
"Reference": "2",
"ArchiveDate": null,
"ParentId": null,
"OptionType": {
"Id": 33,
"Url": "https://integrationsdemo.eploy.net/api/options/custom/33",
"Description": "Test Option Type",
"Type": "custom"
}
}
],
"QuestionId": 330,
"Title": "Input - Checkboxes",
"AnswerType": "One to Many",
"QuestionType": {
"ID": 10,
"Description": "Input - Checkboxes"
}
}

{"QuestionId":330,"Answer":[147,148]}

QuestionType ID:

4

Input - Date

Date fields allow the user to type or select a date from a calendar in Eploy. 

In the API, all Dates are returned in ISO-8601 UTC format.

{
"Answer": "2024-05-01T00:00:00Z",
"QuestionId": 331,
"Title": "Input - Date",
"AnswerType": "Date",
"QuestionType": {
"ID": 4,
"Description": "Input - Date"
}
}

{"QuestionId":331,"Answer":"2024-05-01T00:00:00Z"}

QuestionType ID:

2

Input - Number

Number fields allow positive or negative whole number answers to be provided. The API returns this as an integer.

{
"Answer": 100,
"QuestionId": 332,
"Title": "Input - Number",
"AnswerType": "Number",
"QuestionType": {
"ID": 2,
"Description": "Input - Number"
}
}

{"QuestionId":325,"Answer":"Test"}

Input - Decimal

Decimal fields allow positive or negative numeric answers with up to 4 decimal places. The API returns this as an integer.

{
"Answer": 99.99000,
"QuestionId": 333,
"Title": "Input - Decimal",
"AnswerType": "Decimal",
"QuestionType": {
"ID": 21,
"Description": "Input - Decimal"
}
}

{"QuestionId":333,"Answer":99.99}

QuestionType ID:

3

Input - Yes/No

Yes/No fields allow a 'Yes' or 'No' answer, which is returned a boolean (true or false) in the API.

{
"Answer": true,
"QuestionId": 334,
"Title": "Input - Yes/No",
"AnswerType": "Boolean",
"QuestionType": {
"ID": 3,
"Description": "Input - Yes / No"
}
}

{"QuestionId":334,"Answer":true}

Input - Linear Scale (1 to 5)

Linear Scale fields allow a selection of values from 1 to 5 which are returned in the API as an integer value.

{
"Answer": 2,
"QuestionId": 335,
"Title": "Input - Linear Scale (1 to 5)",
"AnswerType": "Level (1 to 5)",
"QuestionType": {
"ID": 14,
"Description": "Input - Linear Scale (1 to 5)"
}
}

{"QuestionId":335,"Answer":2}