CAGA Input Schema

Expand all Collapse all

Test Input Schema

Type: object

title

Title

Type: string Default: null

The title of the traffic situation

Example:

"overtaking_18"

description

Description

Default: null

A description of the traffic situation

Any of

• Option 1
• Option 2

Type: string

Type: null

Example:

"Crossing situation with 3 target vessels in the Oslofjord"

startTime

Starttime

Default: null

Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

Example:

"2024-04-04T13:41:01.704131"

ownShip Required

Own Ship data

Type: object

Own Ship data

Example:

{
    "initial": {
        "cog": 284.2,
        "heading": 283.1,
        "navStatus": "Under way using engine",
        "position": {
            "latitude": 57.2343,
            "longitude": 10.3432
        },
        "sog": 12.3
    },
    "static": {
        "height": 15.0,
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "imo": 1000001,
        "length": 230.0,
        "mmsi": 123456789,
        "name": "RMS Titanic",
        "shipType": "Fishing",
        "speedMax": 20.0,
        "width": 30.0
    },
    "waypoints": [
        {
            "data": {
                "heading": {
                    "interpMethod": "linear",
                    "mAfterLegChange": 100.0,
                    "mBeforeLegChange": 100.0,
                    "value": 12.3
                },
                "sog": {
                    "interpMethod": "linear",
                    "mAfterLegChange": 100.0,
                    "mBeforeLegChange": 100.0,
                    "value": 12.3
                }
            },
            "position": {
                "latitude": 57.2343,
                "longitude": 10.3432
            },
            "turnRadius": 500.0
        }
    ]
}

static

Type: object Default: null

Static ship information which does not change during a scenario.

Example:

{
    "height": 15.0,
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "imo": 1000001,
    "length": 230.0,
    "mmsi": 123456789,
    "name": "RMS Titanic",
    "shipType": "Fishing",
    "speedMax": 20.0,
    "width": 30.0
}

id Required

Id

Type: stringFormat: uuid

Unique Identifier

Example:

"8cbccf5a-2415-4609-a886-be2e6ecb67c3"

length

Length

Type: number Default: null

Length of the ship in meters

Value must be strictly greater than 0.0

Example:

230.0

width

Width

Type: number Default: null

Width of the ship in meters

Value must be strictly greater than 0.0

Example:

30.0

height

Height

Default: null

Height of the ship in meters

Any of

• Option 1
• Option 2

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0

speedMax

Speedmax

Default: null

Maximum speed of the ship in knots

Any of

• Option 1
• Option 2

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0

mmsi

Mmsi

Default: null

Maritime Mobile Service Identity (MMSI)

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 100000000 and lesser or equal to 999999999

Type: null

Example:

123456789

imo

Imo

Default: null

IMO Number

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1000000 and lesser or equal to 9999999

Type: null

Example:

1234567

name

Name

Default: null

Ship name

Any of

• Option 1
• Option 2

Type: string

Type: null

Example:

"RMS Titanic"

shipType

Default: null

General ship type, based on AIS

Any of

• GeneralShipType
• Option 2

Type: enum (of string)

Must be one of:

• "Wing in ground"
• "Fishing"
• "Towing"
• "Dredging or underwater ops"
• "Diving ops"
• "Military ops"
• "Sailing"
• "Pleasure Craft"
• "High speed craft"
• "Pilot Vessel"
• "Search and Rescue vessel"
• "Tug"
• "Port Tender"
• "Anti-pollution"
• "Law Enforcement"
• "Medical Transport"
• "Noncombatant ship"
• "Passenger"
• "Cargo"
• "Tanker"
• "Other Type"

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

initial

Default: null

Any of

• Initial
• Option 2

Type: object

position

Type: object Default: null

Initial longitude and latitude of the ship.

Example:

{
    "latitude": 57.2343,
    "longitude": 10.3432
}

latitude

Latitude

Type: number Default: null

WGS-84 latitude

Value must be greater or equal to -90.0 and lesser or equal to 90.0

Example:

51.2131

longitude

Longitude

Type: number Default: null

WGS-84 longitude

Value must be greater or equal to -180.0 and lesser or equal to 180.0

Example:

11.2131

Additional Properties

Additional Properties of any type are allowed.

Type: object

sog

Sog

Type: number Default: null

Initial ship speed over ground in knots

Value must be greater or equal to 0.0

Example:

10.0

cog

Cog

Type: number Default: null

Initial ship course over ground in degrees

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

Example:

45.0

heading

Heading

Type: number Default: null

Initial ship heading in degrees

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

Example:

45.2

navStatus

Default: null

AIS Navigational Status

Any of

• AISNavStatus
• Option 2

Type: enum (of string)

Must be one of:

• "Under way using engine"
• "At anchor"
• "Not under command"
• "Restricted manoeuverability"
• "Constrained by her draught"
• "Moored"
• "Aground"
• "Engaged in fishing"
• "Under way sailing"
• "Reserved for future amendment of navigational status for HSC"
• "Reserved for future amendment of navigational status for WIG"
• "Reserved for future use 1"
• "Reserved for future use 2"
• "Reserved for future use 3"
• "AIS SART is active"
• "Not defined (default)"

Type: null

Type: null

Example:

{
    "cog": 284.2,
    "heading": 283.1,
    "navStatus": "Under way using engine",
    "position": {
        "latitude": 57.2343,
        "longitude": 10.3432
    },
    "sog": 12.3
}

waypoints

Waypoints

Default: null

An array of Waypoint objects. Each waypoint object must have a position property.
If no turn radius is provided, it will be assumed to be 0.
Additional data can be added to each waypoint leg. This allows varying parameters on a per-leg basis, such as speed and heading, or navigational status

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

position Required

Type: object

A geographical coordinate

Example:

{
    "latitude": 51.2123,
    "longitude": 11.2313
}

latitude

Latitude

Type: number Default: null

WGS-84 latitude

Value must be greater or equal to -90.0 and lesser or equal to 90.0

Example:

51.2131

longitude

Longitude

Type: number Default: null

WGS-84 longitude

Value must be greater or equal to -180.0 and lesser or equal to 180.0

Example:

11.2131

Additional Properties

Additional Properties of any type are allowed.

Type: object

turnRadius

Turnradius

Default: null

Orthodrome turn radius as defined in RTZ format

Any of

• Option 1
• Option 2

Type: number

Type: null

Example:

200

data

Default: null

A Data object that includes speed, course, and heading data points

Any of

• Data
• Option 2

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: object

The 'data' field can include additional properties. All additional properties should be DataPoint objects.

value

Type: number

mBeforeLegChange

Type: number

mAfterLegChange

Type: number

interpMethod

Type: string

Type: null

Type: null

Example:

{
    "data": {
        "heading": {
            "interpMethod": "linear",
            "mAfterLegChange": 100.0,
            "mBeforeLegChange": 100.0,
            "value": 12.3
        },
        "sog": {
            "interpMethod": "linear",
            "mAfterLegChange": 100.0,
            "mBeforeLegChange": 100.0,
            "value": 12.3
        }
    },
    "position": {
        "latitude": 57.2343,
        "longitude": 10.3432
    },
    "turnRadius": 500.0
}

targetShips

Target Ship data

Type: array Default: null

Target Ship data

No Additional Items

Each item of this array must be:

Type: object

static

Type: object Default: null

Static ship information which does not change during a scenario.

Example:

{
    "height": 15.0,
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "imo": 1000001,
    "length": 230.0,
    "mmsi": 123456789,
    "name": "RMS Titanic",
    "shipType": "Fishing",
    "speedMax": 20.0,
    "width": 30.0
}

id Required

Id

Type: stringFormat: uuid

Unique Identifier

Example:

"8cbccf5a-2415-4609-a886-be2e6ecb67c3"

length

Length

Type: number Default: null

Length of the ship in meters

Value must be strictly greater than 0.0

Example:

230.0

width

Width

Type: number Default: null

Width of the ship in meters

Value must be strictly greater than 0.0

Example:

30.0

height

Height

Default: null

Height of the ship in meters

Any of

• Option 1
• Option 2

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0

speedMax

Speedmax

Default: null

Maximum speed of the ship in knots

Any of

• Option 1
• Option 2

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0

mmsi

Mmsi

Default: null

Maritime Mobile Service Identity (MMSI)

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 100000000 and lesser or equal to 999999999

Type: null

Example:

123456789

imo

Imo

Default: null

IMO Number

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1000000 and lesser or equal to 9999999

Type: null

Example:

1234567

name

Name

Default: null

Ship name

Any of

• Option 1
• Option 2

Type: string

Type: null

Example:

"RMS Titanic"

shipType

Default: null

General ship type, based on AIS

Any of

• GeneralShipType
• Option 2

Type: enum (of string)

Must be one of:

• "Wing in ground"
• "Fishing"
• "Towing"
• "Dredging or underwater ops"
• "Diving ops"
• "Military ops"
• "Sailing"
• "Pleasure Craft"
• "High speed craft"
• "Pilot Vessel"
• "Search and Rescue vessel"
• "Tug"
• "Port Tender"
• "Anti-pollution"
• "Law Enforcement"
• "Medical Transport"
• "Noncombatant ship"
• "Passenger"
• "Cargo"
• "Tanker"
• "Other Type"

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

initial

Default: null

Any of

• Initial
• Option 2

Type: object

position

Type: object Default: null

Initial longitude and latitude of the ship.

Example:

{
    "latitude": 57.2343,
    "longitude": 10.3432
}

latitude

Latitude

Type: number Default: null

WGS-84 latitude

Value must be greater or equal to -90.0 and lesser or equal to 90.0

Example:

51.2131

longitude

Longitude

Type: number Default: null

WGS-84 longitude

Value must be greater or equal to -180.0 and lesser or equal to 180.0

Example:

11.2131

Additional Properties

Additional Properties of any type are allowed.

Type: object

sog

Sog

Type: number Default: null

Initial ship speed over ground in knots

Value must be greater or equal to 0.0

Example:

10.0

cog

Cog

Type: number Default: null

Initial ship course over ground in degrees

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

Example:

45.0

heading

Heading

Type: number Default: null

Initial ship heading in degrees

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

Example:

45.2

navStatus

Default: null

AIS Navigational Status

Any of

• AISNavStatus
• Option 2

Type: enum (of string)

Must be one of:

• "Under way using engine"
• "At anchor"
• "Not under command"
• "Restricted manoeuverability"
• "Constrained by her draught"
• "Moored"
• "Aground"
• "Engaged in fishing"
• "Under way sailing"
• "Reserved for future amendment of navigational status for HSC"
• "Reserved for future amendment of navigational status for WIG"
• "Reserved for future use 1"
• "Reserved for future use 2"
• "Reserved for future use 3"
• "AIS SART is active"
• "Not defined (default)"

Type: null

Type: null

Example:

{
    "cog": 284.2,
    "heading": 283.1,
    "navStatus": "Under way using engine",
    "position": {
        "latitude": 57.2343,
        "longitude": 10.3432
    },
    "sog": 12.3
}

waypoints

Waypoints

Default: null

An array of Waypoint objects. Each waypoint object must have a position property.
If no turn radius is provided, it will be assumed to be 0.
Additional data can be added to each waypoint leg. This allows varying parameters on a per-leg basis, such as speed and heading, or navigational status

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

position Required

Type: object

A geographical coordinate

Example:

{
    "latitude": 51.2123,
    "longitude": 11.2313
}

latitude

Latitude

Type: number Default: null

WGS-84 latitude

Value must be greater or equal to -90.0 and lesser or equal to 90.0

Example:

51.2131

longitude

Longitude

Type: number Default: null

WGS-84 longitude

Value must be greater or equal to -180.0 and lesser or equal to 180.0

Example:

11.2131

Additional Properties

Additional Properties of any type are allowed.

Type: object

turnRadius

Turnradius

Default: null

Orthodrome turn radius as defined in RTZ format

Any of

• Option 1
• Option 2

Type: number

Type: null

Example:

200

data

Default: null

A Data object that includes speed, course, and heading data points

Any of

• Data
• Option 2

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: object

The 'data' field can include additional properties. All additional properties should be DataPoint objects.

value

Type: number

mBeforeLegChange

Type: number

mAfterLegChange

Type: number

interpMethod

Type: string

Type: null

Type: null

Example:

{
    "data": {
        "heading": {
            "interpMethod": "linear",
            "mAfterLegChange": 100.0,
            "mBeforeLegChange": 100.0,
            "value": 12.3
        },
        "sog": {
            "interpMethod": "linear",
            "mAfterLegChange": 100.0,
            "mBeforeLegChange": 100.0,
            "value": 12.3
        }
    },
    "position": {
        "latitude": 57.2343,
        "longitude": 10.3432
    },
    "turnRadius": 500.0
}

Example:

[
    {
        "initial": {
            "cog": 284.2,
            "heading": 283.1,
            "navStatus": "Under way using engine",
            "position": {
                "latitude": 57.2343,
                "longitude": 10.3432
            },
            "sog": 12.3
        },
        "static": {
            "height": 15.0,
            "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
            "imo": 1000001,
            "length": 230.0,
            "mmsi": 123456789,
            "name": "RMS Titanic",
            "shipType": "Fishing",
            "speedMax": 20.0,
            "width": 30.0
        },
        "waypoints": [
            {
                "data": {
                    "heading": {
                        "interpMethod": "linear",
                        "mAfterLegChange": 100.0,
                        "mBeforeLegChange": 100.0,
                        "value": 12.3
                    },
                    "sog": {
                        "interpMethod": "linear",
                        "mAfterLegChange": 100.0,
                        "mBeforeLegChange": 100.0,
                        "value": 12.3
                    }
                },
                "position": {
                    "latitude": 57.2343,
                    "longitude": 10.3432
                },
                "turnRadius": 500.0
            }
        ]
    }
]

environment

Default: null

environmental parameters

Any of

• Environment
• Option 2

Type: object

airTemperature

Airtemperature

Type: number Default: null

The air temperature in degrees Celsius

Example:

20.0

waterRemperature

Waterremperature

Type: number Default: null

The water temperature in degrees Celsius

Example:

15.0

precipitation

Type: enum (of string) Default: null

The type of precipitation

Must be one of:

• "None"
• "Rain"
• "Snow"
• "Sleet"
• "Hail"

Example:

"Rain"

windSpeed

Windspeed

Type: number Default: null

The wind speed in m/s

Example:

10.0

windDirection

Winddirection

Type: number Default: null

The wind direction in degrees

Example:

180.0

currentSpeed

Currentspeed

Type: number Default: null

The current speed in m/s

Example:

1.0

currentDirection

Currentdirection

Type: number Default: null

The current direction in degrees

Example:

90.0

waveSpectrum

Type: enum (of string) Default: null

The wave spectrum

Must be one of:

• "JONSWAP"
• "Pierson-Moskowitz"
• "Bretschneider"

Example:

"JONSWAP"

significantWaveHeight

Significantwaveheight

Type: number Default: null

The significant wave height in meters

Example:

3.0

wavePeriod

Waveperiod

Type: number Default: null

The wave period in seconds

Example:

12.0

waveDirection

Wavedirection

Type: number Default: null

The wave direction in degrees

Example:

270.0

visibility

Visibility

Type: number Default: null

The visibility in nautical miles

Example:

5.0

conditions

Type: enum (of string) Default: null

The overall weather conditions

Must be one of:

• "Clear"
• "Cloudy"
• "Foggy"
• "Rainy"
• "Snowy"

Example:

"Clear"

Type: null

Example:

{
    "airTemperature": 20.0,
    "conditions": "Clear",
    "currentDirection": 90.0,
    "currentSpeed": 1.0,
    "precipitation": "Rain",
    "significantWaveHeight": 3.0,
    "visibility": 5.0,
    "waterRemperature": 15.0,
    "waveDirection": 270.0,
    "wavePeriod": 12.0,
    "waveSpectrum": "JONSWAP",
    "windDirection": 180.0,
    "windSpeed": 10.0
}

Additional Properties

Additional Properties of any type are allowed.

Type: object