Locations

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/digitraffic-fi/json-schema/digitraffic-fi-locations-schema.json",
  "title": "Locations",
  "description": "GeoJSON FeatureCollection",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/digitraffic-fi-marine-api-openapi.yml#/components/schemas/Locations",
  "required": [
    "features",
    "type"
  ],
  "type": "object",
  "properties": {
    "features": {
      "type": "array",
      "items": {
        "required": [
          "geometry",
          "properties",
          "type"
        ],
        "type": "object",
        "properties": {
          "geometry": {
            "required": [
              "coordinates",
              "type"
            ],
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "coordinates": {
                "maxItems": 3,
                "minItems": 2,
                "type": "array",
                "items": {
                  "type": "number"
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "Point"
                ]
              }
            },
            "additionalProperties": false
          },
          "type": {
            "type": "string",
            "enum": [
              "Feature"
            ]
          },
          "properties": {
            "required": [
              "locodeList",
              "name",
              "nationality",
              "restrictions",
              "suspensions",
              "type",
              "winterport"
            ],
            "type": "object",
            "properties": {
              "nationality": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "suspensions": {
                "type": "array",
                "items": {
                  "required": [
                    "dueTo",
                    "endTime",
                    "portsClosed",
                    "prenotification",
                    "specifications",
                    "startTime"
                  ],
                  "type": "object",
                  "properties": {
                    "prenotification": {
                      "type": "boolean",
                      "description": "Whether suspension is announced to users before it starts."
                    },
                    "portsClosed": {
                      "type": "boolean",
                      "description": "Bit indicating whether the port is entirely closed to all operations."
                    },
                    "dueTo": {
                      "type": "string",
                      "description": "Main reason for port suspension."
                    },
                    "startTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "endTime": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    },
                    "specifications": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "More specific reason for port suspension. "
                    }
                  },
                  "additionalProperties": false,
                  "description": "Information on port suspensions."
                }
              },
              "locodeList": {
                "type": "string",
                "description": "Comma separated list of UN locodes."
              },
              "restrictions": {
                "type": "array",
                "items": {
                  "required": [
                    "endTime",
                    "startTime",
                    "textCompilation"
                  ],
                  "type": "object",
                  "properties": {
                    "textCompilation": {
                      "type": "string",
                      "description": "Textual presentation of the restriction."
                    },
                    "startTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "endTime": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    }
                  },
                  "additionalProperties": false,
                  "description": "Assistance restrictions are restrictions published by authorities that target a specific location for a range of time."
                }
              },
              "winterport": {
                "type": "boolean",
                "description": "Boolean indicating whether a port is a winterport or not."
              },
              "type": {
                "type": "string",
                "description": "Type of location. PORT or FAIRWAY, but there could be more in the future."
              }
            },
            "additionalProperties": false,
            "description": "Locations are points of interest on a map, usually ports, that can have restrictions placed on them."
          }
        },
        "additionalProperties": false,
        "description": "GeoJSON Feature"
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "FeatureCollection"
      ]
    }
  },
  "additionalProperties": false
}