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.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "active": true, "businessIdjobRequisitions": 43111, [{ "createdDateactive": 1540478732320true, "createdUserbusinessId": "JoeSchmo",43111, "jobIdduplicate": 50049false, "jobTitleduplicateJobTitle": "Dog Trainer", "modifiedDaterequisitionNumber": 1542316658941"7", "modifiedUser": "JoeSchmo", "status": "tagsOPEN": [ }], "0jobTitle": "dogsCertified Fox Trainer", "1tags": "trainers"null ]}] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "0active": "dogs"true, "1businessId": "trainers" ] | ||||||||
Code Block | ||||||||
| ||||||||
{ 43111, "activecreatedDate": true1543338540650, "businessIdcreatedUser": 43111"JoeSchmo", "createdDatejobId": 154333801578657804, "createdUserjobRequisitions": "JoeSchmo",[{ "jobIdactive": 57771true, "jobTitlebusinessId": "Cat Groomer",43111, "modifiedDatecreatedDate": null1543338540740, "modifiedUsercreatedUser": null,"JoeSchmo", "tagsdepartment": null } | ||||||||
Code Block | ||||||||
| ||||||||
{, ""activedivision": truenull, "businessIdemploymentDurationType": 43111null, "createdDateemploymentTermType": 1543338015786null, "createdUserjob": "JoeSchmo", { "jobIdactive": 57771true, "jobTitle": "Cat Groomer", "modifiedDatebusinessId": 154334468357243111, "modifiedUsercreatedDate": "JoeSchmo"1543338540650, "tags": [] } | ||||||||
Code Block | ||||||||
| ||||||||
[{ "activecreatedUser": true,"JoeSchmo", "businessIdjobId": 4311157804, "createdDate": 1540478732435, "createdUserjobTitle": "JoeSchmoCat Wranglers", "department": null, "divisionmodifiedDate": null1548186839575, "employmentDurationType "modifiedUser": null"JoeSchmo", "employmentTermType": null, "jobtags": {null "active": true}, "businessIdjobRequisitionId": 4311162883, "createdDatelocationName": 1540478732320null, "createdUsermanagerName": "JoeSchmo"null, "jobIdmodifiedDate": 500491548186839611, "jobTitlemodifiedUser": "Dog TrainerJoeSchmo", "modifiedDaterequisitionNumber": 1542316658941"1", "modifiedUserstatus": "MORGANKEARNEYOPEN", }, "tagsjobTitle": ["Cat Wrangler", "modifiedDate": 1548186839575, "0modifiedUser": "dogsJoeSchmo", "tags": null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "1active": "trainers"true, ]}]"businessId": 43111, "jobRequisitionIdjob": 54607, { "locationNameactive": nulltrue, "managerNamebusinessId": null43111, "modifiedDatecreatedDate": 15423166590181550091322769, "modifiedUsercreatedUser": "JoeSchmoMORGANKEARNEY", "requisitionNumberjobId": "12",67044, "statusjobTitle": "OPEN" }] | ||||||||
Code Block | ||||||||
| ||||||||
[{Certified Fox Trainer", "activemodifiedDate": truenull, "businessIdmodifiedUser": 43111null, "createdDatetags": 1543338540740null }, "createdUserrequisitionNumber": "JoeSchmo7", "departmentstatus": null,"OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "divisionactive": nulltrue, "employmentDurationTypebusinessId": null43111, "employmentTermTypecreatedDate": null1540478732320, "jobcreatedUser": { "JoeSchmo", "activejobId": true50049, "businessIdjobTitle": "Dog 43111, Trainer", "createdDatemodifiedDate": 15433385406501542316658941, "createdUsermodifiedUser": "JoeSchmo", "jobIdtags": 57969,[ "jobTitle0": "Dog Comberdogs", "modifiedDate1": null, "modifiedUsertrainers": null, "tags": null }, "jobRequisitionId": 63048, "locationName": null, "managerName": null, "modifiedDate": 1543338638797, "modifiedUser": "JoeSchmo", ]}] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[ "requisitionNumber0": "2dogs", "1"status:" "OPENtrainers" }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 15433385407401543338015786, "createdUser": "JoeSchmo", "departmentjobId": null57771, "divisionjobTitle": "Cat nullGroomer", "employmentDurationTypemodifiedDate": null, "employmentTermTypemodifiedUser": null, "jobtags": { null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active": true, "businessId": 43111, "createdDate": 15433385406501543338015786, "createdUser": "JoeSchmo", "jobId": 5780457771, "jobTitle": "Cat WranglerGroomer", "modifiedDate": null1543344683572, "modifiedUser": null"JoeSchmo", "tags": null }, [] } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "jobRequisitionIdactive": 62883true, "locationNamebusinessId": null43111, "managerNamecreatedDate": null1540478732435, "modifiedDatecreatedUser": null, "modifiedUserJoeSchmo": null, "requisitionNumberdepartment": "6"null, "statusdivision": "OPEN" } | ||||||||
Code Block | ||||||||
| ||||||||
{null, "activeemploymentDurationType": truenull, "businessIdemploymentTermType": 43111null, "createdDatejob": 1543338016070, { "createdUseractive": "JoeSchmo",true, "departmentbusinessId": null43111, "divisioncreatedDate": null1540478732320, "employmentDurationTypecreatedUser": null,"JoeSchmo", "employmentTermTypejobId": null, 50049, "jobjobTitle": {"Dog Trainer", "activemodifiedDate": true1542316658941, "businessIdmodifiedUser": 43111"MORGANKEARNEY", "createdDatetags": [ 1543338015786, "createdUser0": "JoeSchmodogs", "jobId1": 57804,"trainers" ]}], "jobTitlejobRequisitionId": 54607, "Cat Wrangler", "locationName": null, "modifiedDatemanagerName": null, "modifiedDate": 1542316659018, "modifiedUser": null"JoeSchmo", "requisitionNumber": "12", "tagsstatus": null },"OPEN" }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "jobRequisitionIdactive": 62883true, "locationNamebusinessId": null43111, "managerNamecreatedDate": null1543338540740, "modifiedDatecreatedUser": null"JoeSchmo", "modifiedUserdepartment": null, "requisitionNumberdivision": "3"null, "statusemploymentDurationType": "OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{null, "activeemploymentTermType": truenull, "jobRequisitionsjob": [{ "active": true, "businessId": 43111, "duplicatecreatedDate": false1543338540650, "duplicateJobTitlecreatedUser": "JoeSchmo", "requisitionNumberjobId": 57969, "jobTitle": "7Dog Comber", "statusmodifiedDate": "OPEN" null, "modifiedUser": null, }], "jobTitle": "Certified Fox Trainer""tags": null }, "tagsjobRequisitionId": null } | ||||||||
Code Block | ||||||||
| ||||||||
{63048, "activelocationName": truenull, "businessIdmanagerName": 43111null, "createdDatemodifiedDate": 15433385406501543338638797, "createdUsermodifiedUser": "JoeSchmo", "jobIdrequisitionNumber": 57804"2", "jobRequisitions": [{ 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 Wranglers" Wrangler", "modifiedDate": null, "modifiedUser": null, "modifiedDatetags": 1548186839575, null }, "jobRequisitionId": 62883, "modifiedUserlocationName": "JoeSchmo"null, "managerName": null, "tagsmodifiedDate": null, "modifiedUser": null, }, "requisitionNumber": "6", "jobRequisitionIdstatus": 62883, "OPEN" } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "locationNameactive": nulltrue, "managerNamebusinessId": null43111, "modifiedDatecreatedDate": 15481868396111543338016070, "modifiedUsercreatedUser": "JoeSchmo", "requisitionNumber": "1", "statusdepartment": "OPEN", }null, "jobTitledivision": "Cat Wrangler"null, "modifiedDateemploymentDurationType": 1548186839575null, "modifiedUseremploymentTermType": "JoeSchmo"null, "tagsjob": { null } | ||||||||
Code Block | ||||||||
| ||||||||
{ "active": true, "businessId": 43111, "jobcreatedDate": {1543338015786, "activecreatedUser": true"JoeSchmo", "businessIdjobId": 4311157804, "createdDatejobTitle": 1550091322769"Cat Wrangler", "createdUsermodifiedDate": "MORGANKEARNEY"null, "jobIdmodifiedUser": 67044null, "jobTitletags": "Certified Fox Trainer",null }, "modifiedDatejobRequisitionId": null62883, "locationName": null, "modifiedUsermanagerName": null, "tagsmodifiedDate": null, "modifiedUser": }null, "requisitionNumber": "73", "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 | 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 | Yes | 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 calls7 | 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", |