Resource

A Resource object represents a resource in Sync. This resource is subject to State and ResourceType objects, and it also indicates a resource that is available in Sync. Each resource corresponds to a specific government portal or website where data such as debts, fines, taxes, and other vehicle-related details can be retrieved for a particular vehicle.

Methods

The API supports the following methods for Resource objects:

HTTP request	Description
GET resources	Returns a collection with all available resources in Sync.

Object representation

{
  "resourceId": number,
  "key": string,
  "description": string,
  "descriptionSpanish": string,
  "authenticationRequired": boolean,
  "resourceType": ResourceType,
  "resouceTypes": ResourceType[],
  "state": State,
  "portalUrl": string,
  "criteriaType": CriteriaType
}

Properties

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

Properties	Type	Description
resourceId	number	The ID that Sync uses to identify the resource.
key	string	The key is another way to identify the resource in Sync.
description	string	Description of the resource.
descriptionSpanish	string	Description of the resource in Spanish.
authenticationRequired	boolean	Indicates if authentication is required for the resource.
resourceType	ResourceType	Indicates the main type of the resource (e.g., tickets/fines).
resourceTypes	ResourceType[]	Lists additional resource types obtained together with the main one (e.g., if the resource also retrieves insurancePolicies in addition to tickets/fines).
state	State	State of the resource.
portalUrl	string	Portal URL where the vehicles sent to the resource are processed.
criteriaType	CriteriaType	Defines the type of criteria used to query a resource. Each criteria type specifies what input data (e.g., plate, VIN, tax identifier) is required to obtain information from that resource.

Available resources

The following table showcases the available countries that have resources in Sync, each with its corresponding country code, country name, and resources link to the resources available in that country.

Table

Country	Country Id	Country Code	Resources
Mexico	1	MX	Mexico resources
Colombia	2	CO	Colombia resources