IncidentCreateCmd

Type: object

Incident create command, can either use default visibility or be provided
visibility distances per vehicle type

Command

Type: const Default: "incident_create"
Specific value: "incident_create"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

IncidentCreateDto

Type: object

Incident to be generated

Section Id

Type: integer

Identifier of the section of the incident

Lane

Type: integer

Lane number (1-indexed) where the incident occurs

Value must be strictly greater than 0

Position

Type: number

Position (distance from section start) of the incident

Length

Type: number

Length of the incident

Ini Time

Type: number

Time of the simulation, in seconds from midnight, when the incident will start

Duration

Type: number

Duration of the incident (seconds).

Visibility Distance

Type: number Default: 200

Visibility distance in meters of the incident to be used in Aimsun 7.0 models.In case visibilities are defined, vehicles not included in the list will default to the provided value

Per Veh Visibility

Default: null

List of per vehicle visibilities

Type: array
No Additional Items

Each item of this array must be:

VehicleVisibility

Type: object

Veh Type

Type: integer

Identifier of the vehicle type

Distance

Type: integer

Visibility distance for given vehicle type

Update Id Group

Type: boolean Default: false

True when the incident is a new group of incidents and False if the incidents is to be treated as a part of the last created incident (when creating incidents in adjacent lanes that need to be treated as a whole).

Apply Speed Reduction

Type: boolean Default: true

True to apply a speed reduction around the incident to slow vehicles as they pass it and False otherwise

Upstream Distance Sr

Type: number Default: 200

If the reduction is to be applied, the distance upstream of the incident

Downstream Distance Sr

Type: number Default: 200

If the reduction is to be applied, the distance downstream of the incident

Max Speed Sr

Type: number Default: 50

If the reduction is to be applied, the target reduced speed

IncidentRemoveCmd

Type: object

Remove an incident

Command

Type: const Default: "incident_remove"
Specific value: "incident_remove"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

IncidentRemoveDto

Type: object

Section Id

Type: integer

Identifier of the section where the incident to remove is located

Lane

Type: integer

Lane where the incident will be generated

Position

Type: number

Position of the incident in the section (from the beginning of the section).

IncidentsClearSectionCmd

Type: object

Remove all incidents active in a given section

Command

Type: const Default: "incidents_clear_section"
Specific value: "incidents_clear_section"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

IncidentsClearSectionDto

Type: object

Section Id

Type: integer

Identifier of the section to clear of incidents

IncidentsResetCmd

Type: object

Removes all incidents created using the Aimsun Next API Module, initializes incidents
with the initial incidents (the incidents loaded when Aimsun loads the traffic)

Command

Type: const Default: "incidents_reset"
Specific value: "incidents_reset"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

Payload

Type: null Default: null

MeasureCreateCmd

Type: object

Create of a specific traffic measure

Command

Type: const Default: "measure_create"
Specific value: "measure_create"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

MeasureCreateDto

Type: object

MeasureSpeedSection

Type: object

Changes the speed limit in one or many sections.
Calls the AKIActionAddSpeedSectionById API function.

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

Type

Type: const Default: "speed_section"
Specific value: "speed_section"

Section Ids

Type: array of integer

List of section IDs to apply measure to

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Speed

Type: number

Target speed (km/h

Value must be strictly greater than 0

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

Consider Speed Acceptance

Type: boolean Default: true

False -> override speed acceptance factor

MeasureSpeedDetailed

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

Type

Type: const Default: "speed_detailed"
Specific value: "speed_detailed"

Section Ids

Type: array of integer

List of section IDs to apply measure to

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Lane Id

Type: integer Default: -1

The lane identifier (-1 for all lanes, 1 for the rightmost laneand N, where N is the number of lanes in the section, for the leftmost lane

From Segment Id

Type: integer Default: -1

-1 for all the segments, 1 for the first segment the vehicles face when crossing the section, and N, where N is the number of segments, for the last segment the vehicles face when crossing the section

To Segment Id

Type: integer Default: -1

-1 for all the segments, 1 for the first segment the vehicles face when crossing the section, and N, where N is the number of segments, for the last segment the vehicles face when crossing the section

Speed

Type: number

Target speed (km/h

Value must be strictly greater than 0

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

Consider Speed Acceptance

Type: boolean Default: true

False -> override speed acceptance factor

MeasureLaneClosure

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

Type

Type: const Default: "lane_closure"
Specific value: "lane_closure"

Section Id

Type: integer

Identifier of the section to apply action to

Lane Id

Type: integer

Identifier of the lane to apply action to

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

MeasureLaneClosureDetailed

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Type

Type: const Default: "lane_closure_detailed"
Specific value: "lane_closure_detailed"

Section Id

Type: integer

Identifier of the section to apply action to

Lane Id

Type: integer

Identifier of the lane to apply action to

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Apply 2Lcf

Type: boolean Default: false

True if the 2-lanes car following model is to be considered

Visibility Distance

Type: number Default: 200

The distance at which the lane closure will start to be visible for vehicles

MeasureLaneDeactivateReserved

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Type

Type: const Default: "lane_deactivate_reserved"
Specific value: "lane_deactivate_reserved"

Section Id

Type: integer

Identifier of the section to apply action to

Lane Id

Type: integer

Identifier of the lane to apply action to

Segment Id

Type: integer Default: -1

0..N-1 where N is number of segments present within section or -1 to apply to all segments.

MeasureTurnClose

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

Type

Type: const Default: "turn_close"
Specific value: "turn_close"

From Section Id

Type: integer

Turn origin section identifier.

To Section Id

Type: integer

Turn destination section identifier.

Origin Centroid

Type: integer Default: -1

Centroid origin identifier, -1 means do not consider origin with set compliance

Destination Centroid

Type: integer Default: -1

Centroid destination identifier, -1 means do not consider destination with set compliance

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

Visibility Distance

Type: number Default: 200

The distance at which the lane closure will start to be visible for vehicles

Local Effect

Type: boolean Default: true

If vehicles do not have apriori knowledge of closure - true, else global knowledge

Section Affecting Path Cost Id

Type: integer Default: -1

Identifier to the section meant to affect the path calculation cost when the path comes from it

MeasureTurnForceOD

Type: object

Force turn action evaluated against OD paths.

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

From Section Id

Type: integer

Section where the forced turn begins

Next Section Ids

Type: array of integer

One or more candidate sections vehicles should take instead.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

Type

Type: const Default: "turn_force_od"
Specific value: "turn_force_od"

Origin Centroid

Type: integer Default: -1

Centroid origin identifier, -1 means do not consider origin with set compliance

Destination Centroid

Type: integer Default: -1

Centroid destination identifier, -1 means do not consider destination with set compliance

Section In Path

Type: integer Default: -1

Restrict action to vehicles whose planned path already contains this section. -1 = ignore

Visibility Distance

Type: number Default: 200

Visibility distance in meters of the incident to be used in Aimsun 7.0 models.

MeasureTurnForceResult

Type: object

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

From Section Id

Type: integer

Section where the forced turn begins

Next Section Ids

Type: array of integer

One or more candidate sections vehicles should take instead.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

Type

Type: const Default: "turn_force_result"
Specific value: "turn_force_result"

Old Next Section Id

Type: integer

Which outgoing section of the node to affect

MeasureDestinationChange

Type: object

Redirect vehicles on section_id to one or many destination centroids.

If you pass new_destinations, the proportions must sum to 100.0 (±1e-6).
If you pass the legacy new_destination field, it will be
auto-converted to new_destinations=[{dest_id=new_destination, percentage=100.0}].

Id Action

Default: null

Preallocate the ID only if you know what you're doing, otherwise omit this field

Duration

Default: null

If set, automatically generate cancellation command for the action

Type

Type: const Default: "destination_change"
Specific value: "destination_change"

Section Id

Type: integer

Section of action being applied

New Destinations

Default: null

List of centroid id/proportion objects

Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

NewDestinations

Type: object

Helper class for MeasureType.DESTINATION_CHANGE

Dest Id

Type: integer

Candidate destination centroid identifier

Percentage

Type: number Default: 1.0

Percentage of complying vehicles sent to this centroid

Value must be greater or equal to 0.0 and lesser or equal to 100.0

Origin Centroid

Type: integer Default: -1

Origin centroid filter (-1 ignores)

Destination Centroid

Type: integer Default: -1

Destination centroid filter (-1 ingores)

Veh Type

Type: integer Default: 0

0 = all vehicles, 1..N specific vehicle types

Value must be greater or equal to 0

Compliance

Type: number Default: 1.0

Share of drivers obeying the measure <0-1>

Value must be greater or equal to 0.0 and lesser or equal to 1.0

MeasureRemoveCmd

Type: object

Remove a specific traffic measure action

Command

Type: const Default: "measure_remove"
Specific value: "measure_remove"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

MeasureRemoveDto

Type: object

Id Action

Type: integer

ID of the measure to remove

Value must be strictly greater than 0

MeasuresClearCmd

Type: object

Clear all active traffic management actions

Command

Type: const Default: "measures_reset"
Specific value: "measures_reset"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

Payload

Type: null Default: null

PolicyActivateCmd

Type: object

Activate a specific policy

Command

Type: const Default: "policy_activate"
Specific value: "policy_activate"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible

PolicyTargetDto

Type: object

Policy Id

Type: integer

ID of the policy to affect

Value must be strictly greater than 0

PolicyDeactivateCmd

Type: object

Deactivate a specific policy

Command

Type: const Default: "policy_deactivate"
Specific value: "policy_deactivate"

Time

Type: number Default: -1

Sim-time in seconds from midnight,omit or set to -1 to run as soon as possible