Documentation :: AllTruckJobs.com

AllTruckJobs API v2.0

Jobs Data

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

Fetch All Jobs

GET /api/v2.0/jobs.jsonxml

Sample Request

To get all jobs:

GET /api/v2.0/jobs.jsonxml

Sample Response

[
    {
        "referencenumber": "790ea4e5e1f5aa69818",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalcode": "null",
        "drivertype": "Student",
        "preference": "Lease Purchase Team",
        "freighttype": "Dry Bulk",
        "description": "Job Description",
        "requirements": "Job Requirements"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <referencenumber>641bd94d822ca</referencenumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalcode>null</postalcode>
    <drivertype>Company Driver</drivertype>
    <preference>Lease Purchase</preference>
    <freighttype>Reefer</freighttype>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
  </job>
</jobs>

Fetch a Single Job

GET /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 /api/v2.0/jobs.jsonxml/12345

Sample Response

[
    {
        "referencenumber": "fa74af66b1170fd2e5",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalcode": "null",
        "drivertype": "Company Driver",
        "preference": "Lease Purchase",
        "freighttype": "Dry Van",
        "description": "Job Description",
        "requirements": "Job Requirements"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <referencenumber>3a10e8c180037462</referencenumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalcode>null</postalcode>
    <drivertype>Owner Operator</drivertype>
    <preference>Lease Purchase</preference>
    <freighttype>Car Hauler</freighttype>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
  </job>
</jobs>

Post Job(s)

POST /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 'Delete' option, any jobs that were added by a previous imported spreadsheet that no longer appear in your current spreadsheet will be deleted.

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.

drivertype

One of the following values:

  • Company Driver
  • Owner Operator
  • Student
Yes

What type of driver your job post is looking to hire. We use this to appropriately categorize your job.

preference

One of the following values:

  • Lease Purchase
  • Team
  • Lease Purchase Team
No

Is the job a lease purchase and/or team opportunity? We use this to appropriately categorize your job.

freighttype

One of the following values:

  • Car Hauler
  • Dry Bulk
  • Dry Van
  • Flatbed
  • Intermodal
  • Overdimensional
  • Reefer
  • Tanker
Yes

What type of freight your job post is hauling. We use this to appropriately categorize your job.

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 driver applying to your job posting must meet. Basic HTML tags are allowed. If using XML, wrap in <![CDATA[ ]]>

Sample Request

POST /api/v2.0/jobs.jsonxml
[
    {
        "referencenumber": "e2b5376ac6309d",
        "title": "Job Title",
        "city": "Lancaster",
        "state": "PA",
        "postalcode": "null",
        "drivertype": "Student",
        "preference": "Lease Purchase Team",
        "freighttype": "Car Hauler",
        "description": "Job Description",
        "requirements": "Job Requirements"
    }
]
<?xml version="1.0"?>
<jobs>
  <job>
    <referencenumber>ce24ec811724f82d79</referencenumber>
    <title>Job Title</title>
    <city>Lancaster</city>
    <state>PA</state>
    <postalcode>null</postalcode>
    <drivertype>Company Driver</drivertype>
    <preference>Lease Purchase Team</preference>
    <freighttype>Overdimensional</freighttype>
    <description>Job Description</description>
    <requirements>Job Requirements</requirements>
  </job>
</jobs>

Sample Response

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

Delete a Single Job

DELETE /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 /api/v2.0/jobs.jsonxml/12345

Sample Response

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

Delete Multiple Jobs

DELETE /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 /api/v2.0/jobs.jsonxml
[
	12345,
	123456
]
<?xml version="1.0" encoding="UTF-8"?>
<jobs>
	<job>4313401</job>
	<job>4313469</job>
</jobs>

Sample Response

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

Delete One Job By Reference

DELETE /api/v2.0/jobs.jsonxml/reference/{id}

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 /api/v2.0/jobs.jsonxml/reference/12345

Sample Response

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

Delete Multiple Jobs By Reference

DELETE /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 /api/v2.0/jobs.jsonxml/reference
[
	"12345",
	"123456"
]
<?xml version="1.0" encoding="UTF-8"?>
<jobs>
	<job>reference number</job>
	<job>reference number</job>
</jobs>

Sample Response

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