LocumJobsOnline API v2.0

Jobs

JSON XML

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

referenceNumber


            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.

title


            string

The title of your job posting.

city


            string

The city where your job posting is located.

state


            string

The state where your job posting is located.

postalCode


            string

The ZIP code where your job posting is located.

license


            enum

What type of license a provider applying to your job post needs to have. We use this to appropriately categorize your job.

Medical License Types

Only specialties from the medical specialties list may be used in combination with medical license types

Possible enum values:

MD
DO
PA
NP
CRNA
DPM
OD
CAA

Dental License Types

Only specialties from the dental specialties list may be used in combination with dental license types

Possible enum values:

DMD
DDS

specialty


            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.

Medical Specialties

Only license types from the medical license type list may be used in combination with medical specialties

Possible enum values:

Addiction Medicine
Administration
Adolescent Medicine
Allergy and Immunology
Anesthesiology - Cardiac
Anesthesiology - Critical Care
Anesthesiology
Anesthesiology - Neuro
Anesthesiology - OB
Cardio - Advanced Heart Failure / Transplant
Cardiac Electrophysiology
Cardiology
Cardio - Interventional
Cardiovascular Disease
Critical Care
Dermatology
Dermatopathology
Emergency Medicine
Endocrinology
Epilepsy
Family Practice
Gastroenterology

General Practice
Genetics
Geriatrics
Hematology and Oncology
Hepatology
Hospitalist
Hyperbaric
Infectious Disease
Internal Medicine - Critical Care
Internal Medicine
Maternal-Fetal Medicine
Neonatal
Nephrology
Neurology
Neuro - Interventional
Neuro - Neurocritical Care
Neuro - Peds
Neuro - Stroke
Nuclear Medicine
Nurse Practitioner
Obstetrics and Gynecology
Occupational Medicine

Oncology
Onc - Gyn
Radiation Oncology
Onc - Surgical
Ophthalmology
Optometry
Optometry - Geriatric
Optometry - Low Vision / Vision Rehab
Optometry - Ocular Disease / Medical
Optometry - Peds
Osteopathic
Other
Otolaryngology
Pain Med
Palliative Medicine
Pathology
Peds - Anesthesiology
Peds - Critical Care
Pediatrics
Peds - Hem/Onc
Perinatology
Physical Medicine

Podiatry - Diabetic Foot Care
Podiatry
Podiatry - Sports Med
Podiatry - Surgery
Podiatry - Wound Care / Limb Salvage
Preventive Med
Psych - Addiction
Child and Adolescent Psychiatry
Psych - Forensic
Psychiatry
Psych - Geriatric
Psychology
Pulmonary Critical Care
Pulmonology
Rad - Diagnostic
Radiology
Interventional Radiology
Rad - Musculoskeletal
Rad - Neuroradiology
Rad - Nuclear
Rad - Peds
Rad - Teleradiology

Rad - Womens/Breast/Mammo
REI
Rheumatology
Sleep Med
Sports Med
Surgery - Bariatric
Surgery - Breast/Cancer
Cardiothoracic Surgery
Colorectal Surgery
General Surgery
Surgery - Hand
Neurosurgery
Orthopedic Surgery
Pediatric Surgery
Surgery - Plastic
Surgery - Thoracic
Transplant Surgery
Trauma Surgery
Vascular Surgery
Telemedicine
Urgent Care
Urogyn

Urology
Women's Health
Wound, Burn & Ostomy

Dental Specialties

Only license types from the dental license type list may be used in combination with dental specialties

Possible enum values:

Cosmetic Dentistry
Endodontics
Family Practice - Dentistry
General Dentistry
Oral and Maxillofacial Surgery
Orthodontics
Pediatric Dentistry
Periodontics
Prosthodontics

shift


            string

Map a client’s shift field to this field if the full shift info is stored in one field

shiftType


            enum

The type of shifts the employee is expected to work.

Possible enum values:

days
nights
evenings
rotating

shiftsPerWeek


            integer

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

hoursPerShift


            integer

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

payAmountMin


            decimal

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

payAmountMax


            decimal

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

payFrequency


            enum

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

Possible enum values:

Hourly
Daily
Weekly
Monthly
Yearly

employmentType


            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:

Locum Tenens
Permanent

durationLength


            integer

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

durationUnit


            enum

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

Possible enum values:

day
week
month
year

startDate


            date

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

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

requirements


            string

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

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

Example

{
    "id": 3,
    "title": "Job Title",
    "license": "PA",
    "specialty": "Administration",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "Day",
    "shiftType": "days",
    "shiftsPerWeek": 3,
    "hoursPerShift": 12,
    "payAmountMin": "737.00",
    "payAmountMax": "913.00",
    "payFrequency": "Hourly",
    "durationLength": 26,
    "durationUnit": "week",
    "startdate": "2025-12-06",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2025-12-06",
    "referenceNumber": "cqSiiwsf",
    "employmentType": "Locum Tenens"
}

<?xml version="1.0"?>
<jobs>
  <job>
    <id>3</id>
    <title>Job Title</title>
    <license>PA</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Day</shift>
    <shiftType>days</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>26</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2025-12-06</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2025-12-06</posted>
    <referenceNumber>cqSiiwsf</referenceNumber>
    <employmentType>Locum Tenens</employmentType>
  </job>
</jobs>

List all jobs

GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml

URL Parameters

No parameters.

Query Parameters

No parameters.

Example Request

GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml

Example Response

[
    {
        "id": 5,
        "title": "Job Title",
        "license": "MD",
        "specialty": "Nephrology",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Day",
        "shiftType": "days",
        "shiftsPerWeek": 3,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "durationLength": 26,
        "durationUnit": "week",
        "startdate": "2025-12-06",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2025-12-06",
        "referenceNumber": "cqSiiwsf",
        "employmentType": "Locum Tenens"
    },
    {
        "id": 6,
        "title": "Job Title",
        "license": "MD",
        "specialty": "Administration",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Day",
        "shiftType": "days",
        "shiftsPerWeek": 3,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "durationLength": 26,
        "durationUnit": "week",
        "startdate": "2025-12-06",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2025-12-06",
        "referenceNumber": "cqSiiwsf",
        "employmentType": "Locum Tenens"
    }
]

<?xml version="1.0"?>
<jobs>
  <job>
    <id>6</id>
    <title>Job Title</title>
    <license>PA</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Day</shift>
    <shiftType>days</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>26</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2025-12-06</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2025-12-06</posted>
    <referenceNumber>cqSiiwsf</referenceNumber>
    <employmentType>Permanent</employmentType>
  </job>
  <job>
    <id>6</id>
    <title>Job Title</title>
    <license>MD</license>
    <specialty>Administration</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Day</shift>
    <shiftType>days</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>26</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2025-12-06</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2025-12-06</posted>
    <referenceNumber>cqSiiwsf</referenceNumber>
    <employmentType>Locum Tenens</employmentType>
  </job>
</jobs>

Post job(s)

POST https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json POST https://qa-sit.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.

This endpoint allows a maximum of 1 request per hour. Although single job postings are supported, it is intended that you post all jobs that you need to update on the site at one time (up to the maximum of 1,000 jobs), not one job at a time. If you need to post more than 1,000 jobs, you will need to spread this out over multiple requests, or alternatively, consider using the dedicated job import endpoint or configuring a job feed.

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 Types Only specialties from the medical specialties list may be used in combination with medical license types Possible enum values: `MD` `DO` `PA` `NP` `CRNA` `DPM` `OD` `CAA` Dental License Types Only specialties from the dental specialties list may be used in combination with dental license types Possible enum values: `DMD` `DDS`	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 Specialties Only license types from the medical license type list may be used in combination with medical specialties Possible enum values: `Addiction Medicine` `Administration` `Adolescent Medicine` `Allergy and Immunology` `Anesthesiology - Cardiac` `Anesthesiology - Critical Care` `Anesthesiology` `Anesthesiology - Neuro` `Anesthesiology - OB` `Cardio - Advanced Heart Failure / Transplant` `Cardiac Electrophysiology` `Cardiology` `Cardio - Interventional` `Cardiovascular Disease` `Critical Care` `Dermatology` `Dermatopathology` `Emergency Medicine` `Endocrinology` `Epilepsy` `Family Practice` `Gastroenterology` `General Practice` `Genetics` `Geriatrics` `Hematology and Oncology` `Hepatology` `Hospitalist` `Hyperbaric` `Infectious Disease` `Internal Medicine - Critical Care` `Internal Medicine` `Maternal-Fetal Medicine` `Neonatal` `Nephrology` `Neurology` `Neuro - Interventional` `Neuro - Neurocritical Care` `Neuro - Peds` `Neuro - Stroke` `Nuclear Medicine` `Nurse Practitioner` `Obstetrics and Gynecology` `Occupational Medicine` `Oncology` `Onc - Gyn` `Radiation Oncology` `Onc - Surgical` `Ophthalmology` `Optometry` `Optometry - Geriatric` `Optometry - Low Vision / Vision Rehab` `Optometry - Ocular Disease / Medical` `Optometry - Peds` `Osteopathic` `Other` `Otolaryngology` `Pain Med` `Palliative Medicine` `Pathology` `Peds - Anesthesiology` `Peds - Critical Care` `Pediatrics` `Peds - Hem/Onc` `Perinatology` `Physical Medicine` `Podiatry - Diabetic Foot Care` `Podiatry` `Podiatry - Sports Med` `Podiatry - Surgery` `Podiatry - Wound Care / Limb Salvage` `Preventive Med` `Psych - Addiction` `Child and Adolescent Psychiatry` `Psych - Forensic` `Psychiatry` `Psych - Geriatric` `Psychology` `Pulmonary Critical Care` `Pulmonology` `Rad - Diagnostic` `Radiology` `Interventional Radiology` `Rad - Musculoskeletal` `Rad - Neuroradiology` `Rad - Nuclear` `Rad - Peds` `Rad - Teleradiology` `Rad - Womens/Breast/Mammo` `REI` `Rheumatology` `Sleep Med` `Sports Med` `Surgery - Bariatric` `Surgery - Breast/Cancer` `Cardiothoracic Surgery` `Colorectal Surgery` `General Surgery` `Surgery - Hand` `Neurosurgery` `Orthopedic Surgery` `Pediatric Surgery` `Surgery - Plastic` `Surgery - Thoracic` `Transplant Surgery` `Trauma Surgery` `Vascular Surgery` `Telemedicine` `Urgent Care` `Urogyn` `Urology` `Women's Health` `Wound, Burn & Ostomy` Dental Specialties Only license types from the dental license type list may be used in combination with dental specialties Possible enum values: `Cosmetic Dentistry` `Endodontics` `Family Practice - Dentistry` `General Dentistry` `Oral and Maxillofacial Surgery` `Orthodontics` `Pediatric Dentistry` `Periodontics` `Prosthodontics`	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: days nights evenings rotating	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: 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.
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://qa-sit.locumjobsonline.com/api/v2.0/jobs.json POST https://qa-sit.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": "evenings",
        "shiftsPerWeek": 4,
        "hoursPerShift": 12,
        "payAmountMin": "737.00",
        "payAmountMax": "913.00",
        "payFrequency": "Hourly",
        "employmentType": [
            "Locum Tenens",
            "Permanent"
        ],
        "durationLength": 13,
        "durationUnit": "week",
        "startDate": "2025-12-06",
        "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>nights</shiftType>
    <shiftsPerWeek>4</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <employmentType>Locum Tenens</employmentType>
    <employmentType>Permanent</employmentType>
    <durationLength>13</durationLength>
    <durationUnit>week</durationUnit>
    <startDate>2025-12-06</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://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/:id GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml/:id

URL Parameters


                            REQUIRED


            integer

The ID number of the job you want to fetch.

Query Parameters

No parameters.

Example Request

GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/2 GET https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml/6

Example Response

{
    "id": 2,
    "title": "Job Title",
    "license": "DO",
    "specialty": "Administration",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "Day",
    "shiftType": "days",
    "shiftsPerWeek": 3,
    "hoursPerShift": 12,
    "payAmountMin": "737.00",
    "payAmountMax": "913.00",
    "payFrequency": "Hourly",
    "durationLength": 26,
    "durationUnit": "week",
    "startdate": "2025-12-06",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2025-12-06",
    "referenceNumber": "cqSiiwsf",
    "employmentType": "Locum Tenens"
}

<?xml version="1.0"?>
<jobs>
  <job>
    <id>6</id>
    <title>Job Title</title>
    <license>DO</license>
    <specialty>Nephrology</specialty>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Day</shift>
    <shiftType>days</shiftType>
    <shiftsPerWeek>3</shiftsPerWeek>
    <hoursPerShift>12</hoursPerShift>
    <payAmountMin>737.00</payAmountMin>
    <payAmountMax>913.00</payAmountMax>
    <payFrequency>Hourly</payFrequency>
    <durationLength>26</durationLength>
    <durationUnit>week</durationUnit>
    <startdate>2025-12-06</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2025-12-06</posted>
    <referenceNumber>cqSiiwsf</referenceNumber>
    <employmentType>Locum Tenens</employmentType>
  </job>
</jobs>

Delete a job

DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/:id DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml/:id

URL Parameters


                            REQUIRED


            integer

The ID number of the job you want to delete.

Example Request

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

Example Request

DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml

<?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://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/reference/:referenceNumber DELETE https://qa-sit.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://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/reference/12345 DELETE https://qa-sit.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://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/reference DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.xml/reference

Example Request

DELETE https://qa-sit.locumjobsonline.com/api/v2.0/jobs.json/reference DELETE https://qa-sit.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>