Documentation :: AlliedTravelCareers.com

AlliedTravelCareers API v2.0

Jobs Data

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

Fetch All Jobs

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

Sample Request

To get all jobs:

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

Sample Response

[
    {
        "id": 8,
        "title": "Job Title",
        "license": "OT",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "KIlLiuwO",
        "payrate": "8XlROboa",
        "positiontype": "QuWpdUK1",
        "duration": "c67M3AdL",
        "startdate": "2021-06-12",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "HjZqYpYy",
        "posted": "2021-06-12",
        "referencenumber": "sozjSQa8",
        "employmentType": "Full-Time"
    },
    {
        "id": 7,
        "title": "Job Title",
        "license": "PT",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "KIlLiuwO",
        "payrate": "8XlROboa",
        "positiontype": "QuWpdUK1",
        "duration": "c67M3AdL",
        "startdate": "2021-06-12",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "HjZqYpYy",
        "posted": "2021-06-12",
        "referencenumber": "sozjSQa8",
        "employmentType": "Part-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <id>8</id>
    <title>Job Title</title>
    <license>OT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>KIlLiuwO</shift>
    <payrate>8XlROboa</payrate>
    <positiontype>QuWpdUK1</positiontype>
    <duration>c67M3AdL</duration>
    <startdate>2021-06-12</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>HjZqYpYy</benefits>
    <posted>2021-06-12</posted>
    <referencenumber>sozjSQa8</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
  <job>
    <id>7</id>
    <title>Job Title</title>
    <license>PT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>KIlLiuwO</shift>
    <payrate>8XlROboa</payrate>
    <positiontype>QuWpdUK1</positiontype>
    <duration>c67M3AdL</duration>
    <startdate>2021-06-12</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>HjZqYpYy</benefits>
    <posted>2021-06-12</posted>
    <referencenumber>sozjSQa8</referencenumber>
    <employmentType>Part-Time</employmentType>
  </job>
</jobs>

Fetch a Single Job

GET https://www.alliedtravelcareers.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.alliedtravelcareers.com/api/v2.0/jobs.jsonxml/12345

Sample Response

{
    "id": 8,
    "title": "Job Title",
    "license": "PTA",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "KIlLiuwO",
    "payrate": "8XlROboa",
    "positiontype": "QuWpdUK1",
    "duration": "c67M3AdL",
    "startdate": "2021-06-12",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "HjZqYpYy",
    "posted": "2021-06-12",
    "referencenumber": "sozjSQa8",
    "employmentType": "Full-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>8</id>
    <title>Job Title</title>
    <license>PTA</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>KIlLiuwO</shift>
    <payrate>8XlROboa</payrate>
    <positiontype>QuWpdUK1</positiontype>
    <duration>c67M3AdL</duration>
    <startdate>2021-06-12</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>HjZqYpYy</benefits>
    <posted>2021-06-12</posted>
    <referencenumber>sozjSQa8</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Post Job(s)

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

Parameters

Parameter should be appended to the endpoint URL.

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 in your spreadsheet. If not, the job will be added as a new job. If you select the 'Deactivate' option, any jobs that were added by a previous imported spreadsheet that no longer appear in your current spreadsheet will be deactivated.

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

  • COTA
  • CT Tech
  • Cath Lab Tech
  • Dialysis Tech
  • Dosimetrist
  • Echo Tech
  • Electrophysiology Tech
  • Histo Tech
  • Interventional Radiology
  • Lab Tech
  • Licensed Clinical Social Worker
  • MRI Tech
  • Mammography Tech
  • Med Tech
  • Medical Assistant
  • Nuclear Medicine Tech
  • OT
  • PT
  • PTA
  • Pharmacist
  • Pharmacy Tech
  • Phlebotomist
  • Psychology
  • RRT
  • Rad Tech
  • Radiation Therapist
  • Recreational Therapist
  • Resp Tech
  • SLP
  • Special Procedures Tech
  • Sterile Processing Tech
  • Surg Tech
  • Tech - Other
  • Ultrasound
  • Vascular Tech
  • X-Ray Tech
Yes

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

shift

String

No What shift your job posting is for.
payRate

String

No How much this position pays.
employmentType

List

Any combination of the following values:

  • Full-Time
  • Part-Time
  • Temporary
  • Permanent
No

The type(s) of employment applicable for this job. You can include more than one type value. See sample feed above for List format example when including multiple values.

positionType

String

No What type of position this is.
duration

String

No The duration of this job.
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.alliedtravelcareers.com/api/v2.0/jobs.jsonxml
[
    {
        "id": 7,
        "title": "Job Title",
        "license": "PTA",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "KIlLiuwO",
        "payrate": "8XlROboa",
        "positiontype": "QuWpdUK1",
        "duration": "c67M3AdL",
        "startdate": "2021-06-12",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "HjZqYpYy",
        "posted": "2021-06-12",
        "referencenumber": "sozjSQa8",
        "employmentType": "Part-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <id>7</id>
    <title>Job Title</title>
    <license>PTA</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>KIlLiuwO</shift>
    <payrate>8XlROboa</payrate>
    <positiontype>QuWpdUK1</positiontype>
    <duration>c67M3AdL</duration>
    <startdate>2021-06-12</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>HjZqYpYy</benefits>
    <posted>2021-06-12</posted>
    <referencenumber>sozjSQa8</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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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.alliedtravelcareers.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>