Submit Answers for Under Construction Jobs

Submit answers for required service package questions for under-construction jobs.

The submit answers endpoint lets you provide answers to required questions specified by the Service Packages you want to include in the job for your users.

Endpoint

Method	Url
`PUT`	`/v1.0/jobs/{job_id}/answers`

Note

This endpoint follows PUT semantics, meaning you should always send the full set of answers for all service packages as they'll be overridden every time

Request Payload

Service Packages With Answers

•

array

An array of Service Packages With Answers. See below for details

Service Package With Answers

service_package_id

•

string

The ID of a service package.

answers

•

object

An object mapping question IDs to answers as specified in the Service Package required_questions field.

Type	Answer Format
`BOOL`	A boolean; either `true` or `false`
`NUMERIC`	A number; e.g `23`
`TEXT`	A string; e.g. `"Hello world"`
`DATE_TIME`	A string of a timestamp; e.g `"2022-11-04T04:00:00.000Z"`
`SINGLE_SELECT`	The id of one of the `options` exposed in the package; e.g.`"OPTION1"`
`MULTI_SELECT`	An array of ids from the provide `options`; e.g. `[“OPTION1”, "OPTION2"]`

Sample Request

Copied
1curl -X PUT 'https://api.worklayer.com/v1.0/jobs/{job_id}/answers' \
2-H 'Content-Type: application/json' \
3-H 'Accept: application/json' \
4-d '[
5{
6    "service_package_id": "21e42d52-4145-465e-94bd-322c13bbe5fa",
7    "answers": {
8        "QUESTION_1": true,
9        "QUESTION_2": 10,
10        "QUESTION_3": "Hello World",
11        "QUESTION_4": "2022-11-04T04:00:00.000Z",
12        "QUESTION_5": "OPTION1",
13        "QUESTION_6": ["OPTION1", "OPTION2"]
14    }
15},
16{
17    "service_package_id": "82c9366f-a34b-4315-a2a8-d88c3757d289",
18    "answers": {
19        "QUESTION_1": true,
20        "QUESTION_2": "Foo Bar"
21    }
22}
23]'

Response

A job belonging to your workspace. See the job reference page

ready_to_submit

•

boolean

The job returned from this endpoint also includes this property to signal whether or not enough answers have been provided for any service package for the job to be submitted to the pool of Tax Pros.

Note that you can still answer questions for other service packages you might want to include in this job.

Sample Response

Copied
1{
2  "id": "499d692d-67aa-4127-a45c-b9e27f54afad",
3  "short_id": "TWQXJWMABW8",
4  "name": "Name from service package",
5  "description": "Tony Stark | 2021 | 1040",
6  "status": "UNDER_CONSTRUCTION",
7  "create_time": "2021-04-28T13:45:25.781Z",
8  "update_time": "2021-04-28T13:52:27.379Z",
9  "transmit_time": null,
10  "deadline_time": null,
11  "total_amount": 199,
12  "members": [
13    {
14      "role": "CHAMPION",
15      "type": "CLIENT",
16      "user_id": "a4feef24-00da-4340-8b7c-a532e0607fdd",
17      "given_name": "Tony",
18      "family_name": "Stark",
19      "display_name": "Tony Stark"
20    }
21  ],
22  "ready_to_submit": true
23}

Next steps

Submit job

Last updated on November 23, 2022