GET processed vehicle batch.

caution

Vehicle VIN and plate must not have hyphens, spaces, special characters, or lowercase letters in any request. They must be in uppercase.

This endpoint retrieves the processing results for various vehicles. The response provides collection a scraped object.

Request

HTTP request

GET https://api-sync-resser.azurewebsites.net/api/batch/scraping/

Parameters

This particular request does not utilize any query parameters in its execution.

Request body

Provide a object like the below

{
    "vehicles":[
        {
            "vin": string,
            "plate": string
        }
    ]
    
}

• You must specify at least one vehicle.
• The maximum number of vehicles that can be requested in one request is 500.

Response

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

{
    "vehicleData":[
        {
            "vin": string,
            "plate": string,
            "info": [
                {
                    "_id": string,
                    "plate": string,
                    "vin": string,
                    "resourceId": int,
                    "status": Status,
                    "result": Result[],
                    "creationDateTime": Date,
                    "finishedDateTime": Date
                }
            ]
        }
    ]
    
}

Properties	Type	Description
vin	string	Vehicle VIN.
plate	string	Vehicle plate.
info._id	string	Identifier generated by 'resourceId-vin-plate'.
info.plate	string	Vehicle VIN.
info.vin	string	Vehicle plate.
info.resourceId	number	The ID that Sync uses to identify the resource.
info.status	Status	Sync Status.
info.result	Result	Array of results. It contains information about the fines, owner taxes, etc.
info.creationDateTime	Date	Date and time the vehicle was submitted for processing.
info.finishedDateTime	Date	Date and time when the vehicle processing was completed.

info

If the vehicle plate and/or VIN are not correct but they are valid or they have never been proccesed before, the API will return nothing for that vehicle. This endpoint will just return the results where the vehicle was proccesed before.

For example, if a vehicle is processed in "Multas Jalisco" (Jalisco fines), then the endpoint response for that vehicle will be just the result of the proccesed vehicle in "Multas Jalisco".

note

If the response for a vehicle in a certain resource exists but there is no status, it is because the vehicle was processed with errors.

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	- You must specify at least one vehicle. - Vehicle list was not provided or might be misspelled.
badRequest (400)	BadParameters	VIN and/or plate is not valid.
unauthorize (401)	Unauthorize	The requester is not allowed to use this request.