- API v2.0
- Job Feed
- Webhooks
Job Feed
LocumJobsOnline can import jobs using JSON, XML, CSV, or RSS format. If you create a job feed, all you need to do is enter the publicly accessible URL on the Job Feed page, and we will automatically fetch your feed on a nightly basis (approximately 3:00 AM EST).
Sample Feed
[
{
"referenceNumber": "abcd7961",
"title": "The greatest job ever #6",
"city": "Exampleville",
"state": "PA",
"postalCode": "17601",
"license": "DPM",
"specialty": "Pulmonology",
"shift": "Blanditiis aut autem labore deserunt.",
"shiftType": "nights",
"shiftsPerWeek": 4,
"hoursPerShift": 9,
"payAmountMin": "1000.00",
"payAmountMax": "1300.00",
"payFrequency": "Daily",
"employmentType": "Permanent",
"durationLength": "13",
"durationUnit": "week",
"startDate": "2019-03-19T02:25:47+0000",
"description": "Description here explaining why leads want your awesome job. Basic HTML is allowed too
, just make sure you have properly escaped any \"quotes\".",
"requirements": "Minimum requirements a lead applying to your job must meet go here. Basic HTML is allowed too
, just make sure you have properly escaped any \"quotes\".",
"benefits": "Molestiae at veritatis sit sequi."
},
{
"referenceNumber": "abcd6835",
"title": "The greatest job ever #9",
"city": "Exampleville",
"state": "PA",
"postalCode": "17601",
"license": "DMD",
"specialty": "Occupational Medicine",
"shift": "Fuga nobis assumenda vel architecto quae ratione harum eum.",
"shiftType": "days",
"shiftsPerWeek": 5,
"hoursPerShift": 9,
"payAmountMin": "1000.00",
"payAmountMax": "1300.00",
"payFrequency": "Daily",
"employmentType": "Locum Tenens",
"durationLength": "13",
"durationUnit": "week",
"startDate": "2012-09-27T07:48:17+0000",
"description": "Description here explaining why leads want your awesome job. Basic HTML is allowed too
, just make sure you have properly escaped any \"quotes\".",
"requirements": "Minimum requirements a lead applying to your job must meet go here. Basic HTML is allowed too
, just make sure you have properly escaped any \"quotes\".",
"benefits": "Similique est commodi esse."
}
]
<?xml version="1.0"?>
<source>
<job>
<referenceNumber>abcd7961</referenceNumber>
<title>The greatest job ever #6</title>
<city>Exampleville</city>
<state>PA</state>
<postalCode>17601</postalCode>
<license>DPM</license>
<specialty>Pulmonology</specialty>
<shift>Blanditiis aut autem labore deserunt.</shift>
<shiftType>nights</shiftType>
<shiftsPerWeek>4</shiftsPerWeek>
<hoursPerShift>9</hoursPerShift>
<payAmountMin>1000.00</payAmountMin>
<payAmountMax>1300.00</payAmountMax>
<payFrequency>Daily</payFrequency>
<employmentType>Permanent</employmentType>
<durationLength>13</durationLength>
<durationUnit>week</durationUnit>
<startDate>2019-03-19T02:25:47+0000</startDate>
<description>Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.</description>
<requirements>Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.</requirements>
<benefits>Molestiae at veritatis sit sequi.</benefits>
</job>
<job>
<referenceNumber>abcd6835</referenceNumber>
<title>The greatest job ever #9</title>
<city>Exampleville</city>
<state>PA</state>
<postalCode>17601</postalCode>
<license>DMD</license>
<specialty>Occupational Medicine</specialty>
<shift>Fuga nobis assumenda vel architecto quae ratione harum eum.</shift>
<shiftType>days</shiftType>
<shiftsPerWeek>5</shiftsPerWeek>
<hoursPerShift>9</hoursPerShift>
<payAmountMin>1000.00</payAmountMin>
<payAmountMax>1300.00</payAmountMax>
<payFrequency>Daily</payFrequency>
<employmentType>Locum Tenens</employmentType>
<durationLength>13</durationLength>
<durationUnit>week</durationUnit>
<startDate>2012-09-27T07:48:17+0000</startDate>
<description>Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.</description>
<requirements>Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.</requirements>
<benefits>Similique est commodi esse.</benefits>
</job>
</source>
referenceNumber,title,city,state,postalCode,license,specialty,shift,shiftType,shiftsPerWeek,hoursPerShift,payAmountMin,payAmountMax,payFrequency,employmentType,durationLength,durationUnit,startDate,description,requirements,benefits
abcd7961,"The greatest job ever #6",Exampleville,PA,17601,DPM,Pulmonology,"Blanditiis aut autem labore deserunt.",nights,4,9,1000.00,1300.00,Daily,Permanent,13,week,2019-03-19T02:25:47+0000,"Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any ""quotes""</em>.","Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any ""quotes""</em>.","Molestiae at veritatis sit sequi."
abcd6835,"The greatest job ever #9",Exampleville,PA,17601,DMD,"Occupational Medicine","Fuga nobis assumenda vel architecto quae ratione harum eum.",days,5,9,1000.00,1300.00,Daily,"Locum Tenens",13,week,2012-09-27T07:48:17+0000,"Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any ""quotes""</em>.","Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any ""quotes""</em>.","Similique est commodi esse."
<?xml version="1.0"?>
<rss xmlns:job="https://qa-sit.locumjobsonline.com/api/v2.0/public/jobs/xsd" version="2.0">
<channel>
<title>LocumJobsOnline.com Job Feed</title>
<link>http://qa-sit.locumjobsonline.com</link>
<description>LocumJobsOnline.com Job Feed</description>
<docs>http://www.rssboard.org/rss-specification</docs>
<generator>T5</generator>
<item>
<job:referenceNumber>abcd7961</job:referenceNumber>
<title>The greatest job ever #6</title>
<job:city>Exampleville</job:city>
<job:state>PA</job:state>
<job:postalCode>17601</job:postalCode>
<job:license>DPM</job:license>
<job:specialty>Pulmonology</job:specialty>
<job:shift>Blanditiis aut autem labore deserunt.</job:shift>
<job:shiftType>nights</job:shiftType>
<job:shiftsPerWeek>4</job:shiftsPerWeek>
<job:hoursPerShift>9</job:hoursPerShift>
<job:payAmountMin>1000.00</job:payAmountMin>
<job:payAmountMax>1300.00</job:payAmountMax>
<job:payFrequency>Daily</job:payFrequency>
<job:employmentType>Permanent</job:employmentType>
<job:durationLength>13</job:durationLength>
<job:durationUnit>week</job:durationUnit>
<job:startDate>2019-03-19T02:25:47+0000</job:startDate>
<description><![CDATA[Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.]]></description>
<job:requirements><![CDATA[Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.]]></job:requirements>
<job:benefits><![CDATA[Molestiae at veritatis sit sequi.]]></job:benefits>
</item>
<item>
<job:referenceNumber>abcd6835</job:referenceNumber>
<title>The greatest job ever #9</title>
<job:city>Exampleville</job:city>
<job:state>PA</job:state>
<job:postalCode>17601</job:postalCode>
<job:license>DMD</job:license>
<job:specialty>Occupational Medicine</job:specialty>
<job:shift>Fuga nobis assumenda vel architecto quae ratione harum eum.</job:shift>
<job:shiftType>days</job:shiftType>
<job:shiftsPerWeek>5</job:shiftsPerWeek>
<job:hoursPerShift>9</job:hoursPerShift>
<job:payAmountMin>1000.00</job:payAmountMin>
<job:payAmountMax>1300.00</job:payAmountMax>
<job:payFrequency>Daily</job:payFrequency>
<job:employmentType>Locum Tenens</job:employmentType>
<job:durationLength>13</job:durationLength>
<job:durationUnit>week</job:durationUnit>
<job:startDate>2012-09-27T07:48:17+0000</job:startDate>
<description><![CDATA[Description here explaining why leads want your awesome job. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.]]></description>
<job:requirements><![CDATA[Minimum requirements a lead applying to your job must meet go here. Basic <strong>HTML</strong> is allowed too<br />, <em>just make sure you have properly escaped any "quotes"</em>.]]></job:requirements>
<job:benefits><![CDATA[Similique est commodi esse.]]></job:benefits>
</item>
</channel>
</rss>
Detailed Field Explanation
| 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 Medical License TypesOnly specialties from the medical specialties list may be used in combination with medical license typesPossible enum values:
Dental License TypesOnly specialties from the dental specialties list may be used in combination with dental license typesPossible enum values:
|
Yes | What type of license a provider applying to your job post needs to have. We use this to appropriately categorize your job. |
| specialty |
String Medical SpecialtiesOnly license types from the medical license type list may be used in combination with medical specialtiesPossible enum values:
Dental SpecialtiesOnly license types from the dental license type list may be used in combination with dental specialtiesPossible enum 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. |
| shift |
String |
No | Map a client’s shift field to this field if the full shift info is stored in one field |
| 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:
|
Yes | 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. |
Formatting Guidelines
When providing HTML markup for fields within your jobs, LocumJobsOnline supports the list of elements below.
<![CDATA[ ... ]]>), or entity-encoded.
General
| Tag | Description | Example | How it looks on LocumJobsOnline |
|---|---|---|---|
| b | Bring attention to |
|
This is an example. |
| br | Line break |
|
This is an example. |
| em | Emphasis |
|
This is an example. |
| i | Interesting text |
|
This is an example. |
| p | Paragraph |
|
This is an example. This is an example. |
| span | Span |
|
This is an example. |
| strong | Strong importance |
|
This is an example. |
| u | Unarticulated annotation |
|
This is an example. |
Headings
| Tag | Description | Example | How it looks on LocumJobsOnline |
|---|---|---|---|
| h2 | Heading level 2 |
|
This is an example. |
| h3 | Heading level 3 |
|
This is an example. |
| h4 | Heading level 4 |
|
This is an example. |
| h5 | Heading level 5 |
|
This is an example. |
| h6 | Heading level 6 |
|
This is an example. |
Lists
| Tag | Description | Example | How it looks on LocumJobsOnline |
|---|---|---|---|
| li | List item |
|
|
| ol | Ordered list |
|
|
| ul | Unordered list |
|
|
Tables
| Tag | Description | Example | How it looks on LocumJobsOnline | ||||
|---|---|---|---|---|---|---|---|
| caption | Table caption (or title) |
|
|
||||
| table | Table |
|
|
||||
| tbody | Table body |
|
|
||||
| td | Table data cell |
|
|
||||
| tfoot | Table footer |
|
|
||||
| th | Table header cell |
|
|
||||
| thead | Table head |
|
|
||||
| tr | Table row |
|
|