The Asset Tracking API offers users a way to enroll an asset for tracking, and conversely, to unenroll an asset from tracking. Prior to enrolling an asset, users must have an endpoint configured to receive the asset location data.
Information about the location of the asset will be pushed to the enrollee until the asset is un-enrolled from tracking. The payload can be JSON or XML, e.g.,
{ "webhookName": "KBX001", "equipmentIdentifier": {"type": "RAIL_CAR_ID", "value": "ABCD1234567"}, "expirationDateTime": "2019-05-01T00:00:00-05:00" }OR
<AssetTrackingSubscription> <webhookName>KBX001</webhookName> <equipmentIdentifier> <type>RAIL_CAR_ID</type> <value>ABCD1234567</value> </equipmentIdentifier> <expirationDateTime>2019-05-01T00:00:00-05:00</expirationDateTime> </AssetTrackingSubscription>
The call will return with an HTTP 200 status if enrollment is successful. Otherwise, it will return an appropriate HTTP error status code and error message.
subscription
OK
Invalid request
Invalid or missing credentials
User not authorized to perform this operation
{- "equipmentIdentifier": {
- "type": "CONTAINER_ID",
- "value": "string"
}, - "expirationDateTime": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "webhookName": "string"
}