Last updated

Asset Tracking

Enroll an Asset for Tracking

Enroll an asset for tracking endpoint to start permanent tracking of all trips that happen until the asset is unsubscribed.

Requirements

You must have an endpoint configured to receive the asset location data prior to enrolling the asset. Information about the location of the asset will be pushed until the asset is un-enrolled from tracking. Find example payloads in the API Reference documentation.

  • Equipment identifier (CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID)
  • Webhook identifier

Workflow

  1. Prepare a POST request to /api/v4/assets/tracking.
{
  "equipmentIdentifier": {
    "type": "CONTAINER_ID",
    "value": "string"
  },
  "webhookName": "string"
}

This only shows the minimum required request schema to create a rail shipment. To view the full request schema, see the API Reference documentation for this endpoint.

  1. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
equipmentIdentifierA list of the shipment's identifying information.array of identifiers
equipmentIdentifier.typeThe type of shipment identifier.stringValid values include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID.
equipmentIdentifier.valueThe value of the shipment identifier.string
webhookNameThe ID of the registered webhook.stringThis is where the asset tracking information will be sent.

Expected System Response

You have successfully enrolled the asset when you receive a 200 OK response.

Errors

If there was a problem with your request, you will receive one of the following error codes

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Unenroll an Assset

Unenroll an asset from tracking endpoint to stop tracking on a shipment. Information about the location of the asset will no longer be pushed.

Requirements

  • Equipment identifier (CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID)

Workflow

  1. Prepare a DELETE request to /api/v4/assets/tracking and include the equipment identifier information.
  2. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
equipmentIdentifierA list of the shipment's identifying information.array of identifiers
equipmentIdentifier.typeThe type of shipment identifier.stringValid values include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID.
equipmentIdentifier.valueThe value of the shipment identifier.string

Expected System Response

You have successfully unenrolled the asset when you receive a 200 OK response.

Errors

If there was a problem with your request, you will receive one of the following error codes

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Previous page
Next page