Lookup an asset using an external ID

Purpose: Use this API to lookup an asset using its external ID.

📘

NOTE

Ensure that you mention the name of the integration with which the external ID is associated in the query parameters. Refers to the Query Parameter section for more info.

require 'uri'
require 'net/http'

url = URI('https://api.gomotive.com/v1/assets/lookup_by_external_id')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Authorization'] = "Bearer <OAUTH_TOKEN>"

response = http.request(request)
puts response.read_body

Response Parameters

id

• Type: Integer
• Description: The unique identifier for the asset.

name

• Type: String
• Description: The name assigned to the asset.

status

• Type: String
• Description: The current status of the asset (e.g., "active").

type

• Type: String
• Description: The type of asset, such as "low_boy".

custom_type

• Type: String
• Description: Custom type of the asset, if applicable. Default is null.

vin

• Type: String
• Description: Vehicle Identification Number (VIN) of the asset. Default is null.

license_plate_state

• Type: String
• Description: The state where the asset’s license plate is registered. Default is null.

license_plate_number

• Type: String
• Description: The license plate number of the asset. Default is null.

make

• Type: String
• Description: The manufacturer of the asset.

model

• Type: String
• Description: The model of the asset.

year

• Type: String
• Description: The year the asset was manufactured.

axle

• Type: Integer
• Description: Number of axles on the asset. Default is null.

weight_metric_units

• Type: Boolean
• Description: Indicates whether the asset’s weight is measured in metric units.

length_metric_units

• Type: Boolean
• Description: Indicates whether the asset’s length is measured in metric units.

leased

• Type: Boolean
• Description: Indicates whether the asset is leased. Default is null.

notes

• Type: String
• Description: Additional notes or information about the asset. Default is null.

length

• Type: Float
• Description: The length of the asset. Default is null.

gvwr

• Type: Float
• Description: Gross Vehicle Weight Rating (GVWR) of the asset. Default is null.

gawr

• Type: Float
• Description: Gross Axle Weight Rating (GAWR) of the asset. Default is null.

asset_gateway.id

• Type: Integer
• Description: The unique identifier for the asset's gateway device.

asset_gateway.identifier

• Type: String
• Description: The identifier of the asset's gateway device.

asset_gateway.active

• Type: Boolean
• Description: Indicates whether the asset's gateway device is active.

external_ids

• Type: Array
• Description: An array containing external identifiers associated with the asset. Default is an empty array.

integration_name

• Type: String
• Description: The name of the integration with which the external Id is associated.