Skip to content
API Documentation

Questionnaire

A list of questions needed to be answer before job submission.

The get job questionnaire endpoint lets you list all the questions needed to be answer for the job to be submitted to the pool of Tax Pros. Also, a question will contain the answer if previously provided using the Questionnaire Answers endpoint.

Endpoints

MethodUrl
GET/v1.0/jobs/{job_id}/questionnaire
PUT/v1.0/jobs/{job_id}/questionnaire/answers

Url Parameters

job_id
•
guid

The job's ID.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/jobs/{job_id}/questionnaire' \
2-H 'Authorization: Bearer {token}'

Response

ready_to_submit
•
boolean

To signal whether or not enough answers have been provided for any question in the questionnaire for the job to be submitted to the pool of Tax Pros.

questions
•
array of questions

The list of required questions you'll need to answer before submitting a job. Questions can be of the following types, which require information to be sent in a certain format:

Question Properties

id
•
string
The question's ID.
question
•
string
The question's text.
description
•
string
The question's description.
type
•
enum

The question's type. One of:

  • BOOL
  • NUMERIC
  • TEXT
  • DATE_TIME
  • SINGLE_SELECT
  • MULTI_SELECT

Types Properties

BOOL Type

answer
•
boolean
A boolean; either true or false.

NUMERIC Type

answer
•
number
A number; e.g 23.

TEXT Type

answer
•
string
A string; e.g. "Hello world".

DATE_TIME Type

answer
•
string
A string of a timestamp; e.g "2022-11-04T04:00:00.000Z".
disallow_future
•
bool
Hints that this datetime should be in the future.
disallow_past
•
bool
Hints that this datetime should be the past.

SINGLE_SELECT and MULTI_SELECT Types

options
•
array of options

The list of options to pick from.

option
•
object

The option object.

id
•
string
The option's id.
text
•
string
The option's text.
Copied
1{
2    "ready_to_submit": false,
3    "questions": [
4        {
5            "answer": null,
6            "type": "BOOL",
7            "id": "QUESTION1",
8            "question": "New Yes/No Question",
9            "description": ""
10        },
11        {
12            "answer": 10,
13            "type": "NUMERIC",
14            "id": "QUESTION2",
15            "question": "New Decimal Numeric Question",
16            "description": "Decimal"
17        },
18        {
19            "answer": "Some text",
20            "type": "TEXT",
21            "id": "QUESTION3",
22            "question": "New Text Question",
23            "description": ""
24        },
25        {
26            "disallow_future": true,
27            "disallow_past": false,
28            "answer": "1998-11-04T04:00:00Z",
29            "type": "DATE_TIME",
30            "id": "QUESTION4",
31            "question": "New Date Question",
32            "description": "Birthday"
33        },
34        {
35            "options": [
36                {
37                    "id": "OPTION_1",
38                    "text": "Option 1"
39                },
40                {
41                    "id": "OPTION_2",
42                    "text": "Option 2"
43                }
44            ],
45            "answer": "OPTION_1",
46            "type": "SINGLE_SELECT",
47            "id": "QUESTION5",
48            "question": "Single Select Question",
49            "description": "Single"
50        },
51        {
52            "options": [
53                {
54                    "id": "OPTION_1",
55                    "text": "Option 1"
56                },
57                {
58                    "id": "OPTION_2",
59                    "text": "Option 2"
60                }
61            ],
62            "answer": ["OPTION_1", "OPTION_2"],
63            "type": "MULTI_SELECT",
64            "id": "QUESTION6",
65            "question": "Multi Select Question",
66            "description": "Multi"
67        }
68    ]
69}

Next steps

Last updated on October 11, 2023
Privacy PolicyTerms & Conditions© 2024 Taxfyle