Skip to content

BEAM Trackr PRO – API Gateway

Please Note: This document is currently in-progress following a major platform update. Please contact our Support Team if you need any information that is not currently here, or have a particular request you would like to have added to the Gateway.

Authentication #

To access the API, you will need an API key which must be included in every request to the API Gateway. The key is a UUID (universally unique identifier) which we issue to you, and will look something like this:

001913e3-9376-11ee-b3bc-0242ac160002

To authenticate your request, you will need to include this in an HTTP header called “x-api-key”, e.g:

x-api-key: 001913e3-9376-11ee-b3bc-0242ac160002

API Functions #

The base URL for the API is:
https://api.trackrspace.net/trackrpro

The following end-points are then appended to the base URL, e.g:

https://api.trackrspace.net/trackrpro/v1/Asset/GetAllAssets

Assets #

Get All Assets #

Purpose:Returns all the Assets set up in your account.
End-Point:/v1/Asset/GetAllAssets
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{ }

Example Response:

{
    "Asset": [
        {
            "AssetId": "RGinPw==",
            "Name": "BUS-794",
            "Status": true,
            "TrackerType": 3
        },

        {
            "AssetId": "RGinRw==",
            "Name": "OTG-TAT100",
            "Status": true,
            "TrackerType": 2
        }
    ]
}

Get All Assets Extended #

Purpose:Returns all the Assets set up in your account, with all of the extended data fields.
End-Point:/v1/Asset/GetAllAssetsWithExtraDetails
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{ }

Example Response:

{
    "Asset": [{
            "Name": "kba 456rd",
            "Colour": "",
            "Make": "",
            "Model": "",
            "TrackerType": 0,
            "Status": true,
            "CustomId": "23232",
            "OwnerId": "10000",
            "asset_owner_name": "tonnie",
            "asset_owner_phone_number": "dfdfd",
            "asset_reg_number": "kba 456rd",
            "asset_chasis_number": "chasis_no",
            "asset_fuel_type": "petrol",
            "asset_engine_size": "100",
            "fitting_company_name": "fitting_company_name",
            "fitting_company_phone_number": "fitting_company_phon",
            "fitting_company_email_address": "fitting_company_email",
            "fitting_company_no": "fitting_company_reg_no",
            "fitting_date": "2020-01-01T00:00:00",
            "fitting_location": "fitting_location",
            "fitting_certificate_number": "fitting_certificate_no",
            "fitter_name": "fitter_name",
            "fitter_id": "fitter_national_id",
            "fitter_phone_number": "fitter_phone_no",
            "owner_gender": "female",
            "year": 2010,
            "engine_no": "engine_no",
            "vin": "",
            "no_of_tyres": 0,
            "tyre_size": "",
            "cargo_capacity": "category",
            "asset_type": "",
            "no_of_pessengers": 10,
            "fuel_type": "petrol",
            "fuel_grade": "fuel_grade",
            "tank_capacity": 0.0,
            "fuel_consumption": 0.4,
            "insurance_policy_no": "insurance_policy_no",
            "insurance_expiry_date": "2020-01-01T00:00:00",
            "insurance_policy_no_two": "insurance_policy_no_two",
            "insurance_expiry_date_two": "2020-01-01T00:00:00",
            "purchase_date": "2020-01-01T00:00:00",
            "purchase_notes": " ",
            "selling_date": "2020-01-01T00:00:00",
            "selling_notes": "",
            "license_renewal_date": "2020-01-01T00:00:00",
            "co2_emmission_per_km": 30.0
        }
    ]
}

Get Asset #

Purpose:Returns a specified Asset.
End-Point:/v1/Asset/GetOneAsset
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{
"AssetId": "string"
}

Example Response:

{
    "Asset": [
        {
            "AssetId": "string",
            "Name": "string",
            "Colour": "string",
            "Make": "string",
            "Model": "string",
            "TrackerType": <number>,
            "Status": <boolean>
        }
    ]
}

Get Asset Extended #

Purpose:Returns a specified Asset with additional fields that have been set.
End-Point:/v1/Asset/GetOneAssetWithExtraDetails
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{
"AssetId": "string"
}

Example Response:

{
    "Asset": [{
            "Name": "kba 456rd",
            "Colour": "",
            "Make": "",
            "Model": "",
            "TrackerType": 0,
            "Status": true,
            "CustomId": "23232",
            "OwnerId": "10000",
            "asset_owner_name": "tonnie",
            "asset_owner_phone_number": "dfdfd",
            "asset_reg_number": "kba 456rd",
            "asset_chasis_number": "chasis_no",
            "asset_fuel_type": "petrol",
            "asset_engine_size": "100",
            "fitting_company_name": "fitting_company_name",
            "fitting_company_phone_number": "fitting_company_phon",
            "fitting_company_email_address": "fitting_company_email",
            "fitting_company_no": "fitting_company_reg_no",
            "fitting_date": "2020-01-01T00:00:00",
            "fitting_location": "fitting_location",
            "fitting_certificate_number": "fitting_certificate_no",
            "fitter_name": "fitter_name",
            "fitter_id": "fitter_national_id",
            "fitter_phone_number": "fitter_phone_no",
            "owner_gender": "female",
            "year": 2010,
            "engine_no": "engine_no",
            "vin": "",
            "no_of_tyres": 0,
            "tyre_size": "",
            "cargo_capacity": "category",
            "asset_type": "",
            "no_of_pessengers": 10,
            "fuel_type": "petrol",
            "fuel_grade": "fuel_grade",
            "tank_capacity": 0.0,
            "fuel_consumption": 0.4,
            "insurance_policy_no": "insurance_policy_no",
            "insurance_expiry_date": "2020-01-01T00:00:00",
            "insurance_policy_no_two": "insurance_policy_no_two",
            "insurance_expiry_date_two": "2020-01-01T00:00:00",
            "purchase_date": "2020-01-01T00:00:00",
            "purchase_notes": " ",
            "selling_date": "2020-01-01T00:00:00",
            "selling_notes": "",
            "license_renewal_date": "2020-01-01T00:00:00",
            "co2_emmission_per_km": 30.0
        }
    ]
}

Devices #

Get All Devices #

Purpose:Returns all the Devices set up in your account.
End-Point:/v1/Asset/GetAllDevice
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{ }

Example Response:

{
    "Asset": [
        {
            "AssignedAssetId": "RGinPg==",
            "DeviceId": "RGhvfA==",
            "DeviceTypeId": 48,
            "ImeiNumber": 865546047314709
        },
        {
            "AssignedAssetId": "RGinPw==",
            "DeviceId": "RGhvfQ==",
            "DeviceTypeId": 48,
            "ImeiNumber": 865546047709353
        },
        {
            "AssignedAssetId": "RGinRQ==",
            "DeviceId": "RGhvgw==",
            "DeviceTypeId": 9189,
            "ImeiNumber": 868159051607906
        },
        {
            "AssignedAssetId": "RGinRw==",
            "DeviceId": "RGhvhQ==",
            "DeviceTypeId": 9207,
            "ImeiNumber": 357073298949526
        }
    ]
}

Get One Device #

Purpose:Returns a specified Device within your account.
End-Point:/v1/Asset/GetOneDevice
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{
    "DeviceId": "RGhvfA=="
}

Example Response:

{
    "Asset": [
        {
            "AssignedAssetId": "RGinPg==",
            "AssignedSimcardId": "RGdOlw==",
            "DeviceId": "RGhvfA==",
            "DeviceTypeId": 48,
            "ImeiNumber": 865546047314709
        }
    ]
}

Device Current Data #

Purpose:Return the current data held for all the devices in your account, or specified group. Data includes last record location and telematics data.
End-Point:/v1/Asset/GetDevicesCurrentData
Method:POST
Headers:Content-Type: application/json
x-api-key: <your-api-key>
Body:{
    "GroupId": "string" // Optional parameter
}

Example Response:

{
    "Data": [
        {
            "Altitude": "26",
            "Battery": 0,
            "DeviceName": "BUS-791",
            "EventName": "Position Report",
            "GPSDateTime": "2023-12-05T13:16:20",
            "Heading": 281,
            "ImeiNumber": 865546047314709,
            "IsIgnitionOn": "False",
            "Lat": "51.499213",
            "Location": "Buckingham Gate, Victoria, City of Westminster England ",
            "Lon": "-0.138033",
            "Odometer": 0,
            "RoadSpeed": 32,
            "SensorData": "",
            "VehicleSpeed": 14
        },
        {
            "Altitude": "17",
            "Battery": 0,
            "DeviceName": "BUS-794",
            "EventName": "Position Report",
            "GPSDateTime": "2023-10-06T11:19:44",
            "Heading": 180,
            "ImeiNumber": 865546047709353,
            "IsIgnitionOn": "False",
            "Lat": "51.463069",
            "Location": "Battersea, London England ",
            "Lon": "-0.188323",
            "Odometer": 0,
            "RoadSpeed": 0,
            "SensorData": "",
            "VehicleSpeed": 0
        },
        {
            "Altitude": "0",
            "Battery": 0,
            "DeviceName": "OTG-TAT100",
            "EventName": "Position Report",
            "GPSDateTime": "2000-01-01T00:00:00",
            "Heading": 0,
            "ImeiNumber": 357073298949526,
            "IsIgnitionOn": "False",
            "Lat": "0.0000",
            "Location": "Not Connected",
            "Lon": "0.0000",
            "Odometer": 0,
            "RoadSpeed": 0,
            "VehicleSpeed": 0
        },
        {
            "Altitude": "91",
            "Battery": 0,
            "DeviceName": "ROUTER",
            "EventName": "Position Report",
            "GPSDateTime": "2023-09-16T11:51:01",
            "Heading": 0,
            "ImeiNumber": 868159051607906,
            "IsIgnitionOn": "False",
            "Lat": "51.103463",
            "Location": "Portway Office",
            "Lon": "-1.779802",
            "Odometer": 0,
            "RoadSpeed": 0,
            "SensorData": "{"An1r":"0"}",
            "VehicleSpeed": 0
        }
    ]
}

Powered by BetterDocs

Shopping cart

SAVE

10%

It only takes a few seconds

DON'T MISS OUT

SUBSCRIBE AND SAVE 10%

GET EXCLUSIVE OFFERS AND THE LATEST PRODUCT NEWS.

WE WILL GIVE YOU A 10% OFF VOUCHER CODE FOR YOUR NEXT ORDER AS A THANK YOU!

Website-Subscription-Opt-in