Documentation :: LocumJobsOnline.com

LocumJobsOnline API v2.0

Jobs Data

The jobs endpoint is used to fetch job data from LocumJobsOnline.

Fetch All Jobs

GET https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml

Sample Request

To get all jobs:

GET https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml

Sample Response

[
    {
        "id": 1,
        "title": "Job Title",
        "license": "MD",
        "specialty": "Administration",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Flex",
        "payrate": "$5,234",
        "positiontype": "Full time",
        "startdate": "2022-06-29",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-06-29",
        "referencenumber": "L6z9Cr31",
        "employmentType": "Full-Time"
    },
    {
        "id": 8,
        "title": "Job Title",
        "license": "MD",
        "specialty": "Nephrology",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Flex",
        "payrate": "$5,234",
        "positiontype": "Full time",
        "startdate": "2022-06-29",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-06-29",
        "referencenumber": "L6z9Cr31",
        "employmentType": "Full-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <id>1</id>
    <title>Job Title</title>
    <license>MD</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Flex</shift>
    <payrate>$5,234</payrate>
    <positiontype>Full time</positiontype>
    <startdate>2022-06-29</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-06-29</posted>
    <referencenumber>L6z9Cr31</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
  <job>
    <id>8</id>
    <title>Job Title</title>
    <license>MD</license>
    <specialty>Nephrology</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Flex</shift>
    <payrate>$5,234</payrate>
    <positiontype>Full time</positiontype>
    <startdate>2022-06-29</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-06-29</posted>
    <referencenumber>L6z9Cr31</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Fetch a Single Job

GET https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/{id}

Parameters

Parameter should be appended to the endpoint URL.

Field Format/Values Required Description
id Integer Yes The ID number of the job you want to fetch.

Sample Request

GET https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/12345

Sample Response

{
    "id": 10,
    "title": "Job Title",
    "license": "DO",
    "specialty": "Administration",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "Flex",
    "payrate": "$5,234",
    "positiontype": "Full time",
    "startdate": "2022-06-29",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2022-06-29",
    "referencenumber": "L6z9Cr31",
    "employmentType": "Full-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>10</id>
    <title>Job Title</title>
    <license>DO</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Flex</shift>
    <payrate>$5,234</payrate>
    <positiontype>Full time</positiontype>
    <startdate>2022-06-29</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-06-29</posted>
    <referencenumber>L6z9Cr31</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Post Job(s)

POST https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml

Parameters

Parameter should be appended to the endpoint URL.

The maximum data payload size for requests to this endpoint is 1000.

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 ZIP code

No

The zip code where your job posting is located.

license

String

One of the following allowed values:

  • CRNA
  • DO
  • MD
  • NP
  • PA
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:

  • Addiction Medicine
  • Administration
  • Allergy and Immunology
  • Anesthesiology
  • Cardiac Electrophysiology
  • Cardiology
  • Cardiothoracic Surgery
  • Cardiovascular Disease
  • Child and Adolescent Psychiatry
  • Colorectal Surgery
  • Critical Care
  • Dermatology
  • Dermatopathology
  • Emergency Medicine
  • Endocrinology
  • Family Practice
  • Gastroenterology
  • General Practice
  • General Surgery
  • Genetics
  • Geriatrics
  • Hematology and Oncology
  • Hospitalist
  • Infectious Disease
  • Internal Medicine
  • Interventional Radiology
  • Maternal-Fetal Medicine
  • Neonatal
  • Nephrology
  • Neurology
  • Neurosurgery
  • Nurse Practitioner
  • Obstetrics and Gynecology
  • Occupational Medicine
  • Oncology
  • Ophthalmology
  • Orthopedic Surgery
  • Osteopathic
  • Other
  • Otolaryngology
  • Palliative Medicine
  • Pathology
  • Pediatric Surgery
  • Pediatrics
  • Perinatology
  • Physical Medicine
  • Psychiatry
  • Psychology
  • Pulmonology
  • Radiation Oncology
  • Radiology
  • Rheumatology
  • Transplant Surgery
  • Trauma Surgery
  • Urgent Care
  • Urology
  • Vascular Surgery
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 The shift for this job posting.
payRate

String

No The estimated per hour/day/week/month/year pay rate for each job posting. Please enter just the number, such as $1,000.
employmentType

List

Any combination of the following allowed values:

  • Full-Time
  • Part-Time
  • Locum Tenens
  • Permanent
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.

One of Locum Tenens or Permanent is required.

positionType

String

No What type of position this is.
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.
requirements

String

No The minimum requirements a lead applying to your job posting must meet. Basic HTML tags are allowed.
benefits

String

No The benefits offered by this position. Basic HTML tags are allowed.

Sample Request

POST https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml
[
    {
        "title": "Job Title",
        "license": "DO",
        "specialty": "Nephrology",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Flex",
        "payrate": "$5,234",
        "positiontype": "Full time",
        "startdate": "2022-06-29",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-06-29",
        "referencenumber": "L6z9Cr31",
        "employmentType": "Part-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <title>Job Title</title>
    <license>DO</license>
    <specialty>Nephrology</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Flex</shift>
    <payrate>$5,234</payrate>
    <positiontype>Full time</positiontype>
    <startdate>2022-06-29</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-06-29</posted>
    <referencenumber>L6z9Cr31</referencenumber>
    <employmentType>Part-Time</employmentType>
  </job>
</jobs>

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 1,
    "deleted": 0,
    "errors": 0,
    "errorMessages": {
        "missingErrors": {
            "errors": []
        },
        "invalidErrors": {
            "errors": []
        },
        "duplicationErrors": {
            "errors": []
        },
        "limitErrors": {
            "errors": []
        }
    }
}
<?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>
</jobs>

Delete a Single Job

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/{id}

Parameters

Parameter should be appended to the endpoint URL.

Field Format/Values Required Description
id Integer Yes The ID number of the job you want to delete.

Sample Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/12345

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": []
}
<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>1</deleted>
  <errors>0</errors>
  <errorMessages/>
</jobs>

Delete Multiple Jobs

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml

Parameters

Parameter should be appended to the endpoint URL.

Field Format/Values Required Description
id Integer Yes The ID number of the job you want to delete.

Sample Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml
[
    12345,
    123456
]
<?xml version="1.0"?>
<jobs>
  <job>12345</job>
  <job>123456</job>
</jobs>

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": []
}
<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>2</deleted>
  <errors>0</errors>
  <errorMessages/>
</jobs>

Delete One Job By Reference

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/reference/{referenceNumber}

Parameters

Parameter should be appended to the endpoint URL.

Field Format/Values Required Description
referenceNumber String Yes The reference number of the job you want to delete.

Sample Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/reference/12345

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 1,
    "errors": 0,
    "errorMessages": []
}
<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>1</deleted>
  <errors>0</errors>
  <errorMessages/>
</jobs>

Delete Multiple Jobs By Reference

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/reference

Parameters

Parameter should be appended to the endpoint URL.

Field Format/Values Required Description
id String Yes The reference number of the job you want to delete.

Sample Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.jsonxml/reference
[
    "12345",
    "123456"
]
<?xml version="1.0"?>
<jobs>
  <job>12345</job>
  <job>123456</job>
</jobs>

Sample Response

{
    "unchanged": 0,
    "updated": 0,
    "added": 0,
    "deleted": 2,
    "errors": 0,
    "errorMessages": []
}
<?xml version="1.0"?>
<jobs>
  <unchanged>0</unchanged>
  <updated>0</updated>
  <added>0</added>
  <deleted>2</deleted>
  <errors>0</errors>
  <errorMessages/>
</jobs>