GET processed vehicles by criteria

This endpoint retrieves vehicles processed for a given criteria and returns a collection of vehicle results along with the resources from which those vehicles were obtained.

caution

This endpoint is intended for criteria that do not use VIN or plate (e.g., tax identifier) and may return multiple vehicles for a single criteria.

Some resources processed with these criteria might not provide both VIN and plate. Therefore, this endpoint returns all vehicles obtained for the given criteria across the relevant resources that have been processed.

Using the endpoints that query by VIN or plate may fail for some of these resources because they sometimes lack a VIN or plate. For such resources, the search flow is as follows: first by VIN and plate, then by VIN only, then by plate only. If no results are found, the vehicle is returned as unprocessed for that resource.

Request

HTTP request

GET https://api-sync-resser.azurewebsites.net/api/scrapingCriteria

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Filters

Properties	Type	Required	Description
criteria	string	Yes	The criteria to be used to query the vehicles.
criteriaTypeId	number	No	The criteria type identifier to be used. Must be provided with criteria or resourceId.
resourceId	number	No	The resource identifier to be used. Must be provided with criteria or criteriaTypeId.

caution

criteria is required, and you must provide either criteriaTypeId, resourceId, or both.

Request body

This request does not require a request body during its execution, so please refrain from providing one when calling this method.

Response

If successful, this method returns a collection in the response body with the following structure:

{
    "scrapedResources":[
        {
            "resource": Resource,
            "scraped": Scraped[]
        }
    ]
}

Properties	Type	Description
resource	Resource	Sync resource.
scraped	Scraped[]	A collection of the results of the vehicles processed for the resource.

Errors

The following table provides a list of potential error messages that the API may return in response to a call to this method. For more detailed information, please refer to the error message documentation.

Error type	Error detail	Description
badRequest (400)	BadRequest	The criteria, criteriaTypeId or resourceId is not valid.
unauthorize (401)	Unauthorize	The requester is not allowed to use this request.