PRproject44
TL: Tracking

Validate equipment identifiers

Use this endpoint to test an equipment identifier to see if it is a valid equipment identifier for the given carrier that may 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.

<table> <thead> <tr> <th>Equipment ID Type</th> <th><code>valid</code></th> <th><code>exists</code></th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td><code>EMERSON_DEVICE_ID</code>, <code>SENSITECH_DEVICE_ID</code>, <code>TIVE_DEVICE_ID</code>, <code>VEHICLE_ID</code></td> <td> <p><strong>True</strong>, if the equipment exists and is considered as active equipment by project44.</p> <p>This equipment is owned by the capacity provider and sent in the query params.</p> <p>Validity depends on the type of vendor. </p> </td> <td> <p><strong>True</strong>, if the equipment exists in the project44 system</p> <p>This equipment is owned by the capacity provider and passed as an argument to the endpoint (see <code>capacityProviderIdentifier.value</code>).</p> </td> <td>The capacity provider identifier passed as an argument to the endpoint must be the owner of the equipment.</td> </tr> <tr> <td><code>LICENSE_PLATE</code></td> <td><strong>True</strong>, if the asset can be used for tracking the shipment by the requester.</td> <td><strong>True</strong>, if the license plate exists in the project44 system.</td> <td>capacity provider identifier should be set to one of identifiers of requesting organisation</td> </tr> <tr> <td><code>MOBILE_PHONE_NUMBER</code></td> <td> <p><strong>True</strong>, if there is a driver who signed up with the given phone number <strong>OR</strong> if there is no driver who signed up with the given phone number but the phone number can be used to create a shipment. (see <code>exists</code> field).</p> </td> <td> <p><strong>True</strong>, if the mobile phone was used in the past to create a shipment.</p> <p><strong>False</strong>, if there is no driver with such phone number in project44 network.</p> </td> <td></td> </tr> </tbody> </table>
get/api/v4/tl/equipment/validate

Request

Query parameters

capacityProviderIdentifier.type'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU' | 'SYSTEM' | 'P44_GLOBAL' | 'VAT'

Capacity provider identifier type.

capacityProviderIdentifier.valuestring

Capacity provider identifier value.

equipmentIdentifier.shouldDeleteboolean

Optional field indicating whether equipment identifier should be deleted.

equipmentIdentifier.type'MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'CONTAINER_ID'

The type of the equipment identifier.

equipmentIdentifier.valuestring

The value of the equipment identifier. Cell phone numbers will be obfuscated in project44 responses for privacy reasons.

Response

OK

existsboolean

True if asset exists in project44 platform. If equipment type is not MOBILE_PHONE_NUMBER and LICENSE_PLATE, capacity provider must be the owner of the equipment, otherwise false.

ownershipStatus'CONNECTED' | 'NOT_CONNECTED' | 'INDETERMINATE' | 'UNKNOWN'

${TruckloadEquipmentValidation.apiModel.ownershipStatus.value}

validboolean

True if the identifier may be used to initiate tracking, otherwise false.

Changes

No recorded changes to this operation across all 1 revision of this API.