Applications.Fleet.TripSegments Entity

Represents the segments which comprise the route of the trips. Entity: Fleet_Trip_Segments

Default Visualization

Default Display Text Format:
{Trip.EntityName}
Default Search Members:
Trip.EntityName
Name Data Member:
Trip.EntityName
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 Parent:
Applications.Fleet.Trips
Aggregate Root:
Applications.Fleet.Trips

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EndingTimestamp	datetime nullable	The ending date and time of the travel on the segment. `Filter(ge;le)`
Id	guid
Mileage	decimal (9, 0) nullable	Mileage of the route segment. The mileage is measured in the operational units of the vehicle even when it is not miles or kilometers. null means unknown mileage.
Notes	string (254) nullable	Notes for the segment.
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.
StartingTimestamp	datetime	The starting date and time of the travel on the segment. `Required` `Filter(ge;le)`

References

Name	Type	Description
EndingMapPoint	MapPoints	The ending geographical point of the route segment. `Required` `Filter(multi eq)`
StartingMapPoint	MapPoints	The starting geographical point of the route segment. `Required` `Filter(multi eq)`
Trip	Trips	The trip for which the segment is defined. `Required` `Filter(multi eq)` `Owner`

Attribute Details

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

EndingTimestamp

The ending date and time of the travel on the segment. Filter(ge;le)

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

Id

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

Mileage

Mileage of the route segment. The mileage is measured in the operational units of the vehicle even when it is not miles or kilometers. null means unknown mileage.

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

Notes

Notes for the segment.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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

StartingTimestamp

The starting date and time of the travel on the segment. Required Filter(ge;le)

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

Reference Details

EndingMapPoint

The ending geographical point of the route segment. Required Filter(multi eq)

Type: MapPoints
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

StartingMapPoint

The starting geographical point of the route segment. Required Filter(multi eq)

Type: MapPoints
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Trip

The trip for which the segment is defined. Required Filter(multi eq) Owner

Type: Trips
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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