Digitraffic (Fintraffic) Traffic Restriction Notifications API

openapi: 3.2.0
info:
  title: rata.digitraffic.fi Traffic Restriction Notifications API
  version: '1.0'
  description: 'OpenAPI document


    Digitraffic is a service operated by Fintraffic, offering real time traffic information. Currently the service covers *road, marine and rail* traffic. More information can be found at the Digitraffic website


    The service has a public Google-group rail.digitraffic.fi for communication between developers, service administrators and Fintraffic. The discussion in the forum is mostly in Finnish, but you''re welcome to communicate in English too.


    ### General notes of the API

    * Many Digitraffic APIs use the GeoJSON format. The definition of GeoJSON can be found at https://tools.ietf.org/html/rfc7946.

    * For dates and times, the ISO 8601 format is used with "Zulu" zero offset from UTC unless otherwise specified (i.e., "yyyy-mm-ddThh:mm:ss[.mmm]Z"). E.g. 2019-11-01T06:30:00Z.'
  termsOfService: https://www.digitraffic.fi/en/terms-of-service/
  contact:
    name: Digitraffic / Fintraffic
    url: https://www.digitraffic.fi/
  license:
    name: Creative Commons 4.0 BY
    url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://rata.digitraffic.fi
tags:
- name: traffic-restriction-notifications
  description: Returns traffic restriction notifications
paths:
  /api/v1/trafficrestriction-notifications/{id}:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns all versions of a trafficrestriction notification or an empty list if…
      operationId: getTrafficRestrictionNotificationsById
      parameters:
      - name: id
        in: path
        description: Traffic restriction notification identifier
        required: true
        schema:
          type: string
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TrafficRestrictionNotificationWithVersions'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications/{id}/{version}:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns a specific version of a trafficrestriction notification or an empty…
      operationId: getTrafficRestrictionNotificationsByVersion
      parameters:
      - name: id
        in: path
        description: Traffic restriction notification identifier
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: Traffic restriction notification version
        required: true
        schema:
          type: integer
          format: int64
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpatialTrafficRestrictionNotification'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications/{id}/latest.json:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns the latest version of a trafficrestriction notification in JSON format…
      operationId: getLatestTrafficRestrictionNotificationById
      parameters:
      - name: id
        in: path
        description: Traffic restriction notification identifier
        required: true
        schema:
          type: string
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpatialTrafficRestrictionNotification'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications/{id}/latest.geojson:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns the latest version of a trafficrestriction notification in GeoJSON…
      operationId: getLatestTrafficRestrictionNotificationByIdGeoJson
      parameters:
      - name: id
        in: path
        description: Traffic restriction notification identifier
        required: true
        schema:
          type: string
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FeatureCollection'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications/status:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns ids and latest versions of all trafficrestriction notifications…
      operationId: getAllTrafficRestrictionNotifications
      parameters:
      - name: start
        in: query
        description: Start time. If missing, current date - 7 days is used.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-01-01T00:00:00.000Z'
      - name: end
        in: query
        description: End time. If missing, current date is used.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-02-02T10:10:10.000Z'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RumaNotificationIdAndVersion'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications.json:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns newest versions of trafficrestriction notifications by state in JSON…
      operationId: getTrafficRestrictionNotificationsByStateJson
      parameters:
      - name: state
        in: query
        description: State of traffic restriction notification
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - FINISHED
            - SENT
            - DRAFT
            - REMOVED
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      - name: start
        in: query
        description: Start time. If missing, current date - 7 days.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-01-01T00:00:00.000Z'
      - name: end
        in: query
        description: End time. If missing, current date is used.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-02-02T10:10:10.000Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpatialTrafficRestrictionNotification'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
  /api/v1/trafficrestriction-notifications.geojson:
    get:
      tags:
      - traffic-restriction-notifications
      summary: Returns newest versions of trafficrestriction notifications by state in GeoJSON…
      operationId: getTrafficRestrictionNotificationsByStateGeoJson
      parameters:
      - name: state
        in: query
        description: State of traffic restriction notification
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - FINISHED
            - SENT
            - DRAFT
            - REMOVED
      - name: schema
        in: query
        description: Show map or schema locations
        required: false
        schema:
          type: boolean
          example: false
          default: false
        example: false
      - name: start
        in: query
        description: Start time. If missing, current date - 7 days is used.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-01-01T00:00:00.000Z'
      - name: end
        in: query
        description: End time. If missing, current date is used.
        required: false
        schema:
          type: string
          format: date-time
        example: '2019-02-02T10:10:10.000Z'
      responses:
        '200':
          description: OK
          content:
            application/vnd.geo+json:
              schema:
                $ref: '#/components/schemas/FeatureCollection'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          content: {}
components:
  schemas:
    Geometry:
      type: object
      properties:
        envelope:
          $ref: '#/components/schemas/Geometry'
        factory:
          $ref: '#/components/schemas/GeometryFactory'
        userData:
          type: object
        length:
          type: number
          format: double
        empty:
          type: boolean
        valid:
          type: boolean
        dimension:
          type: integer
          format: int32
        simple:
          type: boolean
        numGeometries:
          type: integer
          format: int32
        envelopeInternal:
          $ref: '#/components/schemas/Envelope'
        coordinate:
          $ref: '#/components/schemas/Coordinate'
        precisionModel:
          $ref: '#/components/schemas/PrecisionModel'
        srid:
          type: integer
          format: int32
        geometryType:
          type: string
        coordinates:
          type: array
          items:
            $ref: '#/components/schemas/Coordinate'
        numPoints:
          type: integer
          format: int32
        rectangle:
          type: boolean
        area:
          type: number
          format: double
        centroid:
          $ref: '#/components/schemas/Point'
        interiorPoint:
          $ref: '#/components/schemas/Point'
        boundary:
          $ref: '#/components/schemas/Geometry'
        boundaryDimension:
          type: integer
          format: int32
    TrafficRestrictionNotificationWithVersions:
      title: TrafficRestrictionNotificationWithVersions
      type: object
      properties:
        id:
          type: string
          description: Traffic restriction notification id
        versions:
          type: array
          description: Traffic resctriction notification versions
          items:
            $ref: '#/components/schemas/SpatialTrafficRestrictionNotification'
    Feature:
      type: object
      properties:
        type:
          type: string
        geometry:
          $ref: '#/components/schemas/Geometry'
        properties:
          type: object
    CoordinateSequence:
      type: object
      properties:
        dimension:
          type: integer
          format: int32
        measures:
          type: integer
          format: int32
    IdentifierRange:
      title: IdentifierRange
      required:
      - notificationId
      type: object
      properties:
        notificationId:
          type: string
          description: Notification identifier
        elementId:
          type: string
          description: Identifier of element, required if element pair or ranges are not present
        elementPairId1:
          type: string
          description: Identifier of element 1 in element pair, required if element or ranges are not present
        elementPairId2:
          type: string
          description: Identifier of element 2 in element pair, required if element or ranges are not present
        speedLimit:
          $ref: '#/components/schemas/SpeedLimit'
        elementRanges:
          uniqueItems: true
          type: array
          description: Element ranges, required if element or element pair is not present
          items:
            $ref: '#/components/schemas/ElementRange'
      description: 'Place of work: between two track elements or a single track element'
    CoordinateSequenceFactory:
      type: object
    Envelope:
      type: object
      properties:
        'null':
          type: boolean
        height:
          type: number
          format: double
        diameter:
          type: number
          format: double
        width:
          type: number
          format: double
        minX:
          type: number
          format: double
        minY:
          type: number
          format: double
        maxX:
          type: number
          format: double
        maxY:
          type: number
          format: double
        area:
          type: number
          format: double
    Type:
      type: object
    SpatialTrafficRestrictionNotification:
      title: SpatialTrafficRestrictionNotification
      required:
      - created
      - id
      - limitation
      - location
      - locations
      - organization
      - startDate
      - state
      - version
      type: object
      properties:
        id:
          type: string
          description: Id
        state:
          type: string
          description: State
          enum:
          - FINISHED
          - SENT
          - DRAFT
          - REMOVED
        organization:
          type: string
          description: Which organization created this notification
        created:
          type: string
          description: When this notification was created
          format: date-time
        modified:
          type: string
          description: When this notification last modified
          format: date-time
        limitation:
          type: string
          description: Limitation type
          enum:
          - CLOSED_FROM_TRAFFIC
          - CLOSED_FROM_ELECTRIC_ROLLING_STOCK
          - TEMPORARY_SPEED_LIMIT
          - AXLE_WEIGHT_MAX
          - ATP_CONSTRUCTION_ZONE
          - SWITCH_LOCKED
          - FIREWORK_DANGER_ZONE
          - OTHER
        trackWorkNotificationId:
          type: string
          description: Track work notification identifier
        axleWeightMax:
          type: number
          description: Max axle weight, required if limitation type is max axle weight
          format: double
        startDate:
          type: string
          description: Start datetime
          format: date-time
        endDate:
          type: string
          description: End datetime
          format: date-time
        finished:
          type: string
          description: Finished datetime, required if state is finished
          format: date-time
        location:
          type: object
          description: Approximate location
        locations:
          uniqueItems: true
          type: array
          description: Locations
          items:
            $ref: '#/components/schemas/SpatialRumaLocation'
        version:
          type: integer
          description: Version
          format: int64
      description: Describes a restriction affecting the use of a railway infrastructure part
    Coordinate:
      type: object
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        z:
          type: number
          format: double
        valid:
          type: boolean
        m:
          type: number
          format: double
        coordinate:
          $ref: '#/components/schemas/Coordinate'
    PrecisionModel:
      type: object
      properties:
        scale:
          type: number
          format: double
        type:
          $ref: '#/components/schemas/Type'
        floating:
          type: boolean
        maximumSignificantDigits:
          type: integer
          format: int32
        offsetX:
          type: number
          format: double
        offsetY:
          type: number
          format: double
    GeometryFactory:
      type: object
      properties:
        precisionModel:
          $ref: '#/components/schemas/PrecisionModel'
        coordinateSequenceFactory:
          $ref: '#/components/schemas/CoordinateSequenceFactory'
        srid:
          type: integer
          format: int32
    Point:
      type: object
      properties:
        envelope:
          $ref: '#/components/schemas/Geometry'
        factory:
          $ref: '#/components/schemas/GeometryFactory'
        userData:
          type: object
        coordinates:
          type: array
          items:
            $ref: '#/components/schemas/Coordinate'
        empty:
          type: boolean
        dimension:
          type: integer
          format: int32
        simple:
          type: boolean
        coordinateSequence:
          $ref: '#/components/schemas/CoordinateSequence'
        coordinate:
          $ref: '#/components/schemas/Coordinate'
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        geometryType:
          type: string
        numPoints:
          type: integer
          format: int32
        boundary:
          $ref: '#/components/schemas/Geometry'
        boundaryDimension:
          type: integer
          format: int32
        length:
          type: number
          format: double
        valid:
          type: boolean
        numGeometries:
          type: integer
          format: int32
        envelopeInternal:
          $ref: '#/components/schemas/Envelope'
        precisionModel:
          $ref: '#/components/schemas/PrecisionModel'
        srid:
          type: integer
          format: int32
        rectangle:
          type: boolean
        area:
          type: number
          format: double
        centroid:
          $ref: '#/components/schemas/Point'
        interiorPoint:
          $ref: '#/components/schemas/Point'
    FeatureCollection:
      title: FeatureCollection
      type: object
      properties:
        type:
          type: string
        features:
          type: array
          items:
            $ref: '#/components/schemas/Feature'
    SpatialRumaLocation:
      title: SpatialRumaLocation
      required:
      - locationType
      - notificationId
      - workPartIndex
      type: object
      properties:
        notificationId:
          type: string
          description: Notification identifier
        workPartIndex:
          type: integer
          description: Track work part index
          format: int64
        locationType:
          type: string
          description: Type
          enum:
          - WORK
          - FIREWORK
          - SPEED_LIMIT
        operatingPointId:
          type: string
          description: Identifier of operating point, required if section is not present
        sectionBetweenOperatingPointsId:
          type: string
          description: Identifier of section between operating points, required if operating point is not present
        location:
          type: object
          description: Location if no identifer ranges are present
        identifierRanges:
          uniqueItems: true
          type: array
          description: Identifier ranges
          items:
            $ref: '#/components/schemas/IdentifierRange'
      description: Location of work, either an operating point or a section between operating points
    RumaNotificationIdAndVersion:
      title: RumaNotificationIdAndVersion
      type: object
      properties:
        id:
          type: string
          description: Id
        version:
          type: integer
          description: Version
          format: int64
        modified:
          type: string
          description: Last modified
          format: date-time
    SpeedLimit:
      title: SpeedLimit
      required:
      - balises
      - signs
      - speed
      type: object
      properties:
        speed:
          type: integer
          description: Speed limit value
          format: int32
        signs:
          type: boolean
          description: Speed limit signs used?
        balises:
          type: boolean
          description: Balises used?
      description: Speed limit set for a part of a track
    ElementRange:
      title: ElementRange
      required:
      - elementId1
      - elementId2
      - trackIds
      type: object
      properties:
        elementId1:
          type: string
          description: Identifier of element 1
        elementId2:
          type: string
          description: Identifier of element 2
        trackKilometerRange:
          type: string
          description: Track kilometer range, required if notification type is traffic restriction, e.g. (006) 754+0273 > 764+0771
        trackIds:
          type: array
          description: Track identifiers
          items:
            type: string
            description: Track identifiers
        specifiers:
          type: array
          description: Specify a more detailed work area (track element)
          items:
            type: string
            description: Specify a more detailed work area (track element)
      description: Two consecutive elements in an identifier range