Enroll an asset for tracking.
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., <pre>{ "webhookName": "KBX001", "equipmentIdentifier": {"type": "RAIL_CAR_ID", "value": "ABCD1234567"}, "expirationDateTime": "2019-05-01T00:00:00-05:00" } </pre> OR <pre><AssetTrackingSubscription> <webhookName>KBX001</webhookName> <equipmentIdentifier> <type>RAIL_CAR_ID</type> <value>ABCD1234567</value> </equipmentIdentifier> <expirationDateTime>2019-05-01T00:00:00-05:00</expirationDateTime> </AssetTrackingSubscription> </pre> <br/> <p>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.</p> <br/> <b>Required Fields</b>
<ul> <li>equipmentIdentifier: The type of asset (either CONTAINER_ID, RAIL_CAR_ID, or TRAILER_ID) and unique identifier, e.g., BNSF654321.</li> <li>webhookName: The id of the previously registered webhook. This indicates where to send the asset tracking information..</li> </ul> <b>Optional Field</b> <ul> <li>expirationDateTime: Optional parameter to indicate when to stop tracking the asset. If not provided, expiration will default to six months from the enrollment date. The format is a date-time string with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2020-05-01T00:00:00-05:00.</li> </ul>Request
- Base URLhttps://na12.api.project44.com
- AuthOAuth 2Client credentialsToken URL/api/v4/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.