Skip to content

Tracking Device API (2.0)

The Tracking Device API is a unified interface to post or request information about tracking devices. Usually a tracking device is a vehicle, which needs to be registered to our platform before you can feed GPS data to other endpoints.

Make sure you request the Auth API first

Download OpenAPI description
trackingdevice.json
trackingdevice.yaml
Overview
Languages
Servers
Mock server
https://developer.simacan.com/_mock/openapi/device/trackingdevice/
Production Environment
https://tracking-device-api.services.simacan.com/api/public/v2/
Staging Environment
https://tracking-device-api-stg.services.simacan.com/api/public/v2/

Register or update a tracking device

Request

Registers a new or updates an existing tracking device depending if the device is already known. A device is defined by a unique combination of the externalSystemId and the externalDeviceId. So registering an already existing device will update all the attributes except the DeviceUUID

Security
BearerAuth
Bodyapplication/jsonrequired

Tracking Device that needs to be added to the service

externalDeviceIdstringrequired

The identifier you use to recognize the device/vehicle in your source system

externalSystemIdstringrequired

Identifier for the source system we use to uniquely recognize the shipper/carrier

activebooleanrequired

Indicates whether the current tracking device is active or not

Default true
carrierCodestringrequired

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

customerDeviceIdstringrequired
licensePlatestring

License Plate linked with the current tracking device

driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

curl -i -X POST \
  https://developer.simacan.com/_mock/openapi/device/trackingdevice/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalDeviceId": "string",
    "externalSystemId": "string",
    "active": true,
    "carrierCode": "string",
    "customerDeviceId": "string",
    "licensePlate": "string",
    "driverName": "string",
    "attributes": {}
  }'

Responses

Indicates that your request was successful. You will see an entity describing or containing the result of your action

Bodyapplication/json
deviceUUIDstring

This is the Simacan generated universally unique identifier

Example: "b9ed42ff-3ffb-4418-9498-5eb0ba308899"
externalSystemIdstring

Identifier for the source system we use to uniquely recognize the shipper/carrier

Example: "fms-janszoon_transport"
externalDeviceIdstring

The identifier you use to recognize the device/vehicle in your source system

Example: "1234"
customerDeviceIdstring
activeboolean

Indicates whether the current tracking device is active or not

Example: "true"
relationstring
Example: "janszoon_transport"
carrierCodestring

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

creationDatestring

Timestamp when record was created

Example: "2020-06-07T09:17:43Z"
lastUpdatedDatestring

Timestamp when record was updated

licensePlatestring

License Plate linked with the current tracking device

Example: "AB-12-CD"
driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

Example: {"carBrand":"Mercedes"}
Response
application/json
{
  "deviceUUID": "b9ed42ff-3ffb-4418-9498-5eb0ba308899",
  "externalSystemId": "fms-janszoon_transport",
  "externalDeviceId": "1234",
  "customerDeviceId": "string",
  "active": "true",
  "relation": "janszoon_transport",
  "carrierCode": "string",
  "creationDate": "2020-06-07T09:17:43Z",
  "lastUpdatedDate": "string",
  "licensePlate": "AB-12-CD",
  "driverName": "string",
  "attributes": {
    "carBrand": "Mercedes"
  }
}

Register or update a tracking device

Request

Registers a new or updates an existing tracking device depending if the device is already known. A device is defined by a unique combination of the externalSystemId and the externalDeviceId. So registering an already existing device will update all the attributes except the DeviceUUID

Security
BearerAuth
Bodyapplication/jsonrequired

Tracking Device that needs to be added to the service

externalDeviceIdstringrequired

The identifier you use to recognize the device/vehicle in your source system

externalSystemIdstringrequired

Identifier for the source system we use to uniquely recognize the shipper/carrier

activebooleanrequired

Indicates whether the current tracking device is active or not

Default true
carrierCodestringrequired

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

customerDeviceIdstringrequired
licensePlatestring

License Plate linked with the current tracking device

driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

curl -i -X PUT \
  https://developer.simacan.com/_mock/openapi/device/trackingdevice/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalDeviceId": "string",
    "externalSystemId": "string",
    "active": true,
    "carrierCode": "string",
    "customerDeviceId": "string",
    "licensePlate": "string",
    "driverName": "string",
    "attributes": {}
  }'

Responses

Indicates that your request was successful. You will see an entity describing or containing the result of your action

Bodyapplication/json
deviceUUIDstring

This is the Simacan generated universally unique identifier

Example: "b9ed42ff-3ffb-4418-9498-5eb0ba308899"
externalSystemIdstring

Identifier for the source system we use to uniquely recognize the shipper/carrier

Example: "fms-janszoon_transport"
externalDeviceIdstring

The identifier you use to recognize the device/vehicle in your source system

Example: "1234"
customerDeviceIdstring
activeboolean

Indicates whether the current tracking device is active or not

Example: "true"
relationstring
Example: "janszoon_transport"
carrierCodestring

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

creationDatestring

Timestamp when record was created

Example: "2020-06-07T09:17:43Z"
lastUpdatedDatestring

Timestamp when record was updated

licensePlatestring

License Plate linked with the current tracking device

Example: "AB-12-CD"
driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

Example: {"carBrand":"Mercedes"}
Response
application/json
{
  "deviceUUID": "b9ed42ff-3ffb-4418-9498-5eb0ba308899",
  "externalSystemId": "fms-janszoon_transport",
  "externalDeviceId": "1234",
  "customerDeviceId": "string",
  "active": "true",
  "relation": "janszoon_transport",
  "carrierCode": "string",
  "creationDate": "2020-06-07T09:17:43Z",
  "lastUpdatedDate": "string",
  "licensePlate": "AB-12-CD",
  "driverName": "string",
  "attributes": {
    "carBrand": "Mercedes"
  }
}

Retrieve all devices

Request

Retrieves all devices of the associated carriers of the authenticated account.

Security
BearerAuth
curl -i -X GET \
  https://developer.simacan.com/_mock/openapi/device/trackingdevice/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Indicates that your request was successful. You will see an entity describing or containing the result of your action

Bodyapplication/json
deviceUUIDstring

This is the Simacan generated universally unique identifier

Example: "b9ed42ff-3ffb-4418-9498-5eb0ba308899"
externalSystemIdstring

Identifier for the source system we use to uniquely recognize the shipper/carrier

Example: "fms-janszoon_transport"
externalDeviceIdstring

The identifier you use to recognize the device/vehicle in your source system

Example: "1234"
customerDeviceIdstring
activeboolean

Indicates whether the current tracking device is active or not

Example: "true"
relationstring
Example: "janszoon_transport"
carrierCodestring

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

creationDatestring

Timestamp when record was created

Example: "2020-06-07T09:17:43Z"
lastUpdatedDatestring

Timestamp when record was updated

licensePlatestring

License Plate linked with the current tracking device

Example: "AB-12-CD"
driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

Example: {"carBrand":"Mercedes"}
Response
application/json
{
  "deviceUUID": "b9ed42ff-3ffb-4418-9498-5eb0ba308899",
  "externalSystemId": "fms-janszoon_transport",
  "externalDeviceId": "1234",
  "customerDeviceId": "string",
  "active": "true",
  "relation": "janszoon_transport",
  "carrierCode": "string",
  "creationDate": "2020-06-07T09:17:43Z",
  "lastUpdatedDate": "string",
  "licensePlate": "AB-12-CD",
  "driverName": "string",
  "attributes": {
    "carBrand": "Mercedes"
  }
}

Retrieve a device by externalDeviceId

Request

Retrieves a single device of the associated carrier of the authenticated account, based on the externalDeviceId

Security
BearerAuth
Path
externalSystemIdstringrequired

Identifier for the source system we use to uniquely recognize the shipper/carrier

externalDeviceIdstringrequired

The identifier you use to recognize the device/vehicle in your source system

curl -i -X GET \
  'https://developer.simacan.com/_mock/openapi/device/trackingdevice/external-system/{externalSystemId}/external-device/{externalDeviceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Indicates that your request was successful. You will see an entity describing or containing the result of your action

Bodyapplication/json
deviceUUIDstring

This is the Simacan generated universally unique identifier

Example: "b9ed42ff-3ffb-4418-9498-5eb0ba308899"
externalSystemIdstring

Identifier for the source system we use to uniquely recognize the shipper/carrier

Example: "fms-janszoon_transport"
externalDeviceIdstring

The identifier you use to recognize the device/vehicle in your source system

Example: "1234"
customerDeviceIdstring
activeboolean

Indicates whether the current tracking device is active or not

Example: "true"
relationstring
Example: "janszoon_transport"
carrierCodestring

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

creationDatestring

Timestamp when record was created

Example: "2020-06-07T09:17:43Z"
lastUpdatedDatestring

Timestamp when record was updated

licensePlatestring

License Plate linked with the current tracking device

Example: "AB-12-CD"
driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

Example: {"carBrand":"Mercedes"}
Response
application/json
{
  "deviceUUID": "b9ed42ff-3ffb-4418-9498-5eb0ba308899",
  "externalSystemId": "fms-janszoon_transport",
  "externalDeviceId": "1234",
  "customerDeviceId": "string",
  "active": "true",
  "relation": "janszoon_transport",
  "carrierCode": "string",
  "creationDate": "2020-06-07T09:17:43Z",
  "lastUpdatedDate": "string",
  "licensePlate": "AB-12-CD",
  "driverName": "string",
  "attributes": {
    "carBrand": "Mercedes"
  }
}

Retrieve device by license plate

Request

Retrieves a single device of the associated carrier of the authenticated account, based on the linked license plate

Security
BearerAuth
Path
externalSystemIdstringrequired

Identifier for the source system we use to uniquely recognize the shipper/carrier

licensePlatestringrequired

License Plate linked for the current tracking device

curl -i -X GET \
  'https://developer.simacan.com/_mock/openapi/device/trackingdevice/external-system/{externalSystemId}/license-plate/{licensePlate}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Indicates that your request was successful. You will see an entity describing or containing the result of your action

Bodyapplication/json
deviceUUIDstring

This is the Simacan generated universally unique identifier

Example: "b9ed42ff-3ffb-4418-9498-5eb0ba308899"
externalSystemIdstring

Identifier for the source system we use to uniquely recognize the shipper/carrier

Example: "fms-janszoon_transport"
externalDeviceIdstring

The identifier you use to recognize the device/vehicle in your source system

Example: "1234"
customerDeviceIdstring
activeboolean

Indicates whether the current tracking device is active or not

Example: "true"
relationstring
Example: "janszoon_transport"
carrierCodestring

This code is used by the Simacan Control Tower to match a Tracking Device with a carrier

creationDatestring

Timestamp when record was created

Example: "2020-06-07T09:17:43Z"
lastUpdatedDatestring

Timestamp when record was updated

licensePlatestring

License Plate linked with the current tracking device

Example: "AB-12-CD"
driverNamestring

Driver name linked with the current tracking device

attributesobject

Any freeform additional attributes

Example: {"carBrand":"Mercedes"}
Response
application/json
{
  "deviceUUID": "b9ed42ff-3ffb-4418-9498-5eb0ba308899",
  "externalSystemId": "fms-janszoon_transport",
  "externalDeviceId": "1234",
  "customerDeviceId": "string",
  "active": "true",
  "relation": "janszoon_transport",
  "carrierCode": "string",
  "creationDate": "2020-06-07T09:17:43Z",
  "lastUpdatedDate": "string",
  "licensePlate": "AB-12-CD",
  "driverName": "string",
  "attributes": {
    "carBrand": "Mercedes"
  }
}