Trakopolis API Documentation

IncomingMessage

Service URLs:

https://api.trakopolis.com/api/Messages/Incoming/{messageId}
https://api.trakopolis.com/api/Messages/Incoming[?includechilddivisions={true|false}][&includedisabled={true|false}][&assetid={assetid}][&terminalid={terminalid}][&startdatetime={yyyy-MM-ddTHH:mm:ss}][&enddatetime={yyyy-MM-ddTHH:mm:ss}]

JSON Response Example

{
  "Id": 1,
  "Message": "StringValue",
  "CreatedOn": "2024-12-21T12:49:28Z",
  "Terminal": {
    "Id": 1,
    "SerialNumber": "StringValue",
    "AssetId": 1,
    "AssetName": "StringValue",
    "DivisionId": 1,
    "TerminalType": "StringValue",
    "TerminalTypeId": 1,
    "UpdatedOn": "2024-12-21T12:49:28Z",
    "CreatedOn": "2024-12-21T12:49:28Z",
    "Primary": false,
    "Active": false,
    "BillingStatus": "StringValue",
    "BillingStatusId": 1,
    "Properties": [
      {
        "Name": "StringValue",
        "Key": "StringValue",
        "Number": 1,
        "Type": 1,
        "Value": "StringValue"
      }
    ],
    "LatestStatus": {
      "Id": 1,
      "AssetId": 1,
      "DriverId": 1,
      "TerminalId": 1,
      "Terminal": null,
      "Latitude": 1.0,
      "Longitude": 1.0,
      "Address": "StringValue",
      "City": "StringValue",
      "Zip": "StringValue",
      "State": "StringValue",
      "Country": "StringValue",
      "Speed": 1.0,
      "Heading": 1,
      "Road": "StringValue",
      "OnRoad": false,
      "Odometer": 1.0,
      "OdometerUnits": "StringValue",
      "OdometerMeters": 1.0,
      "Hourmeter": 1.0,
      "MessageCode": "StringValue",
      "AnalogSensorDatas": [
        {
          "Sensor": 1,
          "Name": "StringValue",
          "SensorValue": 1.0,
          "RecalculatedValue": 1.0,
          "Units": "StringValue"
        }
      ],
      "DigitalSensorDatas": [
        {
          "Sensor": 1,
          "Name": "StringValue",
          "Value": false,
          "State0": "StringValue",
          "State1": "StringValue"
        }
      ],
      "ExtraDatas": {
        "ExtraParams": [
          {
            "UniqueCode": "StringValue",
            "StringValue": "StringValue",
            "OptionKey": "StringValue",
            "FloatValue": {
              "RawValue": 1.0,
              "Value": 1.0,
              "Units": "StringValue"
            },
            "Type": "StringValue",
            "BytesValue": null
          }
        ],
        "Obd2Dtc": [
          {
            "DtcCode": "StringValue"
          }
        ],
        "Obd2Pid": [
          {
            "PidCode": 1,
            "PidParamNo": 1,
            "FloatValue": {
              "RawValue": 1.0,
              "Value": 1.0,
              "Units": "StringValue"
            }
          }
        ],
        "J1939": [
          {
            "SpnNumber": 1,
            "SpnFloatValue": {
              "RawValue": 1.0,
              "Value": 1.0,
              "Units": "StringValue"
            },
            "SpnStateName": "StringValue",
            "SpnState": 1,
            "FmiNumber": 1,
            "Type": "StringValue"
          }
        ]
      },
      "CreatedOn": "2024-12-21T12:49:28Z",
      "Fuel": {
        "Value": 1.0,
        "Units": "StringValue",
        "ValueInLiters": 1.0
      },
      "Buffered": false,
      "ProxyId": "StringValue"
    }
  },
  "Status": {
    "Id": 1,
    "AssetId": 1,
    "DriverId": 1,
    "TerminalId": 1,
    "Terminal": null,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Address": "StringValue",
    "City": "StringValue",
    "Zip": "StringValue",
    "State": "StringValue",
    "Country": "StringValue",
    "Speed": 1.0,
    "Heading": 1,
    "Road": "StringValue",
    "OnRoad": false,
    "Odometer": 1.0,
    "OdometerUnits": "StringValue",
    "OdometerMeters": 1.0,
    "Hourmeter": 1.0,
    "MessageCode": "StringValue",
    "AnalogSensorDatas": [
      {
        "Sensor": 1,
        "Name": "StringValue",
        "SensorValue": 1.0,
        "RecalculatedValue": 1.0,
        "Units": "StringValue"
      }
    ],
    "DigitalSensorDatas": [
      {
        "Sensor": 1,
        "Name": "StringValue",
        "Value": false,
        "State0": "StringValue",
        "State1": "StringValue"
      }
    ],
    "ExtraDatas": {
      "ExtraParams": [
        {
          "UniqueCode": "StringValue",
          "StringValue": "StringValue",
          "OptionKey": "StringValue",
          "FloatValue": {
            "RawValue": 1.0,
            "Value": 1.0,
            "Units": "StringValue"
          },
          "Type": "StringValue",
          "BytesValue": null
        }
      ],
      "Obd2Dtc": [
        {
          "DtcCode": "StringValue"
        }
      ],
      "Obd2Pid": [
        {
          "PidCode": 1,
          "PidParamNo": 1,
          "FloatValue": {
            "RawValue": 1.0,
            "Value": 1.0,
            "Units": "StringValue"
          }
        }
      ],
      "J1939": [
        {
          "SpnNumber": 1,
          "SpnFloatValue": {
            "RawValue": 1.0,
            "Value": 1.0,
            "Units": "StringValue"
          },
          "SpnStateName": "StringValue",
          "SpnState": 1,
          "FmiNumber": 1,
          "Type": "StringValue"
        }
      ]
    },
    "CreatedOn": "2024-12-21T12:49:28Z",
    "Fuel": {
      "Value": 1.0,
      "Units": "StringValue",
      "ValueInLiters": 1.0
    },
    "Buffered": false,
    "ProxyId": "StringValue"
  },
  "AssetId": 1,
  "DriverId": 1
}

XML Response Example

<?xml version="1.0" encoding="utf-8"?>
<IncomingMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>1</Id>
  <Message>StringValue</Message>
  <CreatedOn>2024-12-21T12:49:28Z</CreatedOn>
  <Terminal>
    <Id>1</Id>
    <SerialNumber>StringValue</SerialNumber>
    <AssetId>1</AssetId>
    <AssetName>StringValue</AssetName>
    <DivisionId>1</DivisionId>
    <TerminalType>StringValue</TerminalType>
    <TerminalTypeId>1</TerminalTypeId>
    <UpdatedOn>2024-12-21T12:49:28Z</UpdatedOn>
    <CreatedOn>2024-12-21T12:49:28Z</CreatedOn>
    <Primary>false</Primary>
    <Active>false</Active>
    <BillingStatus>StringValue</BillingStatus>
    <BillingStatusId>1</BillingStatusId>
    <Properties>
      <TerminalProperty>
        <Name>StringValue</Name>
        <Key>StringValue</Key>
        <Number>1</Number>
        <Type>1</Type>
        <Value>StringValue</Value>
      </TerminalProperty>
    </Properties>
    <LatestStatus>
      <Id>1</Id>
      <AssetId>1</AssetId>
      <DriverId>1</DriverId>
      <TerminalId>1</TerminalId>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Address>StringValue</Address>
      <City>StringValue</City>
      <Zip>StringValue</Zip>
      <State>StringValue</State>
      <Country>StringValue</Country>
      <Speed>1</Speed>
      <Heading>1</Heading>
      <Road>StringValue</Road>
      <OnRoad>false</OnRoad>
      <Odometer>1</Odometer>
      <OdometerUnits>StringValue</OdometerUnits>
      <OdometerMeters>1</OdometerMeters>
      <Hourmeter>1</Hourmeter>
      <MessageCode>StringValue</MessageCode>
      <AnalogSensorDatas>
        <AnalogSensorData>
          <Sensor>1</Sensor>
          <Name>StringValue</Name>
          <SensorValue>1</SensorValue>
          <RecalculatedValue>1</RecalculatedValue>
          <Units>StringValue</Units>
        </AnalogSensorData>
      </AnalogSensorDatas>
      <DigitalSensorDatas>
        <DigitalSensorData>
          <Sensor>1</Sensor>
          <Name>StringValue</Name>
          <Value>false</Value>
          <State0>StringValue</State0>
          <State1>StringValue</State1>
        </DigitalSensorData>
      </DigitalSensorDatas>
      <ExtraDatas>
        <ExtraParams>
          <TrakopolisExtraParamData>
            <ParamNumber>0</ParamNumber>
            <UniqueCode>StringValue</UniqueCode>
            <StringValue>StringValue</StringValue>
            <OptionKey>StringValue</OptionKey>
            <FloatValue>
              <RawValue>1</RawValue>
              <Value>1</Value>
              <Units>StringValue</Units>
            </FloatValue>
            <Type>StringValue</Type>
          </TrakopolisExtraParamData>
        </ExtraParams>
        <Obd2Dtc>
          <Obd2DtcData>
            <ParamNumber>0</ParamNumber>
            <DtcCode>StringValue</DtcCode>
          </Obd2DtcData>
        </Obd2Dtc>
        <Obd2Pid>
          <Obd2PidData>
            <ParamNumber>0</ParamNumber>
            <PidCode>1</PidCode>
            <PidParamNo>1</PidParamNo>
            <FloatValue>
              <RawValue>1</RawValue>
              <Value>1</Value>
              <Units>StringValue</Units>
            </FloatValue>
          </Obd2PidData>
        </Obd2Pid>
        <J1939>
          <J1939Data>
            <ParamNumber>0</ParamNumber>
            <SpnNumber>1</SpnNumber>
            <SpnFloatValue>
              <RawValue>1</RawValue>
              <Value>1</Value>
              <Units>StringValue</Units>
            </SpnFloatValue>
            <SpnStateName>StringValue</SpnStateName>
            <SpnState>1</SpnState>
            <FmiNumber>1</FmiNumber>
            <Type>StringValue</Type>
          </J1939Data>
        </J1939>
      </ExtraDatas>
      <CreatedOn>2024-12-21T12:49:28Z</CreatedOn>
      <Fuel>
        <Value>1</Value>
        <Units>StringValue</Units>
        <ValueInLiters>1</ValueInLiters>
      </Fuel>
      <Buffered>false</Buffered>
      <ProxyId>StringValue</ProxyId>
    </LatestStatus>
  </Terminal>
  <Status>
    <Id>1</Id>
    <AssetId>1</AssetId>
    <DriverId>1</DriverId>
    <TerminalId>1</TerminalId>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <Address>StringValue</Address>
    <City>StringValue</City>
    <Zip>StringValue</Zip>
    <State>StringValue</State>
    <Country>StringValue</Country>
    <Speed>1</Speed>
    <Heading>1</Heading>
    <Road>StringValue</Road>
    <OnRoad>false</OnRoad>
    <Odometer>1</Odometer>
    <OdometerUnits>StringValue</OdometerUnits>
    <OdometerMeters>1</OdometerMeters>
    <Hourmeter>1</Hourmeter>
    <MessageCode>StringValue</MessageCode>
    <AnalogSensorDatas>
      <AnalogSensorData>
        <Sensor>1</Sensor>
        <Name>StringValue</Name>
        <SensorValue>1</SensorValue>
        <RecalculatedValue>1</RecalculatedValue>
        <Units>StringValue</Units>
      </AnalogSensorData>
    </AnalogSensorDatas>
    <DigitalSensorDatas>
      <DigitalSensorData>
        <Sensor>1</Sensor>
        <Name>StringValue</Name>
        <Value>false</Value>
        <State0>StringValue</State0>
        <State1>StringValue</State1>
      </DigitalSensorData>
    </DigitalSensorDatas>
    <ExtraDatas>
      <ExtraParams>
        <TrakopolisExtraParamData>
          <ParamNumber>0</ParamNumber>
          <UniqueCode>StringValue</UniqueCode>
          <StringValue>StringValue</StringValue>
          <OptionKey>StringValue</OptionKey>
          <FloatValue>
            <RawValue>1</RawValue>
            <Value>1</Value>
            <Units>StringValue</Units>
          </FloatValue>
          <Type>StringValue</Type>
        </TrakopolisExtraParamData>
      </ExtraParams>
      <Obd2Dtc>
        <Obd2DtcData>
          <ParamNumber>0</ParamNumber>
          <DtcCode>StringValue</DtcCode>
        </Obd2DtcData>
      </Obd2Dtc>
      <Obd2Pid>
        <Obd2PidData>
          <ParamNumber>0</ParamNumber>
          <PidCode>1</PidCode>
          <PidParamNo>1</PidParamNo>
          <FloatValue>
            <RawValue>1</RawValue>
            <Value>1</Value>
            <Units>StringValue</Units>
          </FloatValue>
        </Obd2PidData>
      </Obd2Pid>
      <J1939>
        <J1939Data>
          <ParamNumber>0</ParamNumber>
          <SpnNumber>1</SpnNumber>
          <SpnFloatValue>
            <RawValue>1</RawValue>
            <Value>1</Value>
            <Units>StringValue</Units>
          </SpnFloatValue>
          <SpnStateName>StringValue</SpnStateName>
          <SpnState>1</SpnState>
          <FmiNumber>1</FmiNumber>
          <Type>StringValue</Type>
        </J1939Data>
      </J1939>
    </ExtraDatas>
    <CreatedOn>2024-12-21T12:49:28Z</CreatedOn>
    <Fuel>
      <Value>1</Value>
      <Units>StringValue</Units>
      <ValueInLiters>1</ValueInLiters>
    </Fuel>
    <Buffered>false</Buffered>
    <ProxyId>StringValue</ProxyId>
  </Status>
  <AssetId>1</AssetId>
  <DriverId>1</DriverId>
</IncomingMessage>