Job_requests
A request for Wonoloers to perform a Job
A Job Request represents a Requestor’s desire for Wonoloers to perform a Job. e.g. “I need 12 people at noon tomorrow to stack boxes.”
States¶ ↑
Job Requests progress through a series of states. Generally speaking, the state of a Job Request is determined by the states of the Jobs attached to it. The possible Job Request states are:
-
draft
the Job Request has not yet been posted and may be incomplete. -
unassigned
the Job Request has not yet been posted so is not visible to Wonoloers. However, any Preferred Wonoloers are notified during this time, if specified. -
posted
the Job Request is acceptable by any qualified Wonoloer. During this time, qualified Wonoloers will be ranked and notified. -
filled
all of the Job Request’s slots are filled. -
in_progress
the Job Request start time has passed and at least one Wonoloer has started working. -
completed
all Wonoloers have completed work for this Job Request (i.e. all Jobs attached to this Job Request have a state ofcompleted
). -
approved
all Jobs attached to this Job Request are approved. -
cancelled
the Job Request is cancelled. All Jobs attached to this Job Request will also be cancelled. -
unfilled
the Job Request start time has passed but none of the slots was filled.
Supported Formats
json
GET /api_v2/job_requests
List JobRequests
Returns a list of Job Requests, optionally paginated. Note: the maximum number returned per page in any case is 50.
Supported Formats
jsonErrors
Code | Description |
---|---|
401 | Unauthorized |
Examples
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/job_requests
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/job_requests?page=10&per=25
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
page
optional |
The page number to start from Validations:
|
per
optional |
The size of the page Validations:
|
state
optional |
Filter Job Requests by state Validations:
|
company_id
optional |
Filter Job Requests by Company ID Validations:
|
multi_day_job_request_id
optional |
Filter Job Requests by the Multi-Day Job Request they relate to Validations:
|
classification
optional |
Filter Job Requests by their tax classification Validations:
|
w2_hourly_rate
optional |
Filter Job Requests by their W2 hourly rate Validations:
|
updated_before
optional |
Filter Job Requests by those that were last updated before provided DateTime Validations:
|
updated_after
optional |
Filter Job Requests by those that were last updated after provided DateTime Validations:
|
POST /api_v2/job_requests
Create a JobRequest
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
job_request
required |
A Job Request Validations:
|
job_request[state]
required |
The Job Request’s status. See the Job Request resource documentation for details. Validations:
|
job_request[category]
required |
The category of the work to be performed, e.g. ‘Customer Service’. Must be one of the pre-defined values defined for the API user’s Company. Validations:
|
job_request[description]
required |
A detailed description of the work to be performed. Required unless Validations:
|
job_request[description_tasks]
required |
A detailed description of the work to be performed. Required unless Validations:
|
job_request[description_company]
optional |
A description of the company making this Job Request. Validations:
|
job_request[description_travel]
optional |
Travel tips for the Wonoloer in performing this Job Request. Validations:
|
job_request[description_skills]
optional |
Skills required to satisfy this Job Request. Multiple skills should be separated with the pipe character +|+ Validations:
|
job_request[description_contact]
optional |
Who the Wonoloer should contact for any questions related to this Job Request. Validations:
|
job_request[description_arrival]
optional |
Any arrival instructions for the Wonoloer. Validations:
|
job_request[slots]
required |
The number of Wonoloers required. Validations:
|
job_request[start_time]
optional |
The time to start work in 24-hour format. Example: 2018-08-18 19:30 Validations:
|
job_request[duration]
optional |
The expected length of the Job in MINUTES. Validations:
|
job_request[venue_name]
optional |
The name of the work location, e.g. ‘Best Buy Store 321’ Validations:
|
job_request[address]
required |
The street address of the work location, e.g. ‘123 Fremont St’ Validations:
|
job_request[city]
required |
The city of the work location Validations:
|
job_request[zip]
required |
The zip of the work location Validations:
|
job_request[employer_id]
optional |
The ID of the Requestor (Employer) requesting the work Validations:
|
job_request[wage]
optional |
The wage to be paid. Validations:
|
job_request[request_name]
required |
A Requestor-visible name for this Job Request (not visible to Wonoloer) Validations:
|
job_request[preferred_candidate_ids]
optional |
An array of Wonoloer IDs that are Preferred for this Job Request. Preferred Wonoloers are notified first and have a chance to accept before other ranked Wonoloers are notified. Validations:
|
job_request[open_request]
optional |
True if this Job Request should open up to any eligible Wonoloer once all Preferred Wonoloers have been notified and a configurable time has passed Validations:
|
job_request[multi_day]
optional |
True if this Job Request is part of a multi-day Job Request Validations:
|
job_request[multi_day_job_request_id]
optional |
The id of the multi-day Job Request if multi-day Validations:
|
job_request[badge_requirements_attributes]
optional |
Any Badges that are required to accept this Job Request Validations:
|
job_request[badge_requirements_attributes][badge_id]
required |
The ID of the Badge that is required Validations:
|
job_request[notification_distance]
optional |
The maximum distance in MILES for notifications for this Job Request. Wonoloers whose current location is more than this distance from the Job Request location will not be notified. Overrides any default setting at the Customer level or Company level. Validations:
|
job_request[classification]
optional |
The Job Request’s tax classification. Default is 1099. Validations:
|
job_request[w2_hourly_rate]
optional |
The hourly rate for W2 job requests — required with W2 classification Validations:
|
job_request[push_all_notifications_asap]
optional |
Send all push notifications asap - use ‘on’ to set, ‘off’ to unset Validations:
|
job_request[use_pending_state]
optional |
Enable Pending Workflow for this Job Request Validations:
|
PATCH /api_v2/job_requests/:id
Update a JobRequest
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
id
required |
ID of the Job Request Validations:
|
state
optional |
Use ‘cancelled’ if you want cancel a job request. Validations:
|
job_request
required |
A Job Request Validations:
|
job_request[state]
required |
The Job Request’s status. See the Job Request resource documentation for details. Validations:
|
job_request[category]
required |
The category of the work to be performed, e.g. ‘Customer Service’. Must be one of the pre-defined values defined for the API user’s Company. Validations:
|
job_request[description]
required |
A detailed description of the work to be performed. Required unless Validations:
|
job_request[description_tasks]
required |
A detailed description of the work to be performed. Required unless Validations:
|
job_request[description_company]
optional |
A description of the company making this Job Request. Validations:
|
job_request[description_travel]
optional |
Travel tips for the Wonoloer in performing this Job Request. Validations:
|
job_request[description_skills]
optional |
Skills required to satisfy this Job Request. Multiple skills should be separated with the pipe character +|+ Validations:
|
job_request[description_contact]
optional |
Who the Wonoloer should contact for any questions related to this Job Request. Validations:
|
job_request[description_arrival]
optional |
Any arrival instructions for the Wonoloer. Validations:
|
job_request[slots]
required |
The number of Wonoloers required. Validations:
|
job_request[start_time]
optional |
The time to start work in 24-hour format. Example: 2018-08-18 19:30 Validations:
|
job_request[duration]
optional |
The expected length of the Job in MINUTES. Validations:
|
job_request[venue_name]
optional |
The name of the work location, e.g. ‘Best Buy Store 321’ Validations:
|
job_request[address]
required |
The street address of the work location, e.g. ‘123 Fremont St’ Validations:
|
job_request[city]
required |
The city of the work location Validations:
|
job_request[zip]
required |
The zip of the work location Validations:
|
job_request[employer_id]
optional |
The ID of the Requestor (Employer) requesting the work Validations:
|
job_request[wage]
optional |
The wage to be paid. Validations:
|
job_request[request_name]
required |
A Requestor-visible name for this Job Request (not visible to Wonoloer) Validations:
|
job_request[preferred_candidate_ids]
optional |
An array of Wonoloer IDs that are Preferred for this Job Request. Preferred Wonoloers are notified first and have a chance to accept before other ranked Wonoloers are notified. Validations:
|
job_request[open_request]
optional |
True if this Job Request should open up to any eligible Wonoloer once all Preferred Wonoloers have been notified and a configurable time has passed Validations:
|
job_request[multi_day]
optional |
True if this Job Request is part of a multi-day Job Request Validations:
|
job_request[multi_day_job_request_id]
optional |
The id of the multi-day Job Request if multi-day Validations:
|
job_request[badge_requirements_attributes]
optional |
Any Badges that are required to accept this Job Request Validations:
|
job_request[badge_requirements_attributes][badge_id]
required |
The ID of the Badge that is required Validations:
|
job_request[notification_distance]
optional |
The maximum distance in MILES for notifications for this Job Request. Wonoloers whose current location is more than this distance from the Job Request location will not be notified. Overrides any default setting at the Customer level or Company level. Validations:
|
job_request[classification]
optional |
The Job Request’s tax classification. Default is 1099. Validations:
|
job_request[w2_hourly_rate]
optional |
The hourly rate for W2 job requests — required with W2 classification Validations:
|
job_request[push_all_notifications_asap]
optional |
Send all push notifications asap - use ‘on’ to set, ‘off’ to unset Validations:
|
GET /api_v2/job_requests/:id
Get a specific JobRequest
Supported Formats
jsonParams
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
id
required |
ID of Job Request Validations:
|
GET /api_v2/job_requests/:id/rankings
List the Wonoloers that are ranked for this JobRequest
Returns details of the Wonoloers that were ranked for this JobRequest, in ranked order.
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
id
required |
ID of Job Request Validations:
|
POST /api_v2/job_requests/:id/resend_notifications
Resend notifications for this JobRequest
If the JobRequest has Preferred Wonoloers, Preferred Notifications will first be resent to those Preferred Wonoloers who have not already accepted the JobRequest.
If the JobRequest does not have Preferred Wonoloers, the available Wonoloer pool will be re-ranked and Wonoloers notified in resulting ranked order.
NB: in both cases, the Wonoloers notified will not necessarily be - and are unlikely to be - exactly the same list as the prior time notifications were sent.
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
id
required |
ID of Job Request Validations:
|
push_all_notifications_asap
optional |
Send all push notifications asap - use ‘on’ to set, ‘off’ to unset Validations:
|
POST /api_v2/job_requests/:id/re_rank_workers
Re-rank workers for this JobRequest
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
id
required |
ID of Job Request Validations:
|