Locate an asset

Purpose: Locate My Asset feature allows Fleet Admins and Fleet Managers to get immediate location updates of dispatched assets. You can track the location of the assets that are equipped with Asset Gateway Mini.

The “Locate my asset” endpoint allows on-demand refreshes of the asset location, by sending location request pings to the asset. This ensures the Fleet Manager or the Fleet Admin know the real location of the asset, instead of the last scheduled location update (every 12 hours).

📘

NOTE

This endpoint is meant to be used when there is an urgent requirement of the asset’s location bypassing the regular GPS pings from the Asset Gateway.

Points to remember:

• There is a cool down period between each request for a duration of 15 minutes.
• Only one locate request can be in progress for a given asset at a time; additional attempts within the cooldown window result in an error.
• If you send a second request within the cool down period, you will receive a 429 error with the error message as “Too many requests. Locate request already in progress. Please wait before retrying.”
• A usual Locate My Asset request will take around 5 to 15 minutes to respond.
• Frequent Locate My Asset requests will impact the battery of your Asset Gateway.
• Response from the Asset Gateway is dependent on cellular coverage and ability to get a GPS fix.

Response Parameters

asset_id

• Type: Integer
• Description: Denotes the ID of the asset that you provide in the Path Parameter.

locate_status

• Type: String
• Description: Denotes the status of the location retrieval for the asset.

last_location

• Type: String
• Description: Denotes the retrieved location of the asset from the Asset Gateway. This will include the latitude and longitude of the asset along with the timestamp when the info was received.

message

• Type: String
• Description: Denotes the message that you will receive from the Asset Gateway. This will only appear when the locate_status is “in_progress.”