Documentation :: LocumJobsOnline.com

LocumJobsOnline API v2.0

Jobs

The jobs resource is used to manage job data from LocumJobsOnline.

The job object

The job object represents a job posting for your account.

Attributes


referenceNumberstring

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.


titlestring

The title of your job posting.


citystring

The city where your job posting is located.


statestring

The state where your job posting is located.


postalCodestring

The ZIP code where your job posting is located.


licenseenum

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


specialtyenum

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:
  • 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


shiftTypeenum

The type of shifts the employee is expected to work.

Possible enum values:
  • day
  • evening
  • overnight
  • flex


shiftsPerWeekinteger

The number of shifts per week the employee is expected to work. Values from 3 - 6


hoursPerShiftinteger

The number of hours per shift the employee is expected to work. Values from 6 - 16


payAmountMindecimal

The minimum pay provided by the Client for this Job. This is the bottom end of the pay range.


payAmountMaxdecimal

The maximum pay provided by the Client for this Job. This is the top end of the pay range.


payFrequencyenum

The frequency at which a Client pays the Employee for this Job.

Possible enum values:
  • Hourly
  • Daily
  • Weekly
  • Monthly
  • Yearly


employmentTypelist<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.

One of Locum Tenens or Permanent is required.

Possible enum values:
  • Full-Time
  • Part-Time
  • Locum Tenens
  • Permanent


durationLengthinteger

The numeric length part of the contract duration (e.g. the "13" in "13 weeks").


durationUnitenum

The unit part of the contract duration (e.g. the "weeks" in "13 weeks").

Possible enum values:
  • day
  • week
  • month
  • year


startDatedate

The date your position starts. If left blank, or a date in the past, the start date will automatically be set to ASAP.


descriptionstring

The description of your job posting. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>


requirementsstring

The minimum requirements a lead applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>


benefitsstring

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


Example

{
    "id": 8,
    "title": "Job Title",
    "license": "DO",
    "specialty": "Administration",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shiftType": "day",
    "shiftsPerWeek": 3,
    "hoursPerShift": 12,
    "payAmountMin": "737.00",
    "payAmountMax": "913.00",
    "payFrequency": "Hourly",
    "durationLength": 7,
    "durationUnit": "week",
    "startdate": "2024-03-02",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2024-03-02",
    "referencenumber": "FK3vnDV0",
    "employmentType": "Full-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>8</id>
    <title>Job Title</title>
    <license>DO</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shiftType>day</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>7</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2024-03-02</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2024-03-02</posted>
    <referencenumber>FK3vnDV0</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

List all jobs

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

URL Parameters


No parameters.

Query Parameters


No parameters.

Example Request

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

Example Response

[
    {
        "id": 6,
        "title": "Job Title",
        "license": "MD",
        "specialty": "Administration",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shiftType": "day",
        "shiftsPerWeek": 3,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "durationLength": 7,
        "durationUnit": "week",
        "startdate": "2024-03-02",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2024-03-02",
        "referencenumber": "FK3vnDV0",
        "employmentType": "Full-Time"
    },
    {
        "id": 2,
        "title": "Job Title",
        "license": "DO",
        "specialty": "Administration",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shiftType": "day",
        "shiftsPerWeek": 3,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "durationLength": 7,
        "durationUnit": "week",
        "startdate": "2024-03-02",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2024-03-02",
        "referencenumber": "FK3vnDV0",
        "employmentType": "Part-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <id>7</id>
    <title>Job Title</title>
    <license>PA</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shiftType>day</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>7</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2024-03-02</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2024-03-02</posted>
    <referencenumber>FK3vnDV0</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
  <job>
    <id>3</id>
    <title>Job Title</title>
    <license>PA</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shiftType>day</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>7</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2024-03-02</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2024-03-02</posted>
    <referencenumber>FK3vnDV0</referencenumber>
    <employmentType>Part-Time</employmentType>
  </job>
</jobs>

Post job(s)

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

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:

  • 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.

shiftType

String

One of the following allowed values:

  • day
  • evening
  • overnight
  • flex
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:

  • Hourly
  • Daily
  • Weekly
  • Monthly
  • Yearly
No

The frequency at which a Client pays the Employee for this Job.

employmentType

Enum

One 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.

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:

  • day
  • week
  • month
  • year
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

POST https://www.locumjobsonline.com/api/v2.0/jobs.json POST https://www.locumjobsonline.com/api/v2.0/jobs.xml
[
    {
        "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": "MD",
        "specialty": "Critical Care",
        "shiftType": "evening",
        "shiftsPerWeek": 4,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "employmentType": [
            "Part-Time",
            "Locum Tenens"
        ],
        "durationLength": 13,
        "durationUnit": "week",
        "startDate": "2024-03-02",
        "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>MD</license>
    <specialty>Critical Care</specialty>
    <shiftType>evening</shiftType>
    <shiftsPerWeek>4</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <employmentType>Part-Time</employmentType>
    <employmentType>Locum Tenens</employmentType>
    <durationLength>13</durationLength>
    <durationUnit>week</durationUnit>
    <startDate>2024-03-02</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

GET https://www.locumjobsonline.com/api/v2.0/jobs.json/:id GET https://www.locumjobsonline.com/api/v2.0/jobs.xml/:id

URL Parameters


id REQUIRED integer

The ID number of the job you want to fetch.


Query Parameters


No parameters.

Example Request

GET https://www.locumjobsonline.com/api/v2.0/jobs.json/8 GET https://www.locumjobsonline.com/api/v2.0/jobs.xml/10

Example Response

{
    "id": 8,
    "title": "Job Title",
    "license": "MD",
    "specialty": "Administration",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shiftType": "day",
    "shiftsPerWeek": 3,
    "hoursPerShift": 12,
    "payAmountMin": "737.00",
    "payAmountMax": "913.00",
    "payFrequency": "Hourly",
    "durationLength": 7,
    "durationUnit": "week",
    "startdate": "2024-03-02",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2024-03-02",
    "referencenumber": "FK3vnDV0",
    "employmentType": "Part-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>10</id>
    <title>Job Title</title>
    <license>MD</license>
    <specialty>Nephrology</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shiftType>day</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>7</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2024-03-02</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2024-03-02</posted>
    <referencenumber>FK3vnDV0</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Delete a job

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.json/:id DELETE https://www.locumjobsonline.com/api/v2.0/jobs.xml/:id

URL Parameters


id REQUIRED integer

The ID number of the job you want to delete.


Example Request

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

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

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

Example Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.json DELETE https://www.locumjobsonline.com/api/v2.0/jobs.xml
[
    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

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.json/reference/:referenceNumber DELETE https://www.locumjobsonline.com/api/v2.0/jobs.xml/reference/:referenceNumber

URL Parameters


referenceNumber REQUIRED string

The reference number of the job you want to delete.


Example Request

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

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

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

Example Request

DELETE https://www.locumjobsonline.com/api/v2.0/jobs.json/reference DELETE https://www.locumjobsonline.com/api/v2.0/jobs.xml/reference
[
    "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>