Skip to main content

CriteriaType

A CriteriaType object represents the different types of criteria available in Sync. Each criteria type determines what input data (e.g., plate, VIN, tax identifier) is required to query vehicle information. Some criteria return a single vehicle (e.g., plate or VIN), while others return multiple vehicles (e.g., tax identifier).

Methods

The API supports the following methods for CriteriaType objects:

HTTP requestDescription
GET criteria typesReturns a collection with all available criteria types in Sync.

Object representation

{
"criteriaTypeId": 1,
"key": "Vehicle",
"description": "Plate and/or VIN",
"descriptionSpanish": "Placa y/o VIN"
}

Properties

The following table defines the properties that appear in this object:

PropertiesTypeDescription
criteriaTypeIdnumberUnique ID used by Sync to identify the criteria type.
keystringString identifier of the criteria type.
descriptionstringCriteria type description in English.
descriptionSpanishstringCriteria type description in Spanish.

Available criteria types

Criteria TypeCriteria Type IDDescription
Vehicle1Plate and/or VIN.
Tax Identifier2Tax Identifier.