openapi: 3.2.0
info:
  title: Automile Resource Owner Registered Toll V2 API
  version: v1
tags:
- name: ResourceOwnerRegisteredTollV2
paths:
  /v1/resourceowner/registeredtoll:
    get:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Get list of registered tolls
      operationId: ResourceOwnerRegisteredTollController_GetRegisteredTollList
      parameters:
      - in: query
        name: from
        description: 'Registered tolls from this timestamp (default: 60 days back)'
        schema:
          type: string
          format: date-time
      - in: query
        name: to
        description: 'Registered tolls until this timestamp (default: current timestamp)'
        schema:
          type: string
          format: date-time
      - in: query
        name: vehicleId
        description: 'If set, only list tolls registered for this specific vehicle (default: all accessible vehicles)'
        schema:
          type: integer
          format: int32
      - in: query
        name: driverContactId
        description: 'If set, only list tolls registered for this specific driver (default: all drivers)'
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Registered toll list successfully fetched
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredTollModelGET'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredTollModelGET'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegisteredTollModelGET'
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
    post:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Register a toll passage
      operationId: ResourceOwnerRegisteredTollController_SaveRegisteredToll
      responses:
        '200':
          description: Success
        '201':
          description: Successfully created
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPOST'
          text/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPOST'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPOST'
        description: Toll fee to register
  /v1/resourceowner/registeredtoll/multi-update:
    put:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Update multiple toll passage registrations
      operationId: ResourceOwnerRegisteredTollController_UpdateRegisteredTollList
      responses:
        '200':
          description: Successfully updated
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollBatchUpdateModelPUT'
          text/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollBatchUpdateModelPUT'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RegisteredTollBatchUpdateModelPUT'
        description: Toll fee registration list
  /v1/resourceowner/registeredtoll/{registeredTollId}:
    put:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Update a toll passage
      operationId: ResourceOwnerRegisteredTollController_UpdateRegisteredToll
      parameters:
      - in: path
        name: registeredTollId
        description: Which toll fee to edit
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successfully updated
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPUT'
          text/json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPUT'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RegisteredTollModelPUT'
        description: Toll fee information
    get:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Get registered toll
      operationId: ResourceOwnerRegisteredTollController_GetRegisteredToll
      parameters:
      - in: path
        name: registeredTollId
        description: Id of registered toll
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Registered toll list successfully fetched
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RegisteredTollModelGET'
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredTollModelGET'
            text/json:
              schema:
                $ref: '#/components/schemas/RegisteredTollModelGET'
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
    delete:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Delete registered toll fee
      operationId: ResourceOwnerRegisteredTollController_DeleteRegisteredToll
      parameters:
      - in: path
        name: registeredTollId
        description: The id for the registered toll to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Registered toll list successfully deleted
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
  /v1/resourceowner/registeredtoll/tollzone:
    get:
      tags:
      - ResourceOwnerRegisteredTollV2
      summary: Get the list of toll zones
      operationId: ResourceOwnerRegisteredTollController_GetTollZoneList
      responses:
        '200':
          description: Toll zone list successfully fetched
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TollZoneModelGET'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TollZoneModelGET'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TollZoneModelGET'
        '403':
          description: Forbidden access to resource
        '500':
          description: Internal server error
      security:
      - oauth2: []
components:
  schemas:
    RegisteredTollModelPUT:
      type: object
      properties:
        TimestampUtc:
          format: date-time
          type: string
        Fee:
          format: double
          type: number
        TripId:
          format: int32
          type: integer
        GeofenceId:
          format: int32
          type: integer
        TollZoneId:
          format: int32
          type: integer
        PriceAfterDiscount:
          format: double
          type: number
      additionalProperties: false
    RegisteredTollBatchUpdateModelPUT:
      type: object
      properties:
        RegisteredTollList:
          type: array
          items:
            $ref: '#/components/schemas/RegisteredTollMultiEditModelPUT'
      additionalProperties: false
    TollGeofenceModelGET:
      type: object
      properties:
        GeofenceId:
          format: int32
          type: integer
        Name:
          type: string
      additionalProperties: false
    RegisteredTollModelGET:
      type: object
      properties:
        TimestampUtc:
          format: date-time
          type: string
        Fee:
          format: double
          type: number
        TripId:
          format: int32
          type: integer
        GeofenceId:
          format: int32
          type: integer
        TollZoneId:
          format: int32
          type: integer
        PriceAfterDiscount:
          format: double
          type: number
        TollZoneName:
          type: string
        RegisteredTollId:
          format: int32
          type: integer
        VehicleId:
          format: int32
          type: integer
        VehicleUserFriendlyName:
          type: string
        VehicleMake:
          type: string
        VehicleModel:
          type: string
        VehicleNumberPlate:
          type: string
        DriverContactId:
          format: int32
          type: integer
        DriverImageUrl:
          type: string
        DriverName:
          type: string
        CurrencyISO4271:
          type: string
        ReadOnly:
          type: boolean
        TripType:
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
      additionalProperties: false
    RegisteredTollMultiEditModelPUT:
      type: object
      properties:
        TimestampUtc:
          format: date-time
          type: string
        Fee:
          format: double
          type: number
        TripId:
          format: int32
          type: integer
        GeofenceId:
          format: int32
          type: integer
        TollZoneId:
          format: int32
          type: integer
        PriceAfterDiscount:
          format: double
          type: number
        RegisteredTollId:
          format: int32
          type: integer
      additionalProperties: false
    TollZoneModelGET:
      type: object
      properties:
        TollZoneId:
          format: int32
          type: integer
        Name:
          type: string
        TollGeofenceList:
          type: array
          items:
            $ref: '#/components/schemas/TollGeofenceModelGET'
      additionalProperties: false
    RegisteredTollModelPOST:
      type: object
      properties:
        TimestampUtc:
          format: date-time
          type: string
        Fee:
          format: double
          type: number
        TripId:
          format: int32
          type: integer
        GeofenceId:
          format: int32
          type: integer
        TollZoneId:
          format: int32
          type: integer
        PriceAfterDiscount:
          format: double
          type: number
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://api.automile.com/login/
      description: OAuth2 Implicit Grant
x-provenance:
  method: harvested
  publisher: Automileab
  source: https://api.automile.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)