openapi: 3.0.3
info:
  title: VRt.Routing [RT]
  version: 7.9.2527
  license:
    name: Proprietary
    url: https://veeroute.com/
  termsOfService: https://veeroute.com/resources/terms_of_service
  contact:
    name: Veeroute Support Team
    email: servicedesk@veeroute.com
  x-logo:
    url: ../images/routing.svg
    backgroundColor: '#FAFAFA'
    altText: VRt.Routing
  description: '# Description


    **VRt.Routing** is designed to find a route between locations and build time-distance
    matrices.


    ## Features


    * Getting the distance and time between two locations, including traffic jams

    * Finding a route between specified locations

    * Creating a time-distance matrix


    ## Entity relationship diagram


    ![erd](../uml/routing.svg)

    '
servers:
- url: https://api.edge7.veeroute.cloud
  description: Environment for integration and early access to the new features
- url: https://api.prod7.veeroute.cloud
  description: Production environment
security:
- ApiKeyAuth: []
tags:
- name: Route
  description: 'Building a path of movement between geographic points.

    '
- name: Matrix
  description: 'Build a routing matrix.


    To build the matrix, the `geo_provider` parameter is not taken into account; the
    default geo-provider is always used.

    '
- name: System
  description: 'System functions.

    Auxiliary functionality common to all services.

    '
externalDocs:
  description: Veeroute company website
  url: https://veeroute.com/
paths:
  /routing/route/calculation:
    post:
      tags:
      - Route
      summary: Route between points
      description: 'Constructing a route between points, taking into account the specified
        order and time at each stop. When specifying the departure time `departure_time`,
        traffic jams are taken into account.

        '
      operationId: run_route_calculation
      requestBody:
        description: New request for route calculation.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route_task'
            examples:
              RouteTaskMoscow:
                $ref: '#/components/examples/RouteTaskMoscow'
      responses:
        '200':
          description: The route has been successfully built
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_result'
              examples:
                RouteResultMoscow:
                  $ref: '#/components/examples/RouteResultMoscow'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
      x-codeSamples:
      - lang: Python
        source: "from vrt_lss_routing import *\nfrom vrt_lss_routing.apis import *\n\
          from vrt_lss_routing.models import *\n\n# settings\nHOST = 'https://api.edge7.veeroute.cloud'\
          \ # production env https://api.prod7.veeroute.cloud'\nTOKEN = 'PASTETOKENHERE'\n\
          \n# create client and api instance\nconfiguration = Configuration()\nconfiguration.host\
          \ = HOST\nconfiguration.access_token = TOKEN\nclient = ApiClient(configuration)\n\
          api = RouteApi(client)\n\n# create task\ntask = RouteTask(transport_type=TransportType.CAR,\n\
          \                 waypoints=[\n                     Waypoint(latitude=59.9345,\
          \ longitude=30.1504),\n                     Waypoint(latitude=59.9423, longitude=30.2589),\n\
          \                     Waypoint(latitude=59.9545, longitude=30.2004)]\n \
          \                )\n\n# simple get route\nresponse = api.build_route(task)\n\
          print('answer:', response)\n\n# get route with full http info\nresponse\
          \ = api.build_route(task, _preload_content=False)\nprint('status:', response.status)\n\
          print('answer:', response.data)\nprint('headers:', response.headers)\n"
  /routing/matrix/calculation:
    post:
      tags:
      - Matrix
      summary: Time-distance matrix
      description: 'Creating time-distance matrices between each pair of locations.
        The result of this method may slightly differ from the `route` method.

        '
      operationId: run_matrix_calculation
      requestBody:
        description: New request for matrix calculation.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/matrix_task'
            examples:
              MatrixTaskMoscow:
                $ref: '#/components/examples/MatrixTaskMoscow'
      responses:
        '200':
          description: The matrix has been successfully built
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/matrix_result'
              examples:
                MatrixResultMoscow:
                  $ref: '#/components/examples/MatrixResultMoscow'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/system/check:
    get:
      tags:
      - System
      summary: Checking the availability
      description: Checking the service availability.
      operationId: check
      security: []
      responses:
        '200':
          description: Successful execution
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/system/version:
    get:
      tags:
      - System
      summary: Getting the service version
      description: Getting the service version.
      operationId: version
      security: []
      responses:
        '200':
          description: Successful execution
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/version_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/file/{filename}:
    parameters:
    - $ref: '#/components/parameters/filename'
    get:
      tags:
      - System
      summary: Getting the documentation
      description: Getting the file with this service documentation.
      operationId: file
      security: []
      responses:
        '200':
          description: Successful execution
          content:
            text/html:
              schema:
                $ref: '#/components/schemas/file_html'
            text/plain:
              schema:
                $ref: '#/components/schemas/file_json'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
components:
  securitySchemes:
    ApiKeyAuth:
      description: "For client [authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)\
        \ \n[JWT token](https://en.wikipedia.org/wiki/JSON_Web_Token) is used,\nwhich\
        \ must be specified in the header for each request in the format:\n\n`Authorization:\
        \ Bearer <token>`.\n\nToken can be obtained via VRt.Account API.\n"
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    geopoint:
      description: Geographical point.
      type: object
      additionalProperties: false
      properties:
        latitude:
          description: Latitude in degrees.
          type: number
          format: double
          minimum: -90
          maximum: 90
          example: 55.692789
        longitude:
          description: Longitude in degrees.
          type: number
          format: double
          minimum: -180
          maximum: 180
          example: 37.554554
      required:
      - latitude
      - longitude
    time_duration_null:
      description: Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
      type: string
      format: duration
      x-custom-format: duration
      pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$
      minLength: 3
      maxLength: 16
      nullable: true
      default: null
      example: PT2H12M34.3S
    route_waypoint:
      description: 'A waypoint with the time of the stop at it.

        '
      type: object
      additionalProperties: false
      properties:
        geopoint:
          $ref: '#/components/schemas/geopoint'
        name:
          description: 'Name of the point. Can be used as an identifier to match the
            task and the calculation result.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
        departure_time:
          description: 'Departure date and time in [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format. If specified, replaces the estimated time. If it is set for one
            point, it must be set for all.

            '
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-11-21T09:30:00+03:00'
        duration:
          $ref: '#/components/schemas/time_duration_null'
          description: Stop duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
      required:
      - geopoint
    transport_type:
      description: "Transport types:\n  * `CAR` - car\n  * `TRUCK_1500` - truck with\
        \ permissible weight 1500 kg\n  * `TRUCK_3000` - truck with permissible weight\
        \ 3000 kg\n  * `TRUCK_5000` - truck with permissible weight 5000 kg\n  * `TRUCK_10000`\
        \ - truck with permissible weight 10000 kg\n  * `TRUCK_20000` - truck with\
        \ permissible weight 20000 kg\n  * `TRUCK_10000_L75_H35_W24_6000` - a truck\
        \ with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5\
        \ x 2.4 meters, and a permissible axle load of 6,000 kg\n  * `TRUCK_18000_L95_H40_W26_11000`\
        \ - a truck with a permitted weight of no more than 18,000 kg, dimensions\
        \ of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg\n  *\
        \ `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no\
        \ more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible\
        \ axle load of 8000 kg\n  * `TRUCK_GARBAGE_1` - truck for transporting garbage\
        \ (type 1)\n  * `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2)\n\
        \  * `TUK_TUK` - tuk-tuk\n  * `BICYCLE` - bicycle\n  * `PEDESTRIAN` - pedestrian\
        \      \n  * `PUBLIC_TRANSPORT` - public transport\n  * `TELEPORT` - teleport\
        \ (instant movement between points)\n  \n  Permissible weight is the weight\
        \ of the equipped transport with cargo and driver, set by the manufacturer\
        \ as the maximum allowable.\n"
      type: string
      enum:
      - CAR
      - TRUCK_1500
      - TRUCK_3000
      - TRUCK_5000
      - TRUCK_10000
      - TRUCK_20000
      - TRUCK_10000_L75_H35_W24_6000
      - TRUCK_18000_L95_H40_W26_11000
      - TRUCK_26000_L120_H40_W26_8000
      - TRUCK_GARBAGE_1
      - TRUCK_GARBAGE_2
      - TUK_TUK
      - BICYCLE
      - PEDESTRIAN
      - PUBLIC_TRANSPORT
      - TELEPORT
      default: CAR
      example: CAR
    geo_provider:
      description: "Geodata provider:\n  * `VRT` - geo-data and traffic jams from\
        \ Veeroute, work all over the world.\n\nA specific provider may be specified\
        \ for a specific region, availability depending on customer settings.\n"
      type: string
      default: VRT
      minLength: 3
      maxLength: 256
      example: VRT
    geo_settings:
      description: 'Geodata usage settings.

        '
      type: object
      additionalProperties: false
      properties:
        geo_provider:
          $ref: '#/components/schemas/geo_provider'
        toll_roads:
          description: Use toll roads.
          type: boolean
          default: true
          example: false
        ferry_crossing:
          description: Use ferry crossing.
          type: boolean
          default: true
          example: false
        traffic_jams:
          description: Accounting for traffic during the route planning.
          type: boolean
          default: true
          example: false
        flight_distance:
          description: 'Use for calculating straight line distances. If `false` is
            specified, distances are calculated by roads. When this parameter is enabled,
            geo-provider not used and traffic (`traffic_jams`) is automatically disabled.

            '
          type: boolean
          default: false
          example: true
    timezone:
      description: Timezone.
      type: integer
      format: int32
      minimum: -12
      maximum: 12
      default: 0
      example: 3
    dataset_name:
      description: 'The name of the dataset.

        A technical field that does not affect calculation.

        '
      type: string
      minLength: 0
      maxLength: 512
      default: ''
      example: custom_dataset_one
    route_task:
      description: 'Task for route planning. The departure time considers traffic
        jams.

        '
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: Array of geographical points to build path between them.
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/route_waypoint'
        transport_type:
          $ref: '#/components/schemas/transport_type'
        geo_settings:
          $ref: '#/components/schemas/geo_settings'
        departure_time:
          description: Departure date and time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-11-21T09:30:00+03:00'
        result_timezone:
          $ref: '#/components/schemas/timezone'
          description: Time zone for calculation results.
        detail:
          description: Building a detailed route - adds paths from points that are
            not on roads to nearby roads.
          type: boolean
          default: false
          example: true
        full_segments:
          description: 'Return a complete list of route segments. If the option is
            disabled, a short list is returned for simplified route display.

            '
          type: boolean
          default: true
          example: false
        polyline:
          description: Generate a polyline between points.
          type: boolean
          default: true
          example: false
        trackpoint_time:
          description: Generate times at intermediate points along the track.
          type: boolean
          default: false
          example: true
        dataset_name:
          $ref: '#/components/schemas/dataset_name'
      required:
      - waypoints
    process_code:
      description: 'Unique process identifier. One is created per process, the same
        for different requests for the same process.

        '
      type: string
      format: uuid
      example: 11111111-2222-3333-4444-555555555555
    request_code:
      description: 'Unique identifier of the request. A new one is created for each
        request.

        '
      type: string
      format: uuid
      example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
    user_username:
      description: Unique username for login.
      type: string
      pattern: \w+
      minLength: 2
      maxLength: 256
      example: username_for_login
    company_key:
      description: Unique company key.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: smart_company
    service:
      description: Service name.
      type: string
      enum:
      - UNIVERSAL
      - ROUTING
      - ACCOUNT
      - ADMIN
      - STUDIO
      - MONITOR
      - PACKER
      - AGRO
      example: UNIVERSAL
    operation:
      description: Operation (request) name.
      type: string
      minLength: 3
      maxLength: 256
      example: run_plan_calculation
    tracedata:
      description: Data for request tracing.
      type: object
      additionalProperties: false
      properties:
        process_code:
          $ref: '#/components/schemas/process_code'
        request_code:
          $ref: '#/components/schemas/request_code'
        username:
          $ref: '#/components/schemas/user_username'
        company:
          $ref: '#/components/schemas/company_key'
        service:
          $ref: '#/components/schemas/service'
        operation:
          $ref: '#/components/schemas/operation'
        env:
          description: Environment identifier.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: edge7
        pod:
          description: Pod identifier.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: 11111111-2222-3333-4444-555555555555
        time:
          description: Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2024-11-21T09:30:00+03:00'
      required:
      - process_code
      - request_code
      - username
      - company
      - service
      - operation
      - env
      - pod
      - time
    trackpoint:
      description: A geographic point with a time reference.
      type: object
      additionalProperties: false
      properties:
        latitude:
          description: Latitude in degrees.
          type: number
          format: double
          minimum: -90
          maximum: 90
          example: 55.692789
        longitude:
          description: Longitude in degrees.
          type: number
          format: double
          minimum: -180
          maximum: 180
          example: 37.554554
        time:
          description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-11-21T09:30:00+03:00'
      required:
      - latitude
      - longitude
    geotrack:
      description: An array of geographic points with time reference between which
        a path is built.
      type: array
      minItems: 0
      maxItems: 1000000
      uniqueItems: false
      items:
        $ref: '#/components/schemas/trackpoint'
    route_step:
      description: Route segment step (a separate step for a separate type of transports).
      type: object
      additionalProperties: false
      properties:
        transport_type:
          $ref: '#/components/schemas/transport_type'
        polyline:
          $ref: '#/components/schemas/geotrack'
      required:
      - transport_type
      - polyline
    time_window:
      description: Time window.
      type: object
      additionalProperties: false
      nullable: true
      properties:
        from:
          description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2024-11-21T09:30:00+03:00'
        to:
          description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2024-11-21T19:45:00Z'
      required:
      - from
      - to
    time_duration:
      description: Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
      type: string
      format: duration
      x-custom-format: duration
      pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$
      minLength: 3
      maxLength: 16
      default: PT0S
      example: PT1H45M
    route_statistics:
      description: 'General route statistics.

        '
      type: object
      additionalProperties: false
      properties:
        time_window:
          $ref: '#/components/schemas/time_window'
          description: Time window for the beginning and end of the movement.
        distance:
          description: Total length, in meters.
          type: integer
          format: int32
          minimum: 0
          maximum: 40000000
          example: 7000
        duration:
          $ref: '#/components/schemas/time_duration'
          description: Travel time, in [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
        stopping_time:
          $ref: '#/components/schemas/time_duration'
          description: Total duration of stops at points, in [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
      required:
      - time_window
      - distance
      - duration
      - stopping_time
    route_leg:
      description: The route leg between two locations.
      type: object
      additionalProperties: false
      properties:
        steps:
          description: Steps required to pass a route leg.
          type: array
          uniqueItems: false
          minItems: 0
          maxItems: 16
          items:
            $ref: '#/components/schemas/route_step'
        departure_name:
          description: 'Name of the departure point. Filled in if specified in the
            source data.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
        destination_name:
          description: 'Name of the destination. Filled in if specified in the source
            data.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_2
        statistics:
          $ref: '#/components/schemas/route_statistics'
      required:
      - steps
      - statistics
    route:
      description: Information about the planned route.
      type: object
      additionalProperties: false
      properties:
        legs:
          description: Route segments between locations specified in the parameter
            `waypoints`.
          type: array
          uniqueItems: false
          minItems: 0
          maxItems: 10000000
          items:
            $ref: '#/components/schemas/route_leg'
        statistics:
          $ref: '#/components/schemas/route_statistics'
      required:
      - legs
      - statistics
    route_result:
      description: Routing result.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        route:
          $ref: '#/components/schemas/route'
      required:
      - tracedata
      - route
    general_400:
      description: 400 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error message.
          type: string
          nullable: true
          example: Bad Request
      required:
      - tracedata
    general_402:
      description: 402 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error message.
          type: string
          nullable: true
          example: Payment Required
      required:
      - tracedata
    general_404:
      description: 404 Error details.
      type: object
      additionalProperties: false
      properties:
        resource_key:
          description: Resource identifier.
          type: string
          nullable: true
          default: null
          example: resource_key
        detail:
          description: Resource details.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            tracedata:
              $ref: '#/components/schemas/tracedata'
          required:
          - tracedata
    general_429:
      description: 429 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error Message.
          type: string
          nullable: true
          example: Too many requests
      required:
      - tracedata
    general_500:
      description: 500 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error message.
          type: string
          nullable: true
          example: Internal Server Error
      required:
      - tracedata
    routing_matrix_waypoint:
      description: 'Routing matrix waypoint.

        '
      type: object
      additionalProperties: false
      properties:
        geopoint:
          $ref: '#/components/schemas/geopoint'
        name:
          description: 'Name of the point. Can be used as an identifier to match the
            task and the calculation result.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
      required:
      - geopoint
    matrix_task:
      description: Task for calculating a matrix.
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: 'Array of geographical points to calculate the distances and
            times between them. The for all matrices (with different `transport_type`)
            must be in the same order.

            '
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_waypoint'
        transport_type:
          $ref: '#/components/schemas/transport_type'
        geo_settings:
          $ref: '#/components/schemas/geo_settings'
        departure_time:
          description: Departure date and time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-11-21T09:30:00+03:00'
        dataset_name:
          $ref: '#/components/schemas/dataset_name'
      required:
      - waypoints
    routing_matrix_line:
      description: Values line in the route distances matrix (in meters) or in the
        route durations matrix (in seconds), between points.
      type: array
      minItems: 2
      maxItems: 15001
      uniqueItems: false
      items:
        description: 'Route distance (in meters) or duration (in seconds) between
          locations. A negative value (-1) means that it is not possible to drive
          between the specified locations.

          '
        type: integer
        format: int64
        minimum: -1
        maximum: 10000000
        example: 1500
    routing_matrix:
      description: 'Routing matrix. Contains durations and distances between points.

        '
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: Array of geographical points with distances and times calculated
            between them.
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_waypoint'
        distances:
          description: 'Routes length between two neighbors locations, in meters.         The
            values in the array are ordered according to the elements order in the
            `waypoints` parameter. Each matrix row is an array of distances from the
            desired point to every other point.

            '
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_line'
        durations:
          description: 'Array of route durations between two neighbors locations,
            in seconds. The values in the array are ordered according to the elements
            order in the `waypoints` parameter. Each matrix row is an array of distances
            from the desired point to every other point.

            '
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_line'
      required:
      - waypoints
      - distances
      - durations
    matrix_result:
      description: Matrix calculation result.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        matrix:
          $ref: '#/components/schemas/routing_matrix'
      required:
      - tracedata
      - matrix
    check_result:
      description: Service availability result.
      type: object
      additionalProperties: false
      properties:
        health:
          description: "The current health indicator of the service.\n  * `0.0` means\
            \ the service is not ready to perform tasks.\n  * `1.0` means the service\
            \ is fully ready to perform tasks.\n"
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.999
      required:
      - health
    version_result:
      description: Service version.
      type: object
      additionalProperties: false
      properties:
        major:
          description: 'Product version.

            Within a single version, compatibility of common data structures between
            services is guaranteed.

            A version change indicates changes that are incompatible with previous
            versions of the product (and all services).

            '
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 7
        minor:
          description: 'Minor version of the service.

            A version change indicates new functionality.

            The update is backward compatible with the major version of the service.

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 111
          example: 5
        build:
          description: "Build version.      \nContains backwards compatible bug fixes\
            \ and docs update.\n"
          type: string
          minLength: 1
          maxLength: 64
          example: 3754RC
      required:
      - major
      - minor
      - build
    file_html:
      description: File with data in [HTML](https://html.spec.whatwg.org/) format.
      type: string
    file_json:
      description: File with data in [JSON](https://www.json.org/) format.
      type: string
  examples:
    RouteTaskMoscow:
      summary: Moscow
      value:
        transport_type: CAR
        detail: true
        polyline: true
        waypoints:
        - name: waypoint_01
          duration: PT10M
          geopoint:
            latitude: 55.7464
            longitude: 37.493
        - name: waypoint_02
          duration: PT10M
          geopoint:
            latitude: 55.6044
            longitude: 37.6639
        - name: waypoint_03
          duration: PT10M
          geopoint:
            latitude: 55.7305
            longitude: 37.7387
        - name: waypoint_04
          duration: PT10M
          geopoint:
            latitude: 55.7329
            longitude: 37.6437
        - name: waypoint_05
          duration: PT10M
          geopoint:
            latitude: 55.7974
            longitude: 37.7994
    RouteResultMoscow:
      summary: Moscow
      value:
        tracedata:
          process_code: 11111111-2222-3333-4444-555555555555
          request_code: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
          username: example_username
          company: example_company
          env: edge7
          pod: aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee
          service: ROUTING
          operation: run_route_calculation
          time: '2024-11-23T15:38:46.819189Z'
        route:
          legs:
          - steps:
            - transport_type: CAR
              polyline:
              - latitude: 55.746479
                longitude: 37.49293
                time: '2024-11-23T15:42:41Z'
              - latitude: 55.746405
                longitude: 37.492664
                time: '2024-11-23T15:42:42Z'
              - latitude: 55.746625
                longitude: 37.492461
                time: '2024-11-23T15:42:43Z'
            departure_name: waypoint_01
            destination_name: waypoint_02
            statistics:
              distance: 17101
              time_window:
                from: '2024-11-23T17:58:45Z'
                to: '2024-11-23T18:35:45Z'
              duration: PT27M
              stopping_time: PT10M
          statistics:
            distance: 17101
            time_window:
              from: '2024-11-23T17:58:45Z'
              to: '2024-11-23T18:35:45Z'
            duration: PT27M
            stopping_time: PT10M
    MatrixTaskMoscow:
      summary: Moscow
      value:
        transport_type: CAR
        waypoints:
        - name: waypoint_01
          geopoint:
            latitude: 55.7464
            longitude: 37.493
        - name: waypoint_02
          geopoint:
            latitude: 55.6044
            longitude: 37.6639
        - name: waypoint_03
          geopoint:
            latitude: 55.7305
            longitude: 37.7387
        - name: waypoint_04
          geopoint:
            latitude: 55.7329
            longitude: 37.6437
        - name: waypoint_05
          geopoint:
            latitude: 55.7974
            longitude: 37.7994
    MatrixResultMoscow:
      summary: Moscow
      value:
        tracedata:
          process_code: 11111111-2222-3333-4444-555555555555
          request_code: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
          username: example_username
          company: example_company
          env: edge7
          pod: aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee
          service: ROUTING
          operation: run_matrix_calculation
          time: '2024-11-23T15:42:47.418015Z'
        matrix:
          waypoints:
          - geopoint:
              latitude: 55.7305
              longitude: 37.7387
            name: waypoint_03
          - geopoint:
              latitude: 55.7464
              longitude: 37.493
            name: waypoint_01
          - geopoint:
              latitude: 55.6044
              longitude: 37.6639
            name: waypoint_02
          - geopoint:
              latitude: 55.7974
              longitude: 37.7994
            name: waypoint_05
          - geopoint:
              latitude: 55.7329
              longitude: 37.6437
            name: waypoint_04
          distances:
          - - 0
            - 20315
            - 37877
            - 24153
            - 17333
          - - 29204
            - 0
            - 15069
            - 20098
            - 9181
          - - 36075
            - 15410
            - 0
            - 23216
            - 16063
          - - 25718
            - 23050
            - 24467
            - 0
            - 12455
          - - 17072
            - 6901
            - 16961
            - 13555
            - 0
          durations:
          - - 0
            - 20
            - 28
            - 26
            - 18
          - - 23
            - 0
            - 16
            - 22
            - 9
          - - 27
            - 16
            - 0
            - 25
            - 17
          - - 26
            - 20
            - 24
            - 0
            - 14
          - - 18
            - 7
            - 17
            - 15
            - 0
  responses:
    '400':
      description: Bad request - input data contains errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_400'
    '401':
      description: Unauthorized - incorrect authorization details, token is missing
        or invalid
    '402':
      description: Payment Required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_402'
    '404':
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_404'
    '405':
      description: Method not allowed, check method (POST, GET, ...)
    '406':
      description: Client is unable to process a format of response, check headers
    '415':
      description: Unsupported media type, check headers
    '429':
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_429'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_500'
    '501':
      description: Not implemented
    '502':
      description: Bad gateway
    '503':
      description: Service unavailable
    '504':
      description: Gateway timeout
  parameters:
    filename:
      name: filename
      description: File name.
      in: path
      required: true
      schema:
        description: File name.
        type: string
        minLength: 6
        maxLength: 128
        example: file_en.html