TravelNurseSource API v2.0
Jobs
The jobs resource is used to manage job data from TravelNurseSource.
The job object
The job object represents a job posting for your account.
Attributes
string
Can be any combination of letters and numbers. Must be unique for each job.
This number is used to identify if our website already has a copy of this job. If it exists, we will update the existing job with any new information provided. If not, the job will be added as a new job.
string
The title of your job posting.
string
The city where your job posting is located.
string
The state where your job posting is located.
string
The ZIP code where your job posting is located.
enum
What type of license a nurse applying to your job post needs to have. We use this to appropriately categorize your job.
Possible enum values:CNA
LPN / LVN
RN
enum
What specialty most accurately describes your job post. We use this to appropriately categorize your job.
If you have used our Specialty Mapping Tool, you may use any mapped term in addition to the ones on the left.
Possible enum values:Admin/Mgmt
Antepartum
CVICU
CVOR
Case Manager
Cath Lab
Coronary Care
Diabetes
Dialysis
ER/Trauma
Endoscopy
Flight Nurse
Gastroenterology
Home Health
Hospice
ICU/Critical Care
IMC
Interventional Radiology
LTAC
Labor/Delivery
Long-Term Care
Med/Surg
NICU
Neonatal
Neuro
OB/GYN
OR
Occupational
Oncology
Orthopedics
Other
PACU/Pre-Post Op
PCU
PICU
Pain Management
Pediatrics
Postpartum
Psych
RNFA
Radiology
Rehab
Stepdown
Telemetry
Wound/Ostomy
enum
The type of shifts the employee is expected to work.
Possible enum values:day
evening
overnight
flex
integer
The number of shifts per week the employee is expected to work. Values from 3 - 6
integer
The number of hours per shift the employee is expected to work. Values from 6 - 16
decimal
The minimum pay provided by the Client for this Job. This is the bottom end of the pay range.
decimal
The maximum pay provided by the Client for this Job. This is the top end of the pay range.
enum
The frequency at which a Client pays the Employee for this Job.
Possible enum values:Hourly
Weekly
list<enum>
The type(s) of employment applicable for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values.
Possible enum values:Full-Time
Part-Time
Temporary
Permanent
integer
The numeric length part of the contract duration (e.g. the "13" in "13 weeks").
enum
The unit part of the contract duration (e.g. the "weeks" in "13 weeks").
Possible enum values:day
week
month
year
date
The date your position starts. If left blank, or a date in the past, the start date will automatically be set to ASAP.
string
The description of your job posting. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>
string
The minimum requirements a lead applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>
string
The benefits offered by this position. Basic HTML tags are allowed.
Example
{
"id": 10,
"title": "Job Title",
"license": "CNA",
"specialty": "Rehab",
"city": "Lancaster",
"state": "PA",
"zip": "17603",
"shiftType": "flex",
"shiftsPerWeek": 3,
"hoursPerShift": 12,
"payAmountMin": "2430.00",
"payAmountMax": "2970.00",
"payFrequency": "Weekly",
"durationLength": 40,
"durationUnit": "week",
"startDate": "2024-03-28",
"description": "Job Description",
"requirements": "Job Requirements",
"benefits": "Text describing the benefits for the position",
"posted": "2024-03-28",
"referenceNumber": "dz43udYy",
"employmentType": "Part-Time"
}
<?xml version="1.0"?>
<jobs>
<job>
<id>10</id>
<title>Job Title</title>
<license>CNA</license>
<specialty>Rehab</specialty>
<city>Lancaster</city>
<state>PA</state>
<zip>17603</zip>
<shiftType>flex</shiftType>
<shiftsPerWeek>3</shiftsPerWeek>
<hoursPerShift>12</hoursPerShift>
<payAmountMin>2430.00</payAmountMin>
<payAmountMax>2970.00</payAmountMax>
<payFrequency>Weekly</payFrequency>
<durationLength>40</durationLength>
<durationUnit>week</durationUnit>
<startDate>2024-03-28</startDate>
<description>Job Description</description>
<requirements>Job Requirements</requirements>
<benefits>Text describing the benefits for the position</benefits>
<posted>2024-03-28</posted>
<referenceNumber>dz43udYy</referenceNumber>
<employmentType>Part-Time</employmentType>
</job>
</jobs>
List all jobs
URL Parameters
No parameters.
Query Parameters
No parameters.
Example Request
Example Response
[
{
"id": 8,
"title": "Job Title",
"license": "CNA",
"specialty": "Psych",
"city": "Lancaster",
"state": "PA",
"zip": "17603",
"shiftType": "flex",
"shiftsPerWeek": 3,
"hoursPerShift": 12,
"payAmountMin": "2430.00",
"payAmountMax": "2970.00",
"payFrequency": "Weekly",
"durationLength": 40,
"durationUnit": "week",
"startDate": "2024-03-28",
"description": "Job Description",
"requirements": "Job Requirements",
"benefits": "Text describing the benefits for the position",
"posted": "2024-03-28",
"referenceNumber": "dz43udYy",
"employmentType": "Full-Time"
},
{
"id": 4,
"title": "Job Title",
"license": "CNA",
"specialty": "Psych",
"city": "Lancaster",
"state": "PA",
"zip": "17603",
"shiftType": "flex",
"shiftsPerWeek": 3,
"hoursPerShift": 12,
"payAmountMin": "2430.00",
"payAmountMax": "2970.00",
"payFrequency": "Weekly",
"durationLength": 40,
"durationUnit": "week",
"startDate": "2024-03-28",
"description": "Job Description",
"requirements": "Job Requirements",
"benefits": "Text describing the benefits for the position",
"posted": "2024-03-28",
"referenceNumber": "dz43udYy",
"employmentType": "Full-Time"
}
]
<?xml version="1.0"?>
<jobs>
<job>
<id>1</id>
<title>Job Title</title>
<license>RN</license>
<specialty>Radiology</specialty>
<city>Lancaster</city>
<state>PA</state>
<zip>17603</zip>
<shiftType>flex</shiftType>
<shiftsPerWeek>3</shiftsPerWeek>
<hoursPerShift>12</hoursPerShift>
<payAmountMin>2430.00</payAmountMin>
<payAmountMax>2970.00</payAmountMax>
<payFrequency>Weekly</payFrequency>
<durationLength>40</durationLength>
<durationUnit>week</durationUnit>
<startDate>2024-03-28</startDate>
<description>Job Description</description>
<requirements>Job Requirements</requirements>
<benefits>Text describing the benefits for the position</benefits>
<posted>2024-03-28</posted>
<referenceNumber>dz43udYy</referenceNumber>
<employmentType>Full-Time</employmentType>
</job>
<job>
<id>7</id>
<title>Job Title</title>
<license>LPN</license>
<specialty>Psych</specialty>
<city>Lancaster</city>
<state>PA</state>
<zip>17603</zip>
<shiftType>flex</shiftType>
<shiftsPerWeek>3</shiftsPerWeek>
<hoursPerShift>12</hoursPerShift>
<payAmountMin>2430.00</payAmountMin>
<payAmountMax>2970.00</payAmountMax>
<payFrequency>Weekly</payFrequency>
<durationLength>40</durationLength>
<durationUnit>week</durationUnit>
<startDate>2024-03-28</startDate>
<description>Job Description</description>
<requirements>Job Requirements</requirements>
<benefits>Text describing the benefits for the position</benefits>
<posted>2024-03-28</posted>
<referenceNumber>dz43udYy</referenceNumber>
<employmentType>Full-Time</employmentType>
</job>
</jobs>
Post job(s)
Parameters
The maximum data payload size for requests to this endpoint is 1,000.
The maximum active jobs allowed is 10,000. Any additional jobs will be ignored.
Field | Format/Values | Required | Description |
---|---|---|---|
referenceNumber |
Alphanumeric |
Yes | Can be any combination of letters and numbers. Must be unique for each job. This number is used to identify if our website already has a copy of this job. If it exists, we will update the existing job with any new information provided. If not, the job will be added as a new job. |
title |
String |
Yes | The title of your job posting. |
city |
String |
No | The city where your job posting is located. |
state |
USPS 2-letter abbreviation |
Yes | The state where your job posting is located. |
postalCode |
USPS 5-digit or 9-digit ZIP code |
No | The ZIP code where your job posting is located. |
license |
String One of the following allowed values:
|
Yes | What type of license a nurse applying to your job post needs to have. We use this to appropriately categorize your job. |
specialty |
String One of the following allowed values:
|
Yes | What specialty most accurately describes your job post. We use this to appropriately categorize your job. If you have used our Specialty Mapping Tool, you may use any mapped term in addition to the ones on the left. |
shiftType |
String One of the following allowed values:
|
No | The type of shifts the employee is expected to work. |
shiftsPerWeek |
Integer |
No | The number of shifts per week the employee is expected to work. Values from 3 - 6 |
hoursPerShift |
Integer |
No | The number of hours per shift the employee is expected to work. Values from 6 - 16 |
payAmountMin |
Decimal |
No | The minimum pay provided by the Client for this Job. This is the bottom end of the pay range. |
payAmountMax |
Decimal |
No | The maximum pay provided by the Client for this Job. This is the top end of the pay range. |
payFrequency |
String One of the following allowed values:
|
No | The frequency at which a Client pays the Employee for this Job. |
employmentType |
Enum One of the following allowed values:
|
No | The type(s) of employment applicable for this job. You can include more than one value from the list of allowed values. See sample feed above for List format example when including multiple values. |
durationLength |
Integer |
No | The numeric length part of the contract duration (e.g. the "13" in "13 weeks"). |
durationUnit |
String One of the following allowed values:
|
No | The unit part of the contract duration (e.g. the "weeks" in "13 weeks"). |
startDate |
Date |
No | The date your position starts. If left blank, or a date in the past, the start date will automatically be set to ASAP. |
description |
String |
Yes | The description of your job posting. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]> |
requirements |
String |
No | The minimum requirements a lead applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]> |
benefits |
String |
No | The benefits offered by this position. Basic HTML tags are allowed. |
Example Request
[
{
"referenceNumber": "u9FE7VIZ",
"title": "Job Title",
"city": "Lancaster",
"state": "PA",
"postalCode": "17603",
"description": "Text or HTML describing this job",
"requirements": "Text or HTML describing the requirements for this job",
"license": "RN",
"specialty": "Radiology",
"shiftType": "flex",
"shiftsPerWeek": 3,
"hoursPerShift": 12,
"payAmountMin": "2430.00",
"payAmountMax": "2970.00",
"payFrequency": "Weekly",
"employmentType": [
"Full-Time",
"Permanent"
],
"durationLength": 13,
"durationUnit": "week",
"startDate": "2024-03-28",
"benefits": "Text or HTML describing the benefits for this job"
}
]
<?xml version="1.0"?>
<jobs>
<job>
<referenceNumber>u9FE7VIZ</referenceNumber>
<title>Job Title</title>
<city>Lancaster</city>
<state>PA</state>
<postalCode>17603</postalCode>
<description>Text or HTML describing this job</description>
<requirements>Text or HTML describing the requirements for this job</requirements>
<license>RN</license>
<specialty>Radiology</specialty>
<shiftType>flex</shiftType>
<shiftsPerWeek>3</shiftsPerWeek>
<hoursPerShift>12</hoursPerShift>
<payAmountMin>2430.00</payAmountMin>
<payAmountMax>2970.00</payAmountMax>
<payFrequency>Weekly</payFrequency>
<employmentType>Full-Time</employmentType>
<employmentType>Permanent</employmentType>
<durationLength>13</durationLength>
<durationUnit>week</durationUnit>
<startDate>2024-03-28</startDate>
<benefits>Text or HTML describing the benefits for this job</benefits>
</job>
</jobs>
Example Response
{
"unchanged": 0,
"updated": 0,
"added": 1,
"deleted": 0,
"errors": 0,
"errorMessages": {
"missingErrors": {
"errors": []
},
"invalidErrors": {
"errors": []
},
"duplicationErrors": {
"errors": []
},
"limitErrors": {
"errors": []
}
},
"ignoredValues": []
}
<?xml version="1.0"?>
<jobs>
<unchanged>0</unchanged>
<updated>0</updated>
<added>1</added>
<deleted>0</deleted>
<errors>0</errors>
<errorMessages>
<missingErrors>
<errors/>
</missingErrors>
<invalidErrors>
<errors/>
</invalidErrors>
<duplicationErrors>
<errors/>
</duplicationErrors>
<limitErrors>
<errors/>
</limitErrors>
</errorMessages>
<ignoredValues/>
</jobs>
Retrieve a job
URL Parameters
REQUIRED
integer
The ID number of the job you want to fetch.
Query Parameters
No parameters.
Example Request
Example Response
{
"id": 6,
"title": "Job Title",
"license": "LPN",
"specialty": "Rehab",
"city": "Lancaster",
"state": "PA",
"zip": "17603",
"shiftType": "flex",
"shiftsPerWeek": 3,
"hoursPerShift": 12,
"payAmountMin": "2430.00",
"payAmountMax": "2970.00",
"payFrequency": "Weekly",
"durationLength": 40,
"durationUnit": "week",
"startDate": "2024-03-28",
"description": "Job Description",
"requirements": "Job Requirements",
"benefits": "Text describing the benefits for the position",
"posted": "2024-03-28",
"referenceNumber": "dz43udYy",
"employmentType": "Full-Time"
}
<?xml version="1.0"?>
<jobs>
<job>
<id>3</id>
<title>Job Title</title>
<license>RN</license>
<specialty>Radiology</specialty>
<city>Lancaster</city>
<state>PA</state>
<zip>17603</zip>
<shiftType>flex</shiftType>
<shiftsPerWeek>3</shiftsPerWeek>
<hoursPerShift>12</hoursPerShift>
<payAmountMin>2430.00</payAmountMin>
<payAmountMax>2970.00</payAmountMax>
<payFrequency>Weekly</payFrequency>
<durationLength>40</durationLength>
<durationUnit>week</durationUnit>
<startDate>2024-03-28</startDate>
<description>Job Description</description>
<requirements>Job Requirements</requirements>
<benefits>Text describing the benefits for the position</benefits>
<posted>2024-03-28</posted>
<referenceNumber>dz43udYy</referenceNumber>
<employmentType>Full-Time</employmentType>
</job>
</jobs>
Delete a job
URL Parameters
REQUIRED
integer
The ID number of the job you want to delete.
Example Request
Example Response
{
"unchanged": 0,
"updated": 0,
"added": 0,
"deleted": 1,
"errors": 0,
"errorMessages": {
"missingErrors": {
"errors": []
},
"invalidErrors": {
"errors": []
},
"duplicationErrors": {
"errors": []
},
"limitErrors": {
"errors": []
}
}
}
<?xml version="1.0"?>
<jobs>
<unchanged>0</unchanged>
<updated>0</updated>
<added>0</added>
<deleted>1</deleted>
<errors>0</errors>
<errorMessages>
<missingErrors>
<errors/>
</missingErrors>
<invalidErrors>
<errors/>
</invalidErrors>
<duplicationErrors>
<errors/>
</duplicationErrors>
<limitErrors>
<errors/>
</limitErrors>
</errorMessages>
</jobs>
Delete multiple jobs
Example Request
[
12345,
123456
]
<?xml version="1.0"?>
<jobs>
<job>12345</job>
<job>123456</job>
</jobs>
Example Response
{
"unchanged": 0,
"updated": 0,
"added": 0,
"deleted": 2,
"errors": 0,
"errorMessages": {
"missingErrors": {
"errors": []
},
"invalidErrors": {
"errors": []
},
"duplicationErrors": {
"errors": []
},
"limitErrors": {
"errors": []
}
}
}
<?xml version="1.0"?>
<jobs>
<unchanged>0</unchanged>
<updated>0</updated>
<added>0</added>
<deleted>2</deleted>
<errors>0</errors>
<errorMessages>
<missingErrors>
<errors/>
</missingErrors>
<invalidErrors>
<errors/>
</invalidErrors>
<duplicationErrors>
<errors/>
</duplicationErrors>
<limitErrors>
<errors/>
</limitErrors>
</errorMessages>
</jobs>
Delete a job by reference
URL Parameters
REQUIRED
string
The reference number of the job you want to delete.
Example Request
Example Response
{
"unchanged": 0,
"updated": 0,
"added": 0,
"deleted": 1,
"errors": 0,
"errorMessages": {
"missingErrors": {
"errors": []
},
"invalidErrors": {
"errors": []
},
"duplicationErrors": {
"errors": []
},
"limitErrors": {
"errors": []
}
}
}
<?xml version="1.0"?>
<jobs>
<unchanged>0</unchanged>
<updated>0</updated>
<added>0</added>
<deleted>1</deleted>
<errors>0</errors>
<errorMessages>
<missingErrors>
<errors/>
</missingErrors>
<invalidErrors>
<errors/>
</invalidErrors>
<duplicationErrors>
<errors/>
</duplicationErrors>
<limitErrors>
<errors/>
</limitErrors>
</errorMessages>
</jobs>
Delete multiple jobs by reference
Example Request
[
"12345",
"123456"
]
<?xml version="1.0"?>
<jobs>
<job>12345</job>
<job>123456</job>
</jobs>
Example Response
{
"unchanged": 0,
"updated": 0,
"added": 0,
"deleted": 2,
"errors": 0,
"errorMessages": {
"missingErrors": {
"errors": []
},
"invalidErrors": {
"errors": []
},
"duplicationErrors": {
"errors": []
},
"limitErrors": {
"errors": []
}
}
}
<?xml version="1.0"?>
<jobs>
<unchanged>0</unchanged>
<updated>0</updated>
<added>0</added>
<deleted>2</deleted>
<errors>0</errors>
<errorMessages>
<missingErrors>
<errors/>
</missingErrors>
<invalidErrors>
<errors/>
</invalidErrors>
<duplicationErrors>
<errors/>
</duplicationErrors>
<limitErrors>
<errors/>
</limitErrors>
</errorMessages>
</jobs>