Retrieve a device by externalDeviceId

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

Request
Security:
path Parameters
externalSystemId
required
string

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

externalDeviceId
required
string

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

Responses
200

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

400

Bad Request: You will receive this status, when the data you’ve delivered is not in the correct format. You will see an entity describing what went wrong.

401

Unauthorized: Whenever you will get this status, you have either provided the wrong credentials or none at all. Check if you bearer token has not expired.

403

Forbidden: You will receive this status, when you successfully supplied credentials, but your username does not have the necessary permissions for the resource.

404

Not Found: Whenever you will get a 404, you are probably using a malformed or incorrect URL.

get/external-system/{externalSystemId}/external-device/{externalDeviceId}
Request samples
import requests

external_system_id = "YOUR_externalSystemId_PARAMETER"
external_device_id = "YOUR_externalDeviceId_PARAMETER"
url = "https://tracking-device-api.services.simacan.com/api/public/v2/external-system/" + external_system_id + "/external-device/" + external_device_id

headers = {"Authorization": "Bearer <YOUR_JWT_HERE>"}

response = requests.get(url, headers=headers)

data = response.json()
print(data)
Response samples
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": {
    }
}