Table of Contents

Applications.Fleet.Vehicles Entity

Namespace: Applications.Fleet

Contains vehicle definitions. Entity: Fleet_Vehicles

Default Visualization

Default Display Text Format:
{VehicleRegistrationNumber}
Default Search Members:
VehicleRegistrationNumber
Code Data Member:
VehicleRegistrationNumber
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
ActiveFrom datetime nullable The date and time, when the vehicle has been purchased or started to be managed. Null when the date and time are unknown. Filter(ge;le) Introduced in version 18.2
ActiveTill datetime nullable The date and time, when the vehicle has been sold or has stopped being managed. Null when the date and time are unknown. Filter(ge;le) Introduced in version 18.2
AuthorityMaximum
LadenMassKg		 int32 nullable Maximum permissible laden mass, as determined by the registration authority.
CrewCount int32 nullable Crew members count. For road vehicles = 1; for trailers, coaches and wagons =0; air and water vehicles may have higher counts. Default(1) Filter(eq;ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EngineIdentificationNumber string (20) nullable Engine identification number. Filter(eq;like)
EnginePowerhp int32 nullable Engine output power in horse power. null means that the value is unknown or not applicable for this type of engine. Filter(eq;ge;le)
EngineSizecc int32 nullable Engine size in cubic centimeters (cm3). null means that the value is unknown or not applicable for this type of engine (e.g. electric motors). Filter(eq;ge;le)
FuelCapacity int32 nullable Maximum fuel capacity of the engine or the battery in the fuel measurement unit.
FuelCompsumption decimal (7, 1) nullable Average fuel consumption in the fuel measurement unit for 1 operational unit.
FuelType string (64) nullable Fuel type of the engine or the power source of the engine (Multilanguage) - e.g. diesel, benzine, electric, etc. Filter(eq;like)
Id guid
IsActive boolean True if the vehicle is still owned and managed by the enterprise. Required Default(true) Filter(eq) Introduced in version 18.2
IssuingAuthority MultilanguageString (64) nullable The country or state issuing the registration number. null (not recommended) means that the authority is unknown or not applicable. Filter(eq;like)
Make MultilanguageString (64) nullable The name of the manufacturer of the vehicle. null means that the value is unknown. Filter(eq;like)
ManufactureYear int32 nullable The year when the vehicle was manufactured or first registered - whichever is known. null means that the value is unknown. Filter(eq;ge;le)
MaximumSpeedKmH int32 nullable Maximum speed in km/h.
Model MultilanguageString (64) nullable The model of the vehicle. Filter(eq;like)
Notes string (max) nullable Notes for this Vehicle.
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
PrimaryColor MultilanguageString (64) nullable The primary color of the vehicle. null means that the value is unknown or not applicable. Filter(eq;like)
SeatingPlacesCount int32 nullable Number of seating places, excluding driver. Filter(eq;ge;le)
StandingPlacesCount int32 nullable Number of standing places, if applicable.
TechnicalMaximum
LadenMassKg		 int32 nullable Maximum technically permissible laden mass in kg.
TrainsetMaximumLadenMassKg int32 nullable Maximum permissible laden mass of a whole trainset, including the vehicle.
VehicleIdentification
Number		 string (20) nullable VIN, aka Chassis number. Filter(eq;like)
VehicleMassKg int32 nullable Vehicle own mass in kg.
VehicleRegistrationNumber string (16) The registration plate number. Can be numeric or alphanumeric code. It should be unique within the Issuing_Authority. Required Filter(eq;like)
VehicleType MultilanguageString (64) nullable Type of vehicle - e.g. automobile, bus, etc. null means the value is unknown. Filter(eq;like)

References

Name Type Description
EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company that manages thе Vehicle. Filter(multi eq) Introduced in version 24.1.4.79
FuelMeasurementUnit MeasurementUnits (nullable) The measurement unit in which the fuel is measured. E.g. liters for automobiles, Watt-hours for electrics, etc. null means unknown. Filter(multi eq)
MaintenanceProfile MaintenanceProfiles (nullable) When not null, specifies, that the vehicle should be maintained according to the specified profile. Assigning a profile creates plan assignments for the vehicle. Ultimately, the specific plan assignments are taken into consideration, when planning vehicle maintenance. The profile is only for conveniently assigning multiple plans. Filter(multi eq)
ManagedAsset ManagedAssets (nullable) Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. Filter(multi eq) Introduced in version 24.1.4.74
OperationalMeasurementUnit MeasurementUnits (nullable) The measurement unit in which the operation of the vehicle is measured. E.g. km for automobiles, hrs for airplanes, etc. null means that the unit is unknown. Filter(multi eq)
OwnerParty Parties (nullable) Vehicle owner. Filter(multi eq)

Child Collections

Name Type Description
Equipment VehicleEquipment List of VehicleEquipment(Applications.Fleet.VehicleEquipment.md) child objects, based on the Applications.Fleet.VehicleEquipment.Vehicle(Applications.Fleet.VehicleEquipment.md#vehicle) back reference
TransportationVehicles TransportationVehicles List of TransportationVehicle(Logistics.Transportation.TransportationVehicles.md) child objects, based on the Logistics.Transportation.TransportationVehicle.Vehicle(Logistics.Transportation.TransportationVehicles.md#vehicle) back reference

Attribute Details

ActiveFrom

The date and time, when the vehicle has been purchased or started to be managed. Null when the date and time are unknown. Filter(ge;le) Introduced in version 18.2

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ActiveTill

The date and time, when the vehicle has been sold or has stopped being managed. Null when the date and time are unknown. Filter(ge;le) Introduced in version 18.2

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

AuthorityMaximumLadenMassKg

Maximum permissible laden mass, as determined by the registration authority.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

CrewCount

Crew members count. For road vehicles = 1; for trailers, coaches and wagons =0; air and water vehicles may have higher counts. Default(1) Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

EngineIdentificationNumber

Engine identification number. Filter(eq;like)

Type: string (20) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 20
Show in UI: ShownByDefault

EnginePowerhp

Engine output power in horse power. null means that the value is unknown or not applicable for this type of engine. Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

EngineSizecc

Engine size in cubic centimeters (cm3). null means that the value is unknown or not applicable for this type of engine (e.g. electric motors). Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

FuelCapacity

Maximum fuel capacity of the engine or the battery in the fuel measurement unit.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

FuelCompsumption

Average fuel consumption in the fuel measurement unit for 1 operational unit.

Type: decimal (7, 1) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

FuelType

Fuel type of the engine or the power source of the engine (Multilanguage) - e.g. diesel, benzine, electric, etc. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

True if the vehicle is still owned and managed by the enterprise. Required Default(true) Filter(eq) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

IssuingAuthority

The country or state issuing the registration number. null (not recommended) means that the authority is unknown or not applicable. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Make

The name of the manufacturer of the vehicle. null means that the value is unknown. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

ManufactureYear

The year when the vehicle was manufactured or first registered - whichever is known. null means that the value is unknown. Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

MaximumSpeedKmH

Maximum speed in km/h.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Model

The model of the vehicle. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this Vehicle.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

PrimaryColor

The primary color of the vehicle. null means that the value is unknown or not applicable. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

SeatingPlacesCount

Number of seating places, excluding driver. Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

StandingPlacesCount

Number of standing places, if applicable.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

TechnicalMaximumLadenMassKg

Maximum technically permissible laden mass in kg.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

TrainsetMaximumLadenMassKg

Maximum permissible laden mass of a whole trainset, including the vehicle.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

VehicleIdentificationNumber

VIN, aka Chassis number. Filter(eq;like)

Type: string (20) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 20
Show in UI: ShownByDefault

VehicleMassKg

Vehicle own mass in kg.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

VehicleRegistrationNumber

The registration plate number. Can be numeric or alphanumeric code. It should be unique within the Issuing_Authority. Required Filter(eq;like)

Type: string (16)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

VehicleType

Type of vehicle - e.g. automobile, bus, etc. null means the value is unknown. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

EnterpriseCompany

The Enterprise Company that manages thе Vehicle. Filter(multi eq) Introduced in version 24.1.4.79

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

FuelMeasurementUnit

The measurement unit in which the fuel is measured. E.g. liters for automobiles, Watt-hours for electrics, etc. null means unknown. Filter(multi eq)

Type: MeasurementUnits (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MaintenanceProfile

When not null, specifies, that the vehicle should be maintained according to the specified profile. Assigning a profile creates plan assignments for the vehicle. Ultimately, the specific plan assignments are taken into consideration, when planning vehicle maintenance. The profile is only for conveniently assigning multiple plans. Filter(multi eq)

Type: MaintenanceProfiles (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ManagedAsset

Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. Filter(multi eq) Introduced in version 24.1.4.74

Type: ManagedAssets (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

OperationalMeasurementUnit

The measurement unit in which the operation of the vehicle is measured. E.g. km for automobiles, hrs for airplanes, etc. null means that the unit is unknown. Filter(multi eq)

Type: MeasurementUnits (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

OwnerParty

Vehicle owner. Filter(multi eq)

Type: Parties (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_Fleet_Vehicles?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_Fleet_Vehicles?$top=10

Suggest improvement to this page