latestSwagger 2.02026-08-084062117.9 KB
78fc4b609513
Vehicles
UPDATE a specific vehicle
Post a map of key value pairs for fields with the new value. A value of null is accepted (where marked as nullable) and will clear that field. Cleared fields will not be shown in the response, as null fields are stripped by default. If a field is not present in the map it will not be altered. Fields not marked as nullable can be left out of the map all together so as not to be changed
post/v1/vehicles/{uuid}
Path parameters
uuidstring uuid required
Request body
customNamestring nullable
Used to override the vehicle's display name, which is a generated property that otherwise defaults to the current license plate
commissionDatestring date nullable
registrationDatestring date nullable
organizationUuidstring uuid
fuelTankSizenumber nullable
fuelType'CNG' | 'DIESEL' | 'ELECTRIC' | 'GAS' | 'GASOLINE' | 'HYBRID_DIESEL' | 'HYBRID_DIESEL_CNG' | 'HYBRID_DIESEL_LNG' | 'HYBRID_DIESEL_LPG' | 'HYBRID_GASOLINE' | 'HYBRID_GASOLINE_CNG' | 'HYBRID_GASOLINE_LNG' | 'HYBRID_GASOLINE_LPG' | 'LPG' | 'LNG' | 'OTHER' nullable
transmissionType'AUTOMATIC' | 'MANUAL' nullable
jobAccountNumberstring nullable
registrationCountry'ISO 3166-1 Alpha-2 country code'
emissionClass'EURO_1' | 'EURO_2' | 'EURO_3' | 'EURO_4' | 'EURO_5' | 'EURO_5A' | 'EURO_5B' | 'EURO_6' | 'EURO_6B' | 'EURO_6C' | 'EURO_6D_TEMP' | 'EURO_6D' | 'EURO_I' | 'EURO_II' | 'EURO_III' | 'EURO_IV' | 'EURO_V' | 'EURO_VI' | 'D3' | 'D4' | 'E00' | 'E01' | 'E02' | 'E03' | 'E04' | 'E05' | 'E06' | 'D50' | 'D51' | 'D52' | 'D53' | 'D54' | 'F50' | 'F51' | 'F52' | 'F53' | 'F54' | 'B00' | 'B01' | 'B02' | 'B03' | 'B04' | 'B5A' | 'B5B' | 'B6A' | 'B6B' | 'B6C' | 'B6D' | 'A00' | 'A01' | 'A02' | 'A03' | 'A04' | 'A05' | 'A06' | 'A07' | 'A08' | 'A09' | 'A10' | 'A11' | 'A12' | 'A13' | 'A14' | 'A15' | 'A16' | 'A17' | 'A18' | 'A19' | 'A20' | 'A21' | 'A22' | 'A23' | 'A24' | 'A25' | 'A26' | 'A27' | 'C00' | 'C01' | 'C02' | 'C03' | 'D00' | 'D01' | 'D02' | 'D03' | 'D04' | 'F00' | 'F01' | 'F02' | 'F03' | 'F04' | 'STUFE_I' | 'STUFE_II' | 'STUFE_III_A' | 'STUFE_III_B' | 'STUFE_IV' | 'STUFE_V' | 'TIER_I' | 'TIER_II' | 'TIER_III' | 'TIER_IV_INTERIM' | 'TIER_IV' | 'TIER_V' nullable
tareWeightinteger nullable
loadCapacityinteger nullable
maxWeightinteger nullable
tensileLoadinteger nullable
trailerLoadinteger nullable
combinedFuelConsumptionPerKmnumber nullable
urbanFuelConsumptionPerKmnumber nullable
extraUrbanFuelConsumptionPerKmnumber nullable
combinedElectricityConsumptionPerKmnumber nullable
urbanElectricityConsumptionPerKmnumber nullable
extraUrbanElectricityConsumptionPerKmnumber nullable
internalIdstring nullable
additionalIdstring nullable
euLicenseNumberstring nullable
yearOfConstructioninteger nullable
commentstring nullable
licensePlateColor'BLACK' | 'BLUE' | 'BROWN' | 'GREEN' | 'RED' | 'YELLOW' | 'WHITE' nullable
grossListPricenumber nullable
grossListPriceCurrency'ISO 4217 alphabetic currency code' nullable
grossListPriceSource'DAT' | 'MANUAL' nullable
co2Emissioninteger nullable
displacementinteger nullable
kilowattinteger nullable
manufacturerNamestring nullable
vehicleColorstring nullable
interiorColorstring nullable
cushionColorstring nullable
vehicleAvailableboolean
tireStorageLocationstring nullable
atNovanumber nullable
atVatExemptboolean
chMasterNumberstring nullable
vehicleType'BUILD_UP' | 'BUS' | 'CAR' | 'COST' | 'EXCAVATOR' | 'INDUSTRIAL_TRUCK' | 'SPECIAL' | 'TWO_WHEELER' | 'TRUCK' | 'TRACTOR' | 'TRAILER' | 'VAN'
locationstring nullable
Response
Successful operation.
uuidstring uuid
activeLicensePlatestring
displayNamestring
customNamestring
vinstring
commissionDatestring date
fuelTankSizenumber
fuelType'CNG' | 'DIESEL' | 'ELECTRIC' | 'GAS' | 'GASOLINE' | 'HYBRID_DIESEL' | 'HYBRID_DIESEL_CNG' | 'HYBRID_DIESEL_LNG' | 'HYBRID_DIESEL_LPG' | 'HYBRID_GASOLINE' | 'HYBRID_GASOLINE_CNG' | 'HYBRID_GASOLINE_LNG' | 'HYBRID_GASOLINE_LPG' | 'LPG' | 'LNG' | 'OTHER'
transmissionType'AUTOMATIC' | 'MANUAL'
costCenterstring
jobAccountNumberstring
registrationDatestring date
registrationCountrystring
ISO 3166-1 Alpha-2 country code
emissionClass'EURO_0' | 'EURO_1' | 'EURO_2' | 'EURO_3' | 'EURO_4' | 'EURO_5' | 'EURO_5A' | 'EURO_5B' | 'EURO_6' | 'EURO_6A' | 'EURO_6B' | 'EURO_6C' | 'EURO_6C_EVAP' | 'EURO_6D_TEMP' | 'EURO_6D_TEMP_EVAP' | 'EURO_6D_TEMP_ISC' | 'EURO_6D_TEMP_EVAP_ISC' | 'EURO_6D_ISC' | 'EURO_6D_ISC_FCM' | 'EURO_6D' | 'EURO_6E' | 'EURO_6E_BIS' | 'EURO_6E_BIS_FCM' | 'EURO_I' | 'EURO_II' | 'EURO_III' | 'EURO_IV' | 'EURO_V' | 'EURO_VI' | 'D3' | 'D4' | 'E00' | 'E01' | 'E02' | 'E03' | 'E04' | 'E05' | 'E06' | 'D50' | 'D51' | 'D52' | 'D53' | 'D54' | 'F50' | 'F51' | 'F52' | 'F53' | 'F54' | 'B00' | 'B01' | 'B02' | 'B03' | 'B04' | 'B5A' | 'B5B' | 'B6A' | 'B6B' | 'B6C' | 'B6D' | 'B6E' | 'AX' | 'A00' | 'A01' | 'A02' | 'A03' | 'A04' | 'A05' | 'A06' | 'A07' | 'A08' | 'A09' | 'A10' | 'A11' | 'A12' | 'A13' | 'A14' | 'A15' | 'A16' | 'A17' | 'A18' | 'A19' | 'A20' | 'A21' | 'A22' | 'A23' | 'A24' | 'A25' | 'A26' | 'A27' | 'C00' | 'C01' | 'C02' | 'C03' | 'D00' | 'D01' | 'D02' | 'D03' | 'D04' | 'F00' | 'F01' | 'F02' | 'F03' | 'F04' | 'STUFE_I' | 'STUFE_II' | 'STUFE_III_A' | 'STUFE_III_B' | 'STUFE_IV' | 'STUFE_V' | 'TIER_I' | 'TIER_II' | 'TIER_III' | 'TIER_IV_INTERIM' | 'TIER_IV' | 'TIER_V'
tareWeightinteger
loadCapacityinteger
maxWeightinteger
tensileLoadinteger
trailerLoadinteger
combinedFuelConsumptionPerKmnumber
urbanFuelConsumptionPerKmnumber
extraUrbanFuelConsumptionPerKmnumber
combinedElectricityConsumptionPerKmnumber
urbanElectricityConsumptionPerKmnumber
extraUrbanElectricityConsumptionPerKmnumber
internalIdstring
additionalIdstring
euLicenseNumberstring
yearOfConstructioninteger
commentstring
licensePlateColor'BLACK' | 'BLUE' | 'BROWN' | 'GREEN' | 'RED' | 'YELLOW' | 'WHITE'
grossListPricenumber
grossListPriceCurrencystring
ISO 4217 alphabetic currency code
grossListPriceSource'DAT' | 'PROCUREMENT_OFFER' | 'MANUAL'
state'ACTIVE' | 'INACTIVE' | 'DECOMMISSIONED' | 'IN_PROCUREMENT' | 'ARCHIVED'
co2Emissioninteger
displacementinteger
kilowattinteger
taxnumber
taxCurrencystring
ISO 4217 alphabetic currency code
manufacturerNamestring
modelNamestring
baseModelDisplayNamestring
DEPRECATED: use modelName instead (will be removed in next release)
importVehicleModelstring
DEPRECATED: use modelName instead (will be removed in next release)
subCompanystring
vehicleColorstring
interiorColorstring
cushionColorstring
vehicleAvailableboolean
tireStorageLocationstring
atNovanumber
atVatExemptboolean
chMasterNumberstring
vehicleType'BUILD_UP' | 'BUS' | 'CAR' | 'COST' | 'EXCAVATOR' | 'INDUSTRIAL_TRUCK' | 'SPECIAL' | 'TWO_WHEELER' | 'TRUCK' | 'TRACTOR' | 'TRAILER' | 'VAN' | 'SWAP_BODY'
handoverDatestring date-time
locationstring
organizationUuidstring uuid