Vehicle Webservice

Save vehicle

Name and save a vehicle based on license plate number

post/api/vehicle/saveVehicle

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/vehicle/saveVehicle
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

alertboolean nullable

Whether to alert when this vehicle is detected

createdAtMillisinteger nullable

Creation timestamp in milliseconds

descriptionstring nullable

Description of the vehicle

namestring nullable

Name for the vehicle

thumbnailS3Keystring nullable

S3 key for the vehicle thumbnail image

trustboolean nullable

Whether this vehicle is trusted

vehicleLicensePlatestring nullable

License plate number of the vehicle

Example request

{
  "createdAtMillis": 1640995200000,
  "description": "Blue Honda Civic",
  "name": "John's Car",
  "vehicleLicensePlate": "ABC123"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.