api/vehicle/post (Post)

Post	api/vehicle/post

In This Topic

Resource Path: /sites/{company-id}/api/vehicle/post

Uri: https://secure.ontime360.com/sites/{company-id}/api/vehicle/post

Description

Creates a new Vehicle record, or updates an existing Vehicle record.

Request

The request body is of type Vehicle.

A comprehensive Vehicle object containing the new vehicle information.

Vehicle

Represents a comprehensive Vehicle record within the OnTime API.

ID : string

The unique identifier for this Vehicle record.

FleetID : string

Gets the fleet identifier of the current vehicle.

Type : string

The type or category name assigned to this Vehicle.

Capacity : string

The loading capacity of this Vehicle.

OdometerReading : integer

The current Odometer reading of this Vehicle.

VehicleIdentificationNumber : string

The vehicle identification number (VIN) assigned to this Vehicle.

RegistrationPlate : string

The license plate number of this Vehicle.

Comments : string

Any additional comments associated with this Vehicle.

Manufacturer : string

Gets the manufacturer of the current vehicle.

Model : string

The identifying model of this Vehicle defined by the manufacturer.

Year : integer

The year that this Vehicle was manufactured.

Owner : string

The name of the party that owns this Vehicle.

IsCompanyVehicle : boolean

Indicates if this Vehicle is company-owned.

Capabilities : string

A short description detailing the capabilities of this Vehicle.

201 Response

The response body is of type object.

Returns the created or updated Vehicle object.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.