Create a Job Order

post

https://prod1.serveture.com/public-api/create_job_order/

Submits a job order as an offer and assignment or to garner interest to the WorkN system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

job_id

int32

The internal identifier for the job this order will be associated to. Note: If this is not sent, a "dummy" job will be used as a shell for the order.

end_date

string

required

The last date that the sessions should be created for (the start date will be submitted as part of the attrib_list). The format should be “YYYYMMDD” and it must be in UTC based on the request Start Time. For example, if the user submits a request from the Eastern Time Zone, which is 5 hours behind UTC time, and they pick a start time of 9:00 PM with an end date of 4/25/2024, the end_date sent over should be 4/26/2024, as 9:00 PM 4/25/2024 in Eastern Time is actually 2:00 AM 4/26/2024 UTC).

day_list

array of int32s

required

A list of days of the week that the job order sessions should be created on within the given date range. The values allowed are: 0 for Sunday, 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday.

day_list*

type

int32

required

The request type. Current valid value is 1 for Scheduled at Specific location.

enterprise_id

int32

The identifier for the enterprise for which the job order is being created. If provided, the request will be based on the user's enterprise ID.

ext_customer_id

string

The caller's internally used identifier for a customer (enterprise to WorkN). Note: If provided, it will be used instead of the enterprise_id to lookup in WorkN's system and determine the proper enterprise. This mapping of ext_customer_id to enterprise_id must be done by an Administrator of the Marketplace before the ext_customer_id is used. This value must not exceed 50 characters, all spaces are removed by the system.

bundled

boolean

Defaults to false

An indication of whether this is a Bundled Job Order or Unbundled. By default, jobs are unbundled. A bundled job means that a worker can only accept/be assigned the entire job (all sessions) and not individual sessions.

worker_count

string

The number of workers that are requested for the job offer. This is only applicable for a job with bundled = true.

provider_list

array of int32s

A list of workers that have been chosen by the requester to send the job offer to. This should be a list of provider_ids.

provider_list

worker_assignments

object

A list of dictionaries that will list all workers to be assigned to this job order along with any different start date (sent in attributes), end date, day list, and/or attributes. Only those items that are different should be supplied. Anything not supplied will use the job order base values. In addition, the attribute staff_provider_list will be ignored as an assignment attribute - this parameter is the only way to assign workers to the job order in this endpoint. The dictionary for each assignment should be structured as follows.

Headers

Authorization

string

required

Defaults to Token <place token here>

The authorization token returned from the Log In endpoint.

Responses

200200

400Bad Request

2XX2XX