Documentation :: AlliedTravelCareers.com

AlliedTravelCareers API v2.0

Jobs

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

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:
  • Anesthesia Technician
  • COTA
  • CT Tech
  • Cath Lab Tech
  • Dialysis Tech
  • Dosimetrist
  • EMT
  • Echo Tech
  • Electrophysiology Tech
  • Histo Tech
  • Interventional Radiology
  • Licensed Clinical Social Worker
  • MRI Tech
  • Mammography Tech
  • Medical Assistant
  • Medical Lab Technician
  • Medical Technologist
  • 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


shiftstring

The shift for this job posting.


payRatestring

The estimated per weekly pay rate for each job posting. Please enter just the number, such as $1,000.


employmentTypelist

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:
  • Full-Time
  • Part-Time
  • Temporary
  • Permanent


positionTypestring

What type of position this is.


durationstring

The duration of a job posting in weeks. Please enter just the number, such as 13.


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.


requirementsstring

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


benefitsstring

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


Example

{
    "id": 2,
    "title": "Job Title",
    "license": "PTA",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "Night",
    "payrate": "6,979",
    "positiontype": "Permanent",
    "duration": "32",
    "startdate": "2022-12-10",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2022-12-10",
    "referencenumber": "3V0DpUsm",
    "employmentType": "Part-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>2</id>
    <title>Job Title</title>
    <license>PTA</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Night</shift>
    <payrate>6,979</payrate>
    <positiontype>Permanent</positiontype>
    <duration>32</duration>
    <startdate>2022-12-10</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-12-10</posted>
    <referencenumber>3V0DpUsm</referencenumber>
    <employmentType>Part-Time</employmentType>
  </job>
</jobs>

List all jobs

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

URL Parameters


No parameters.

Query Parameters


No parameters.

Sample Request

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

Sample Response

[
    {
        "id": 2,
        "title": "Job Title",
        "license": "OT",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Night",
        "payrate": "6,979",
        "positiontype": "Permanent",
        "duration": "32",
        "startdate": "2022-12-10",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-12-10",
        "referencenumber": "3V0DpUsm",
        "employmentType": "Full-Time"
    },
    {
        "id": 6,
        "title": "Job Title",
        "license": "PT",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Night",
        "payrate": "6,979",
        "positiontype": "Permanent",
        "duration": "32",
        "startdate": "2022-12-10",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-12-10",
        "referencenumber": "3V0DpUsm",
        "employmentType": "Full-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <id>2</id>
    <title>Job Title</title>
    <license>OT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Night</shift>
    <payrate>6,979</payrate>
    <positiontype>Permanent</positiontype>
    <duration>32</duration>
    <startdate>2022-12-10</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-12-10</posted>
    <referencenumber>3V0DpUsm</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
  <job>
    <id>6</id>
    <title>Job Title</title>
    <license>PT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Night</shift>
    <payrate>6,979</payrate>
    <positiontype>Permanent</positiontype>
    <duration>32</duration>
    <startdate>2022-12-10</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-12-10</posted>
    <referencenumber>3V0DpUsm</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Post job(s)

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

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

No

The zip code where your job posting is located.

license

String

One of the following allowed values:

  • Anesthesia Technician
  • COTA
  • CT Tech
  • Cath Lab Tech
  • Dialysis Tech
  • Dosimetrist
  • EMT
  • Echo Tech
  • Electrophysiology Tech
  • Histo Tech
  • Interventional Radiology
  • Licensed Clinical Social Worker
  • MRI Tech
  • Mammography Tech
  • Medical Assistant
  • Medical Lab Technician
  • Medical Technologist
  • 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 The shift for this job posting.
payRate

String

No The estimated per weekly 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
  • Temporary
  • Permanent
No

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.

positionType

String

No What type of position this is.
duration

String

No The duration of a job posting in weeks. Please enter just the number, such as 13.
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
[
    {
        "title": "Job Title",
        "license": "PT",
        "city": "Lancaster",
        "state": "PA",
        "zip": "17603",
        "shift": "Night",
        "payrate": "6,979",
        "positiontype": "Permanent",
        "duration": "32",
        "startdate": "2022-12-10",
        "description": "Job Description",
        "requirements": "Job Requirements",
        "benefits": "Text describing the benefits for the position",
        "posted": "2022-12-10",
        "referencenumber": "3V0DpUsm",
        "employmentType": "Part-Time"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <title>Job Title</title>
    <license>PT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Night</shift>
    <payrate>6,979</payrate>
    <positiontype>Permanent</positiontype>
    <duration>32</duration>
    <startdate>2022-12-10</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-12-10</posted>
    <referencenumber>3V0DpUsm</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>

Retrieve a job

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

URL Parameters


id REQUIRED integer

The ID number of the job you want to fetch.


Query Parameters


No parameters.

Sample Request

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

Sample Response

{
    "id": 8,
    "title": "Job Title",
    "license": "PT",
    "city": "Lancaster",
    "state": "PA",
    "zip": "17603",
    "shift": "Night",
    "payrate": "6,979",
    "positiontype": "Permanent",
    "duration": "32",
    "startdate": "2022-12-10",
    "description": "Job Description",
    "requirements": "Job Requirements",
    "benefits": "Text describing the benefits for the position",
    "posted": "2022-12-10",
    "referencenumber": "3V0DpUsm",
    "employmentType": "Full-Time"
}
<?xml version="1.0"?>
<jobs>
  <job>
    <id>8</id>
    <title>Job Title</title>
    <license>PT</license>
    <city>Lancaster</city>
    <state>PA</state>
    <zip>17603</zip>
    <shift>Night</shift>
    <payrate>6,979</payrate>
    <positiontype>Permanent</positiontype>
    <duration>32</duration>
    <startdate>2022-12-10</startdate>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
    <benefits>Text describing the benefits for the position</benefits>
    <posted>2022-12-10</posted>
    <referencenumber>3V0DpUsm</referencenumber>
    <employmentType>Full-Time</employmentType>
  </job>
</jobs>

Delete a job

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

URL Parameters


id REQUIRED integer

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

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 a job by reference

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

URL Parameters


referenceNumber REQUIRED string

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

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>