These are the endpoints that are available under the /job and /jobRequisition paths, which allows you to view or modify the jobs and job requisitions on your business' account.
Endpoint | Description |
---|---|
GET /job | Returns all job objects on an account in array format. |
GET /job/tags | Returns all tags for a job in array format. |
POST /job | Creates a new job object on your business' account. Request body/payload: Must pass a job object in the request body/payload. For these calls, you need to pass a job object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a job object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
PUT /job | Updates an existing job object on your business' account - object must include jobId property fill in with the jobRequisitionId value of the job object you want to update. Request body/payload: Must pass a job object in the request body/payload. For these calls, you need to pass a job object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a job object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
DELETE /job/{jobId} | Removes specified job object from view by setting its active property to false. |
GET /jobRequisition | Returns all jobRequisition objects on an account in array format. |
GET /jobRequisition/job/{jobId} | Returns a JSON object for specified job requisition. |
GET /jobRequisition/requisitionNumber/{requisitionNumber} | Returns an active jobRequisition object on account that matches the requisitionNumber passed in URL - can be used to make sure that no duplicate jobRequisition numbers are added to your account. |
POST /jobRequisition | Creates a new jobRequisition object on your business' account. Request body/payload: Must pass a jobRequisition object in the request body/payload. For these calls, you need to pass a jobRequisition object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a jobRequisition object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
PUT /jobRequisition | Updates an existing jobRequisition object on your business' account. Request body/payload: Must pass a jobRequisition object in the request body/payload. For these calls, you need to pass a jobRequisition object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a jobRequisition object in the responses section below and have indicated the required fields in the object values table at the bottom of this page |
DELETE /jobRequisition/{jobRequisitionId} | Removes specified jobRequisition object from view by setting its active property to false. |
There are no parameters associated with schedulerPreference calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a job or jobRequisition object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "jobRequisitions": [{ "active": true, "businessId": 43111, "duplicate": false, "duplicateJobTitle": "", "duplicateReqId": 140994, "requisitionNumber": "7", "status": "OPEN" }], "jobTitle": "Crab Fiddler", "tags": null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338540650, "createdUser": "JoeSchmo", "expanded": true, "jobId": 57804, "jobRequisitions": [{ "active": true, "businessId": 43111, "duplicate": false, "duplicateJobTitle": "", "requisitionNumber": "3", "status": "OPEN" }], "jobTitle": "Cat Wrangler", "jobTitleTranslationCode": "tag.job.req_jobtitle.57804", "modifiedDate": 1548186839575, "modifiedUser": "JoeSchmo", "tags": null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "duplicate": false, "duplicateJobTitle": "", "job": { "active": true, "businessId": 43111, "createdDate": 1550091322769, "createdUser": "JoeSchmo", "jobId": 67044, "jobTitle": "Certified Fox Trainer", "modifiedDate": null, "modifiedUser": null, "tags": null }, "requisitionNumber": "7", "status": "OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338540740, "createdUser": "JoeSchmo", "department": null, "division": null, "editing": true, "employmentDurationType": null, "employmentTermType": null, "job": { "active": true, "businessId": 43111, "createdDate": 1543338540650, "createdUser": "JoeSchmo", "jobId": 57804, "jobTitle": "Cat Wrangler", "modifiedDate": 1550092503196, "modifiedUser": "JoeSchmo", "tags": null }, "jobRequisitionId": 62883, "locationName": null, "managerName": null, "modifiedDate": 1550092503242, "modifiedUser": "JoeSchmo", "originalNumber": "1", "requisitionNumber": "12", "saving": true, "status": "OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "active": true, "businessId": 43111, "createdDate": 1540478732320, "createdUser": "JoeSchmo", "jobId": 50049, "jobTitle": "Dog Trainer", "modifiedDate": 1542316658941, "modifiedUser": "JoeSchmo", "tags": [ "0": "dogs", "1": "trainers" ]}] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[ "0": "dogs", "1": "trainers" ] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338015786, "createdUser": "JoeSchmo", "jobId": 57771, "jobTitle": "Cat Groomer", "modifiedDate": null, "modifiedUser": null, "tags": null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338015786, "createdUser": "JoeSchmo", "jobId": 57771, "jobTitle": "Cat Groomer", "modifiedDate": 1543344683572, "modifiedUser": "JoeSchmo", "tags": [] } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "active": true, "businessId": 43111, "createdDate": 1540478732435, "createdUser": "JoeSchmo", "department": null, "division": null, "employmentDurationType": null, "employmentTermType": null, "job": { "active": true, "businessId": 43111, "createdDate": 1540478732320, "createdUser": "JoeSchmo", "jobId": 50049, "jobTitle": "Dog Trainer", "modifiedDate": 1542316658941, "modifiedUser": "MORGANKEARNEY", "tags": [ "0": "dogs", "1": "trainers" ]}], "jobRequisitionId": 54607, "locationName": null, "managerName": null, "modifiedDate": 1542316659018, "modifiedUser": "JoeSchmo", "requisitionNumber": "12", "status": "OPEN" }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "active": true, "businessId": 43111, "createdDate": 1543338540740, "createdUser": "JoeSchmo", "department": null, "division": null, "employmentDurationType": null, "employmentTermType": null, "job": { "active": true, "businessId": 43111, "createdDate": 1543338540650, "createdUser": "JoeSchmo", "jobId": 57969, "jobTitle": "Dog Comber", "modifiedDate": null, "modifiedUser": null, "tags": null }, "jobRequisitionId": 63048, "locationName": null, "managerName": null, "modifiedDate": 1543338638797, "modifiedUser": "JoeSchmo", "requisitionNumber": "2", "status:" "OPEN" }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338540740, "createdUser": "JoeSchmo", "department": null, "division": null, "employmentDurationType": null, "employmentTermType": null, "job": { "active": true, "businessId": 43111, "createdDate": 1543338540650, "createdUser": "JoeSchmo", "jobId": 57804, "jobTitle": "Cat Wrangler", "modifiedDate": null, "modifiedUser": null, "tags": null }, "jobRequisitionId": 62883, "locationName": null, "managerName": null, "modifiedDate": null, "modifiedUser": null, "requisitionNumber": "6", "status": "OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 1543338016070, "createdUser": "JoeSchmo", "department": null, "division": null, "employmentDurationType": null, "employmentTermType": null, "job": { "active": true, "businessId": 43111, "createdDate": 1543338015786, "createdUser": "JoeSchmo", "jobId": 57804, "jobTitle": "Cat Wrangler", "modifiedDate": null, "modifiedUser": null, "tags": null }, "jobRequisitionId": 62883, "locationName": null, "managerName": null, "modifiedDate": null, "modifiedUser": null, "requisitionNumber": "3", "status": "OPEN" } |
job
Property name | Type | Required | Description |
---|---|---|---|
active | boolean | Yes | Indicates whether or not the specified job should return on GET calls. |
businessId | integer | Yes | Provides unique numeric ID for the business to which specified job belongs. |
createdDate | integer | Displays as the date the specified job was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
createdUser | string | Displays the username of user who created the specified job. | |
jobId | integer | Yes, on PUT calls | Provides unique numeric ID for the specified job. |
jobTitle | string | Yes | Displays as the title of the specified job. |
modifiedDate | integer | Displays as the date the specified job was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
modifiedUser | string | Displays the username of user who last modified the specified job. | |
tags | array | Displays as an array of string tags provided for the specified job. |
jobRequisition
Name | Type | Required | Description |
---|---|---|---|
active | boolean | Yes | Indicates whether or not the specified job requisition should return on GET calls. |
businessId | integer | Yes | Provides unique numeric ID for the business to which the specified job belongs. |
createdDate | integer | Displays as the date the specified job requisition was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
createdUser | string | Displays the username of user who created the specified job requisition. | |
department | string | Not set up yet - displays as what is set as the department for the specified job requisition. | |
division | string | Not set up yet - displays as what is set as the division for the specified job requisition. | |
employmentDurationType | string | Not set up yet - displays as the duration type of employment for the specified job requisition. | |
employmentTermType | string | Not set up yet - displays as the term type of employment for the specified job requisition. | |
job | object | Displays the job object for job of the specified job requisition. | |
jobRequisitionId | integer | Yes, on PUT calls | Provides unique numeric ID for specified job requisition. |
locationName | string | Not set up yet - displays as what is set as the location name for specified job requisition. | |
managerName | strings | Not set up yet - displays as what is set as the manager name for specified job requisition. | |
modifiedDate | integer | Displays as the date specified job requisition was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
modifiedUser | string | Displays the username of user who last modified specified job requisition. | |
requisitionNumber | string | Yes | Displays as the requisition number given to specified job requisition. |
status | string | Yes | Displays as the status of specified job requisition. Has acceptable values "OPEN", |