Last updated

Validate Equipment Identifiers

Determine if an equipment identifier is valid for a given carrier and can be used for tracking. If the carrier's tracking vendor does not support validating equipment identifiers without initiating tracking, then the endpoint will always report that the identifier is valid.

If the carrier's tracking vendor does not support validating equipment identifiers without initiating tracking, then the endpoint will always report that the identifier is valid.

Requirements

Have the following information:

  • Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT or P44_EU).
  • Equipment Identifier (MOBILE_PHONE_NUMBER, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID)

Workflow

Complete the following steps:

  1. Prepare a GET request to /api/v4/tl/equipment/validate and include the carrier and equipment identifiers.
  2. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
capacityProviderIdentifierTypeThe type of capacity provider identifier.stringValid values are SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU.
capacityProviderIdentifierValueThe value of the capacity provider identifier.string
equipmentIdentifier.typeThe type of equipment identifier.stringValid values are MOBILE_PHONE_NUMBER, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID.
equipmentIdentifier.valueThe value of the equipment identifier.string

Expected System Response

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

{
  "exists": true,
  "ownershipStatus": "CONNECTED",
  "valid": true
}

Fields and Objects

ElementDescriptionTypeNotes
existsIndicates if the asset exists in the project44 platform.boolean

true if the asset exists in the project44 platform. Otherwise, false.

If the equipment type is not MOBILE_PHONE_NUMBER or LICENSE_PLATE, the capacity provider must be the owner of the equipment (ownershipStatus is true).

ownershipStatusIndicates if the asset is owned by the capacity provider.stringValid values are CONNECTED, NOT_CONNECTED, INDETERMINATE, or UNKNOWN.
validTrue if the identifier may be used to initiate tracking, otherwise false.boolean

true if the equipment identifier is connected to the project44 platform.

If false, use the Expand Carrier Network workflow to invite the capacity provider to join the project44 platform.

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