TOPIC 1: Telematics

1.1 Telematics – vehicle data (location, timestamp, temperature, more)

Method FindVehiclesByUser

This specific method can be accessed at: https://livetrack.atcompass.net/ws/reports.asmx?op=FindVehiclesByUser

Parameters

user which is any end-user level user on the telematics platform

password the associated password for the user

Call

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /ws/reports.asmx/FindVehiclesByUser?user=string&pass=string HTTP/1.1
Host: livetrack.atcompass.net

Response


HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTrackingApiVehicleDTO xmlns="http://atcompass.net/">
  <TrackingApiVehicleDTO>
    <VehicleId>int</VehicleId>
    <VehicleName>string</VehicleName>
    <IMEICode>string</IMEICode>
    <EpochPointTimestamp>long</EpochPointTimestamp>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <Speed>double</Speed>
    <HeadingName>string</HeadingName>
    <PlaceName>string</PlaceName>
    <PointAddress>string</PointAddress>
    <Odometer>double</Odometer>
    <TemperatureEpochTimestamp>long</TemperatureEpochTimestamp>
    <TemperatureValue1>double</TemperatureValue1>
    <TemperatureValue2>double</TemperatureValue2>
    <BatteryLevel>double</BatteryLevel>
    <FuelLevel>double</FuelLevel>
  </TrackingApiVehicleDTO>
  <TrackingApiVehicleDTO>
    <VehicleId>int</VehicleId>
    <VehicleName>string</VehicleName>
    <IMEICode>string</IMEICode>
    <EpochPointTimestamp>long</EpochPointTimestamp>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <Speed>double</Speed>
    <HeadingName>string</HeadingName>
    <PlaceName>string</PlaceName>
    <PointAddress>string</PointAddress>
    <Odometer>double</Odometer>
    <TemperatureEpochTimestamp>long</TemperatureEpochTimestamp>
    <TemperatureValue1>double</TemperatureValue1>
    <TemperatureValue2>double</TemperatureValue2>
    <BatteryLevel>double</BatteryLevel>
    <FuelLevel>double</FuelLevel>
  </TrackingApiVehicleDTO>
  
</ArrayOfTrackingApiVehicleDTO>

Topic 2: Shipments

2.1 Get shipment information

Method GETSHIPMENTBYCARRIERID

Retrieve an existing shipment’s information from the ELD system.

Paramaters

CarrierId: This is the unique DOT number assigned to the motor carrier transporting the loads.

ShipmentNumber: Unique number assigned to a particular shipment (bill of lading).

Action: Indicates if the information being changed is for a pickup (warehouse load) or delivery (warehouse unload). A

value of 1 means a pickup (load) and 2 a delivery (unload).

Call

<?xml version=”1.0″ encoding=”utf-8″?>

<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”

xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:soap12=”http://www.w3.org/2003/05/soapenvelope”>

<soap12:Body>

<GetShipmentByCarrierId xmlns=”http://tempuri.org/”>

<CarrierId>string</CarrierId>

<ShipmentNumber>string</ShipmentNumber>

<Action>int</Action>

</GetShipmentByCarrierId>

</soap12:Body>

</soap12:Envelope>

Response

<HOSClientId>int</HOSClientId>

<CarrierName>string</CarrierName>

<CarrierAddress>string</CarrierAddress>

<TractorNumber>string</TractorNumber>

<TractorVin>string</TractorVin>

<LastKnownLocation>string</LastKnownLocation>

<HOSDriverId>int</HOSDriverId>

<DriverName>string</DriverName>

<HOSShipmentId>int</HOSShipmentId>

<StartTimeStamp>long</StartTimeStamp>

<StartTimeStampString>string</StartTimeStampString>

<EndTimeStamp>long</EndTimeStamp>

<EndTimeStampString>string</EndTimeStampString>

<ShipperName>string</ShipperName>

<ShipmentNumber>string</ShipmentNumber>

<Commodity>string</Commodity>

<PickupTimestamp>long</PickupTimestamp>

<PickupTimestampString>string</PickupTimestampString>

<PickupEmail>string</PickupEmail>

<PickupBay>string</PickupBay>

<PickupParking>string</PickupParking>

<PickupNotes>string</PickupNotes>

<DeliveryTimestamp>long</DeliveryTimestamp>

<DeliveryTimestampString>string</DeliveryTimestampString>

<DeliveryBay>string</DeliveryBay>

<DeliveryEmail>string</DeliveryEmail>

<DeliveryParking>string</DeliveryParking>

<DeliveryNotes>string</DeliveryNotes>

2.2 Update shipment information

Method SAVESHIPMENTDETAILS

Used to update the shipment after changes were made (e.g. a warehouse bay number was assigned, desire arrival time was modified, etc).

Paramaters

CarrierId: This is the unique DOT number assigned to the motor carrier transporting the loads.

ShipmentNumber: Unique number assigned to a particular shipment (bill of lading).

Action: Indicates if the information being changed is for a pickup (warehouse load) or delivery (warehouse unload). A

value of 1 means a pickup (load) and 2 a delivery (unload).

Call

<?xml version=”1.0″ encoding=”utf-8″?>

<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”

xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:soap12=”http://www.w3.org/2003/05/soapenvelope”>

<soap12:Body>

<SaveShipmentDetails xmlns=”http://tempuri.org/”>

<shipmentDetail>

<HOSClientId>int</HOSClientId>

<CarrierName>string</CarrierName>

<CarrierAddress>string</CarrierAddress>

<TractorNumber>string</TractorNumber>

<TractorVin>string</TractorVin>

<LastKnownLocation>string</LastKnownLocation>

<HOSDriverId>int</HOSDriverId>

<DriverName>string</DriverName>

<HOSShipmentId>int</HOSShipmentId>

<StartTimeStamp>long</StartTimeStamp>

<StartTimeStampString>string</StartTimeStampString>

<EndTimeStamp>long</EndTimeStamp>

<EndTimeStampString>string</EndTimeStampString>

<ShipperName>string</ShipperName>

<ShipmentNumber>string</ShipmentNumber>

<Commodity>string</Commodity>

<PickupTimestamp>long</PickupTimestamp>

<PickupTimestampString>string</PickupTimestampString>

<PickupEmail>string</PickupEmail>

<PickupBay>string</PickupBay>

<PickupParking>string</PickupParking>

<PickupNotes>string</PickupNotes>

<DeliveryTimestamp>long</DeliveryTimestamp>

<DeliveryTimestampString>string</DeliveryTimestampString>

<DeliveryBay>string</DeliveryBay>

<DeliveryEmail>string</DeliveryEmail>

<DeliveryParking>string</DeliveryParking>

<DeliveryNotes>string</DeliveryNotes>

</shipmentDetail>

<Action>int</Action>

</SaveShipmentDetails>

</soap12:Body>

</soap12:Envelope>

These are the parameters that can be changed by the warehouse management software for a pickup (load):

<PickupTimestamp>1542301140</PickupTimestamp> –Epoch time (GMT) 
<PickupEmail>person@warehouse1.com</PickupEmail> 
<PickupBay>12</PickupBay> 
<PickupParking>Exit 249 off I-10 behind FlyingJ</PickupParking> 
<PickupNotes>Wait for John’s call</PickupNotes>

These are the parameters that can be changed by the warehouse management software for a delivery (unload):

<DeliveryTimestamp>0</DeliveryTimestamp> 
<DeliveryBay/> <DeliveryEmail/> 
<DeliveryParking/> <DeliveryNotes/>