Add fleet vehicles

POST 
/fleets/:id/vehicles

Creates or updates vehicles by VIN within the fleet. Send one vehicle object or a root array containing 1 to 500 vehicles. Do not wrap a batch in a vehicles property. Response order follows request order.

Request

Path Parameters

id stringrequired

Fleet inspection ULID.

application/json

Body

required

oneOf
FleetVehicleRequest
chassis_number stringrequired
Possible values: Value must match regular expression ^[A-HJ-NPR-Z0-9]{12}$|^[A-HJ-NPR-Z0-9]{17}$
A 12 or 17 character uppercase VIN. I, O, and Q are not allowed.
vehicle_regno stringrequired
Possible values: <= 60 characters
engine_no stringnullable
Possible values: <= 60 characters
vehicle_type stringrequired
Possible values: <= 100 characters
manufacturer stringrequired
Possible values: <= 255 characters
model stringrequired
Possible values: <= 150 characters
year integerrequired
Possible values: >= 1901 and <= 2155
color stringrequired
Possible values: <= 50 characters
MOD2
Array [
chassis_number stringrequired
Possible values: Value must match regular expression ^[A-HJ-NPR-Z0-9]{12}$|^[A-HJ-NPR-Z0-9]{17}$
A 12 or 17 character uppercase VIN. I, O, and Q are not allowed.
vehicle_regno stringrequired
Possible values: <= 60 characters
engine_no stringnullable
Possible values: <= 60 characters
vehicle_type stringrequired
Possible values: <= 100 characters
manufacturer stringrequired
Possible values: <= 255 characters
model stringrequired
Possible values: <= 150 characters
year integerrequired
Possible values: >= 1901 and <= 2155
color stringrequired
Possible values: <= 50 characters
]

Responses

201

Vehicle or vehicles saved successfully. A single request returns one object, while a batch returns an array.

application/json

Schema

Schema

data object
oneOf
FleetVehicle
id integer
Use this value as fleet_vehicle_id when creating an assessment.
vin string
registration_no string
engine_no stringnullable
body_type string
maker string
model string
year integer
color string
created_at date-time
MOD2
Array [
id integer
Use this value as fleet_vehicle_id when creating an assessment.
vin string
registration_no string
engine_no stringnullable
body_type string
maker string
model string
year integer
color string
created_at date-time
]

Example (from schema)

{
  "data": {}
}

401

Unauthenticated - no valid API key was provided.

application/json

Schema

Schema

data string

Example (from schema)

{
  "data": "Invalid Token"
}

403

The authenticated insurer does not own this fleet.

404

Fleet inspection not found.

422

The request failed validation. Batch vehicle errors include the zero based request index, for example vehicles.1.chassis_number.

application/json

Schema

Schema

message stringrequired
error objectrequired
property name* string[]
Array [
string
]

Example (from schema)

{
  "message": "The chassis number must be a valid VIN.",
  "error": {
    "vehicles.1.chassis_number": [
      "The chassis number must be a valid VIN."
    ]
  }
}

429

Too many requests.

Loading...