Transcore Load API V2

2019
TRANZLOGIX
Truckergig CRM
Load and Asset Tracking API
v1.0.2.200 2019-1
Truckergig CRM - Load and Asset Tracking API
Contents
LOAD ASSIGNMENT AND TRACKING METHODS 4

Truckergig CRM Platform 4
AUTHENTICATION 6
Authentication Token 6
Long-lived Token Authentication 6
DATES/TIMES 7
HTTP Methods 7
HTTP Responses 8
REST RESOURCES 9
Assets 9
Resource Methods 9
SERVICES OR UI INTERFACE FOR MANAGING AND TRACKING THE LOAD. 11
CREATE CARRIER IN TRUCKERGIG. 11

Response 12
CHOOSE VALID CARRIER. 13

Example Resource Usage 14
ASSIGN LOAD TO CARRIER IN TRUCKERGIG. 15

Response 16
GET THE ASSIGNED LOAD TO THE CARRIER. 16

ASSIGN VEHICLE/DRIVER/DEVICE TO THE LOAD BY CARRIER IN TRUCKERGIG. 20

Response 21
GET DRIVER OR VEHICLE TO THE LOAD. 22

START TRACKING THE LOAD.. 24

Response 25
TRACKING THE LOAD. 26

2
STOP TRACKING THE LOAD.. 29

Response 30
3
Load Assignment and Tracking Methods
Truckergig CRM Platform
Tranzlogix aggregate Logistics data across Carriers, ELD Devices, Brokers, Shippers in
US Transport market on line lively and thereby enables smart and smooth management
of Load and delivery in time.
Tranzlogix have developed API and UI Interface that can readily integrate with Brokers,
Carriers and Shippers through web service for exchange of information for this purpose.
This Interface enables Shippers, Brokers to get connected with carrier for their Load
booking and Tracking information online.
Basically Tranzlogix already have online exchange of ELD device log information like
GPS Tracking data, DVIR, HOS, Drivers, Vehicle, ELD Device with most of the popular
ELD vendors in the US market and readily developed platform for integration.
The Shippers, Brokers and Carriers are get registered with Tranzlogix Truckergig portal
and thereby get API authentication code. This API authentication code uniquely identifies
the Shippers, Brokers and Carriers in the System and used for subsequent service call
and interaction with Tranzlogix.
4
When Shipper or Broker Book a Load with Carrier, they can in parallel Identify the carrier
in Tranzlogix Truckergig system and upload the Load information through UI interface or
through API call.
On getting the Load and Carrier Information the Truckergig system get connected with
the carrier and get the Driver or Vehicle assigned to the Load by Mapping the Driver ID or
Vehicle ID to the Load Number.
Actual transaction between Shippers and Carriers or Brokers and Carriers happen in off
line and the reference to these Transactions are tracked in Tranzlogix Truckergig.
5
Authentication
Authentication Token
An authentication token is issued during on-boarding of Shipper, Broker or Carrier in Truckergig and must
be provided on each request. The application token acts as an API key to identify the partner’s API usage
in general. Therefore, every call shall include the following request header:
X-AuthToken <Authentication Token>
Request
X-Auth-Token: 55555555-5555-5555-5555-555555555
Accept: */*
Long-lived Token Authentication
The API supports a mechanism for obtaining long-lived access tokens. This is a
transparent, cryptographically signed token. Once obtained, it can be used on
subsequent requests to authenticate the caller which avoids passing the username and
password.
Request
X-AuthToken: 55555555-5555-5555-5555-555555555
Accept: */*
6
Dates/Times
All Dates represented in output, input or query parameters are represented in ISO
8601 Format.
The parsing of ISO 8601 dates allows for input dates to be specified to whatever
precision is necessary.
Examples
2015-07-13T23:17:42.000-6000
2015-07-13T23:17:42.000
2015-07-13T23:17:42
2015-07-13T23:17
2015-07-13T23
2015-07-13
2015-07
2015
Input dates assume UTC time if no oﬀset from UTC is provided.
HTTP Methods
HTTP Usage
GET Query a collection or specific resource by Id - Supports collection filters were

specified using http uri query parameters.
POST Create a new resource within a collection - Response includes the new entity in
the body and a location header with fully qualified URL to new entity.
PUT Update a specific resource by Id - Requires the complete entity state to be
communicated, does not support partial updates.
DELETE Delete a specific resource by Id
7
HTTP Responses
HTTP Reason
Response for successful requests, typical response for successful GET

200 OK
and PUT
Requests
Response for successful creation requests, typical response for
201 Created
successful POST
Requests
204 No Content Response for successful DELETE requests

Error response indicating that the request body could not be acted
400 Bad Request
upon either
because of syntax or input validation (ex: number out of range)
Error response indicating that the execution of the request would
409 Conflict
violate business
Rules. (ex: duplicate asset name)
404 Not Found Error response indicating the resource entity was not found
401 Unauthorized Error response indicating the execution
403 Forbidden Authorization Exception

Too Many This will be returned for any request in violation of a
429
Requests max/requests per second
Throttling.
Internal Server
500 System Exception
Error
8
REST Resources
Assets
An Asset represents a physical thing that can be instrumented by a Device in order to

gather telemetry data and other useful information.
Resource Methods
Request URI Description
POST Create carrier in Truckergig with SCAC Code.

/carrier
GET Get the valid carrier details from Truckergig for the SCAC
/carrier/${scacid} code.
POST
/assignLoad/ Assign Load to the Carrier by Shipper.
GET
/assignLoad/${scacid}/${ Get the assigned Load number and the Load details to
loadnumber} the carrier.
POST
/assignVehicle/ Assign Vehicle or Driver to the Load by Carrier.
GET
/getVehicle/${scacid}/
${loadnumber} Get Vehicle or Driver linked to the Load from the Carrier.
PUT
/startTracking/ Start tracking the Load
GET
/trackload/${scacid}/
${loadnumber Get tracking information of the Load.
9
PUT
/stopTracking/ Stop tracking the Load, may be by POD (proof of delivery) .
10
Services or UI Interface for Managing and Tracking the Load.
Create Carrier in Truckergig.

POST https://truckergig.com/loadapi/v1/carrier/
Broker or Shipper shall create a Carrier for their Load in Tranzlogix System through
this service.
The Carrier is identified by SCAC code in Tranzlogix Truckergig.
Input Parameter Body Description
"name": "Amex_Trucking_company",
11
"SCAC": "by673", SCAC code which is

"MC":"MAZ6732309", Uniquely identifying the
"MX":"8672323", Carrier. (Standard Carrier
"FF":"089233IO", Alpha Code) is mandatory
"contact":{ field, rest of the fields are
"street_address":"Teststreet 10 A 34", optional.
"poatal_code":"70100",
"city":"Kuopio",
"country":"FI",
"phone":"0401231234",
"email":"[email protected]"
}
Response
{
"Status":"Success",
"Carrier SCAC": "by673"
}
12
Choose Valid Carrier.

GET https://truckergig.com/loadapi/v1/carrier/<scacid>/
Broker or Shipper can check or choose a Carrier for their Load in Tranzlogix System
through this service.
The Carrier is identified by SCAC code in Tranzlogix Truckergig, If the valid code is
found in the system this service will return the details of the Carrier there by the
chosen carrier is validated.
Parameters (Mandatory) Usage Description
Uniquely identify the

URL Query Parameter:
SCAC Code Carrier. Standard Carrier
?scacid=by673
Alpha Code.
13
Example Resource Usage

{
"Status":"Success",
"Carrier": "Amex_Trucking_company",
"Carrier_Info":{"street_address":"Teststreet 10 A 34",
"city":"Kuopio",
"country":"FI",
"phone":"0401231234",
"email":"[email protected]"
} ,
"Carriercode":[
{
"name":"SCAC#",
"value":"1234"
},
{
"name":"MC#",
"value":"MAZS92A004"
},
{
"name":"MX#",
"value":"1234"
},
{
"name":"FF#",
"value":"1234"
}]
}
14
Assign Load to Carrier in Truckergig.

POST https://truckergig.com/loadapi/v1/assignLoad/
Broker or Shipper shall be able to assign a load to the carrier already been created
in the Truckergig CRM.
The Carrier is identified by SCAC code in Tranzlogix Truckergig and the Load is
identified by the Load Number.
{
"SCAC": "by673",
"LoadNumber":"MAZ6732309",
"LoadNumber_Date":"15-12-2018", SCAC code which is
"PO":"84221", Uniquely identifying the
"PO_Date":"15-12-2018", Carrier. (Standard Carrier
"BOL": “09182”, Alpha Code), the Load
"BOL_Date":"15-12-2018" Number and
} LoadNumber_Date are
15
mandatory fields, rest of

} the fields are optional.
Response
{
"Status":"Success",
"Carrier SCAC": "by673",
“LoadNumber”:” MAZ6732309”,
“LoadNumber_Date”: ” 15-12-2018”
}
Get the Assigned Load to the Carrier.

GET https://truckergig.com/loadapi/v1/assignLoad/<scacid>/<loadnumer>
On executing the Purchase Order, Bill of Lading with the carrier the details of the Load with
PO, BOL or Load Number reference can be uploaded to the Truckergig through UI or API
interface. This service will get the details of the Load and the carrier mapping information.
16

?scacid=by673
Alpha Code
For the Carrier code the
URL Query Parameter: Load Number may be PO
LoadNumber
?loadnumber=256837 Number or BOL Number.
Which Identifies the Load.
17

{
"Status":{"Code":"",
"Description":""} ,
"Load_Info":{ "Miles":"975",
"Weight":"2400",
"Quantity":"25",
"Weight":"20000",
"Commodity":"Floor Loaded Mattresses",
"Equipment Type":"Van",
"Temprature":"",
"Length":"",
"Width":"",
"Height":"",
"PickUp":{"From":"1676 Montgomery Hwy.
Dothan, AL 36303",
"EarliestTime":"11/10/2018 07:00",
"LatestTime":"11/10/2018 08:00"
},
"Delivery":{"To":"7402 Hodgson Memorial
Ste 105 Savannah, GA 31406",
"EarliestTime":"11/10/2018 07:00",
"LatestTime":"11/10/2018 08:00"
}
}
,
"Load_Reference":[
{
"name":"PO",
"value":"1234"
},
{
18
"name":"PO_Date",
"value":"12-10-2018"
},
{
"name":"BOL",
},
{
"name":"BOL_Date",
"value":"15-10-2018"
},
{
"name":"LoadNumber",
},
{
"name":"LoadNumber_Date",
"value":"15-10-2018"
}
],
"Broker_Info":{"Broker":"Blue Star Logistics",
"Company Phone":"(800)-666-7200",
"Company Fax":"(888)-611-8954",
"Agent Name":"Corey Hardee",
"Agent Phone":"(260)-755-4389",
"Agent Fax":"(000)-000-0000",
"Address":{"street_address":"875 Old Roswell Road Suite $G-300 Roswell
GA",
}
},
"Carrier_Info":{"Carrier":"On Time Transport LLC",
"Phone":"(402)-328-9082",
19
"Fax":"25",
"Contact Name":"Stephen",
"Dispatch Email":"[email protected]"
}
Assign Vehicle/Driver/Device to the Load by Carrier in Truckergig.

POST https://truckergig.com/loadapi/v1/assignVehicle/
Carrier shall be able to assign his load to the Vehicle or Driver or Device in the
Truckergig CRM.
identified by the Load Number. Carrier can link the load to his Vehicle or Driver or
to the tracking device.
20
SCAC code which is

Uniquely identifying the
Carrier. (Standard Carrier
{
Alpha Code), the load
"SCAC": "by673",
Number, linkBy, assetId are
"loadNumber":"MAZ6732309",
mandatory fields.
"linkBy":"0",
linkBy 0: by vehicle
"assetId":"124221",
1: by Driver
}
2: by Device
The assetId shall be the
corresponding asset Id of
the Vehicle or Driver or the
Device in the system.
Response
{
"status":"Success",
"carrier SCAC": "by673",
“loadNumber”:” MAZ6732309”,
“assetId”: ” 9612303”
}
21
Get Driver or Vehicle to the Load.
GET https://truckergig.com/loadapi/v1/getVehicle/<scacid>/<loadNumber>
Through ELD Integration channel of Tranzlogix the Carrier can Identify their Driver and Vehicle
in the Tranzlogix and can readily Map the Load reference to the assigned Driver or Vehicle.
This request been sent to the Carrier and shall get the Driver or Vehicle Reference.

?scacid=by673
Alpha Code
LoadNumber
22

{
"Status":"Success",
"person-id": "1",
"assign_date": "2014-05-23",
"driver-name": "Lee Payne",
"co-drivers": "Dan Collens",
"carrier_id":"89T633",
"carrier-name": "Renegade Trucking",
"carrier-address": "1401 Russell St, Baltimore, MD, 21230",
"home-terminal-address": "123 Another St",
"truck": {
"truck-id": "22",
"vin_number": "133iOS",
"license": "ALYJ 633"
},
"Device": {
"device-id": "22",
"device_type": "133iOS",
"SSID": "ALYJ 633"
},
"Load_Reference":[
{
"name":"PO",
"value":"1234"
},
{
"name":"PO_Date",
"value":"12-10-2018"
},
{
23
"name":"BOL",
},
{
"name":"BOL_Date",
"value":"15-10-2018"
},
{
"name":"LoadNumber",
},
{
"name":"LoadNumber_Date",
"value":"15-10-2018"
}
],
"trailers": "4127 <ACPS 412>",

"shipments": "Q109A88667",
"remarks": "Extreme weather caused unusual delay on this date.",
}
Start Tracking the Load.

PUT https://truckergig.com/loadapi/v1/starTracking/
Broker, Shipper and Carrier shall be able to trigger or initiate the tracking of the
Load. By default, the tracking data will not be available and exposed unless this
service is called in the Truckergig CRM.
24
SCAC code which is

Uniquely identifying the
{ Carrier. (Standard Carrier
"SCAC": "by673", Alpha Code), the load
"loadNumber":"MAZ6732309", Number are mandatory
} fields.
If the Load and the Carrier
are assigned to the Vehicle,
then this service will
initiate the tracking.
Response
{
"status":"Success",
“assetId”: ” 9612303”
}
25
Tracking the Load.

GET https://truckergig.com/loadapi/v1/trackLoad/<scacid>/<loadNumber>
Through Load Reference, now Shippers and Brokers can get their Load Tracking Information
like as on time the GPS Location, History, Direction, any event information, remaining HOS,
speed, duty status etc. on line.

?scacid=by673
Alpha Code
LoadNumber
26

[
{
“Status”:”Succes”,
"person-id": "1",
"date": "2014-05-23",
"revision": "515",
"driver-name": "Lee Payne",
"co-drivers": "Dan Collens",
"carrier-name": "Renegade Trucking",
"carrier-address": "1401 Russell St, Baltimore, MD, 21230",
"home-terminal-address": "123 Another St",
"truck": {
"truck-id": "22",
"number": "133iOS",
"license": "ALYJ 633",
"start-odometer": {
"unit": "KM",
"#text": "123456"
},
"end-odometer": {
"unit": "KM",
"#text": "123556"
},
"distance": {
"unit": "KM",
"#text": "100"
}
},
"trailers": "4127 <ACPS 412>",
"shipments": "Q109A88667",
"remarks": "Extreme weather caused unusual delay on this date.",
27
"hos-settings": {
"home-timezone": "US/Eastern",
"cycle": "U.S. 70hr/8day",
"vehicle-type": "Property",
"exception": [
{
"name": "US-24h-reset"
},
{
"name": "US-oilfield-wait"
}
]
},
"last-modified-at": "2014-05-27T20:53:49.386Z",
"event": [
{
"continuation": "true",
"occurred-at": "2014-05-23T00:00:00.000-04:00",
"duration": "720",
"duty-status": "SL"
},
{
"occurred-at": "2014-05-23T12:00:00.000-04:00",
"duration": "179",
"duty-status": "ON",
"location-name": "Kitchener, ON",
"position": {
"lat": "43.421225",
"lon": "-80.502228",
"accuracy": "5"
},
"remarks": "Extra note"
},
}
]
28
Stop Tracking the Load.

PUT https://truckergig.com/loadapi/v1/stopTracking/
Broker, Shipper and Carrier shall be able stop or hold the tracking of the Load. By
default, the tracking data will not be available and exposed unless the start
tracking service is called in the Truckergig CRM.
Once again this stop Tracking service can stop tracking the Load and the tracking
data will not available to view.
{ SCAC code which is

"SCAC": "by673", Uniquely identifying the
"loadNumber":"MAZ6732309", Carrier. (Standard Carrier
} Alpha Code), the load
Number are mandatory
fields.
29
If the Load and the Carrier

are assigned to the Vehicle,
then this service will stop
the tracking.
Response
{
"status":"Success",
“assetId”: ” 9612303”
}
30

Transcore Load API V2

Uploaded by

Copyright:

Available Formats

Transcore Load API V2

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Transcore Load API V2

Uploaded by

Copyright:

Available Formats

2019

LOAD ASSIGNMENT AND TRACKING METHODS 4

SERVICES OR UI INTERFACE FOR MANAGING AND TRACKING THE LOAD. 11

CREATE CARRIER IN TRUCKERGIG. 11

CHOOSE VALID CARRIER. 13

ASSIGN LOAD TO CARRIER IN TRUCKERGIG. 15

GET THE ASSIGNED LOAD TO THE CARRIER. 16

ASSIGN VEHICLE/DRIVER/DEVICE TO THE LOAD BY CARRIER IN TRUCKERGIG. 20

GET DRIVER OR VEHICLE TO THE LOAD. 22

START TRACKING THE LOAD.. 24

TRACKING THE LOAD. 26

STOP TRACKING THE LOAD.. 29

Load Assignment and Tracking Methods

Truckergig CRM Platform

Long-lived Token Authentication

GET Query a collection or specific resource by Id - Supports collection filters were

PUT Update a specific resource by Id - Requires the complete entity state to be

communicated, does not support partial updates.

DELETE Delete a specific resource by Id

Response for successful requests, typical response for successful GET

204 No Content Response for successful DELETE requests

401 Unauthorized Error response indicating the execution

403 Forbidden Authorization Exception

An Asset represents a physical thing that can be instrumented by a Device in order to

Request URI Description

POST Create carrier in Truckergig with SCAC Code.

Services or UI Interface for Managing and Tracking the Load.

Create Carrier in Truckergig.

The Carrier is identified by SCAC code in Tranzlogix Truckergig.

Input Parameter Body Description

"SCAC": "by673", SCAC code which is

Choose Valid Carrier.

Parameters (Mandatory) Usage Description

Uniquely identify the

Example Resource Usage

Assign Load to Carrier in Truckergig.

Input Parameter Body Description

mandatory fields, rest of

Get the Assigned Load to the Carrier.

Parameters (Mandatory) Usage Description

Uniquely identify the

Example Resource Usage

Assign Vehicle/Driver/Device to the Load by Carrier in Truckergig.

Input Parameter Body Description

SCAC code which is

Get Driver or Vehicle to the Load.

Parameters (Mandatory) Usage Description

Uniquely identify the

Example Resource Usage

"trailers": "4127 <ACPS 412>",

Start Tracking the Load.

Input Parameter Body Description

SCAC code which is

Tracking the Load.

Parameters (Mandatory) Usage Description

Uniquely identify the

Example Resource Usage

Stop Tracking the Load.

Input Parameter Body Description