Interface BaseRestriction

Base restriction contract shared by turn and segment restrictions.

interface BaseRestriction {
    defaultType: null | RESTRICTION_TYPE;
    description: null | string;
    driveProfiles: VehicleRules;
    editable: boolean;
    isExpired: boolean;
    timeFrames: TimeFrame[];
    vehicleRules: VehicleRules;
}

Properties

defaultType: null | RESTRICTION_TYPE

Default restriction type. Allowed combinations for defaultType and vehicleRules:

description: null | string

Free text description of the restriction.

driveProfiles: VehicleRules

Drive profiles overriding the default restriction per restriction type.

Use vehicleRules instead.

editable: boolean

Whether the restriction is editable by the current user.

isExpired: boolean

Whether the restriction has expired based on its time frames.

timeFrames: TimeFrame[]

Array of time frames indicating when the restriction applies.

vehicleRules: VehicleRules

Vehicle rules overriding the default restriction per restriction type.