Last updated

Get List of Assets for a Given Carrier

Get all assets for a carrier that are known by project44. Use this endpoint if you do not know the carrier's equipment identifiers. This information is necessary to create a shipment.

Requirements

Have the following information:

  • Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU).

Workflow

Complete the following steps:

  1. Prepare a GET request to /api/v4/tl/assets and include the carrier identifier.
  2. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
carrierIdentifier.typeThe type of carrier identifier.stringValid values are SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU.
carrierIdentifier.valueThe value of the carrier identifier.string

Expected System Response

The request is successfully submitted and confirmed when a 200 OK response is received. For example,

{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    {
      "type": "MOBILE_PHONE_NUMBER",
      "value": "string",
      "shouldDelete": false
    }
  ],
  "infoMessages": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ]
}

Fields and Objects

ElementDescriptionTypeNotes
results.typeThe type of equipment identifier.stringValid values are MOBILE_PHONE_NUMBER, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID.
results.valueThe value of the equipment identifier.stringCell phone numbers will be obfuscated in project44 responses for privacy reasons.

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