Live Unit Lookup (Asset Pull)
The Record360 mobile application supports integrating with external systems to search and retrieve customer-specific Unit information and incorporate it into the Inspection. Developers can provide a simple API to allow importing of real-time data from their systems into the Record360 system at the time of inspection.
While a user starts a Record360 inspection, the R360 server will make a request to the business' or their system's API to search inventory and retrieve unit details.
Many of our software partners support Live Unit Lookups as part of the native integration between them and Record360. In those cases, we have already done the heavy lifting, so no extra development is required!
Partner support
- HBS Systems
- Procede
- Softbase
If you are interested in becoming a software partner, please reach out to us!
Features
Autocomplete Search
When a user starts an inspection, Record360 will search inventory in your system as the user types a Reference Number in the mobile app. Search results will display in the dropdown, to be selected by the user.
Unit Data
When a user selects a unit, Record360 will retrieve unit details from your system and map them into the inspection checklists or forms and onto the unit itself.
Configuration
The autocomplete and data features can be independently enabled by Record360, allowing you to choose which features fit best. For example, if corresponding ids or unit search are not needed, we can configure the unit data method only using the reference number typed by the user.
Endpoints may be configured with any path, query, or header parameters needed by the API (e.g., for authentication), so long as it accepts the search and ID variables as described below. The HTTP method and any authentication details must be provided.
Once you have built the API features required, send the details to your Record360 contact, and we will configure the Live Unit Lookup for your company. You will need to provide:
- API documentation — the url and methods required for each feature. For unit data, please describe which fields are provided, and if applicable, how they should map to your checklists, forms, or units.
- API credentials – any required header parameters for authorization
Partner?
For software partners using Live Unit Lookup, we will work with you and our mutual customers in order to onboard and configure each integration.
Autocomplete Search
When the user first begins an inspection, they are prompted to type a Reference Number. After typing two characters, a GET
request is made to the API endpoint specified in the Live Unit Lookup (LUL) configuration to search the external system and display autocomplete results to the user. The only variable to this endpoint is the partial Reference Number string passed as search (examples: 1HT, A1-, B001-5). The response should be in JSON format and include a results object which maps potential Reference Number strings to opaque identifiers in the external system.
# An example of an autocomplete endpoint, {SEARCH} being the value typed by the user.
curl -X GET "https://api.your-system.com/v1/units/autocomplete/{SEARCH}" \
-H "Content-Type: application/json"
# The combination of a request and the expected response format.
# Request from Record360
curl -X GET "https://api.your-system.com/v1/units/autocomplete/1HT?password=1234" \
-H "Content-Type: application/json"
# Expected Response, formatted as key: value.
# Key being what the user sees in the dropdown, and value being the id for data lookup id.
{
"results": {
"1HT-A": 3071507,
"1HT-B": 2335180,
"1HT-C": 2462413
}
}
Unit Details Data
Once a unit is selected by the user, we can make an additional API call to your system to get details about the unit. This request takes the unit ID parameter received during the autocomplete call, e.g., 3071507
from the example response above.
# An example of an unit data endpoint,
#{ID} being either the reference number typed by the user or the lookup id provided through autocomplete.
curl -X GET "https://api.your-system.com/v1/units/{ID}" \
-H "Content-Type: application/json"
# Request from Record360
curl -X GET "https://api.your-system.com/v1/units/3071507?password=1234" \
-H "Content-Type: application/json"
# Expected response with sample fields (we can support many different fields).
{
"model": "RS26",
"make": "CONDUX",
"serial_number": "AR113452015",
"description": "3\" RS26 ARBOR BARS",
"equip_number": "105"
}
Recommended fields
We generally recommended providing these fields, as applicable or available. Some integrations provide additional data that may be specific to your forms, system, or use case, such as rental agreement or service order data.
Field | Description | Example |
---|---|---|
equipment_number | Any sort of business system identifier or stock number that is not assigned from the manufacturer. These are often used as reference numbers. | EX1234 |
year | The unit's production year, as described by the manufacturer. | 2024 |
make | The unit's make, brand, or manufacturer. | Ford |
model | The model designation from the make. | Transit |
color | The color of the vehicle. | white |
serial_number | The unit's serial number from the manufacturer. Often used as reference number. | 24124 |
vin | The unit's vehicle identification number — a standardized 17 digit identifier that encodes vehicle information and serial number. Often used as reference number. | 1FTGF26N0K0014931 |
license_plate_number | For on-highway vehicles, the license plate number | AZD456 |
hours | The most recent value for the units hour meter, if applicable. Updating meter values is only recommended if the sending on a frequent basis. | 9000 |
odometer | The most recent odometer value for the unit, if applicable. Updating meter values is only recommended if the sending on a frequent basis. | 16000 |
Updated 7 days ago