Get details about the insurance of vehicle by country code, license plate number and insurance id

GET

https://api.company-server/v1/vehicles/{countryCode}/{plateNumber}/insurances/{insuranceId}/

Vehicle

Request

Path Params

countryCode

string

required

Country code of the vehicle's registration.

Match pattern:

^[A-Z]{2,4}$

plateNumber

string

required

License plate number of the vehicle.

Match pattern:

^[\s\S]{1,20}$

insuranceId

integer <int64>

required

Insurance ID of the vehicle.

Responses

🟢200OK

application/json

Insurance data retrieved successfully

Body

Details of the insurance.

integer <int64>

required

Unique identifier for the insurance of the vehicle.

>= 1

Example:

123456789

name

string

required

Name of the insurance company.

Example:

AB Insurance

Match pattern:

^[\s\S]{1,20}$

number

string

required

Insurance policy number.

Example:

KST-123456789

Match pattern:

^[\s\S]{1,20}$

isInsured

boolean

required

Indicates whether the vehicle is insured.

Example:

true

activationDate

string <date>

required

Date when the vehicle insurance became active.

Example:

2023-01-15

Match pattern:

^\d{4}-\d{2}-\d{2}$

expirationDate

string <date>

required

Expiration date of the vehicle insurance.

Example:

2024-01-14

Match pattern:

^\d{4}-\d{2}-\d{2}$

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

Additional properties

integer | number | string | boolean

optional

Example

{
    "id": 123456789,
    "name": "AB Insurance",
    "number": "KST-123456789",
    "isInsured": true,
    "activationDate": "2023-01-15",
    "expirationDate": "2024-01-14",
    "payload": {
        "additionInformation": "Information XX"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get details about the insurances of vehicle by country code and license plate number

Get details about the revisions of vehicle by country code and license plate number