AppyWay Platform API

openapi: 3.0.1
info:
  title: AppyWay Platform API
  version: '1.0'
  description: >-
    AppyWay Platform API  allows developers to access a wide range of data
    related to parking, traffic, and mobility. With this API, developers can
    integrate real-time parking availability, traffic flow information, and
    electric vehicle charging locations into their own applications. This
    enables users to quickly find parking spaces, plan their routes to avoid
    congestion, and locate nearby charging stations for their electric vehicles.
    By leveraging the capabilities of the AppyWay Platform API, developers can
    create innovative solutions that improve the overall mobility experience for
    users.
servers:
  - url: https://api.appyway.com/v1/reference
paths:
  /changeCountrySpecialDays:
    post:
      tags:
        - Countries
      summary: AppyWay Change Country Special Days
      description: Change Country Special Days
      operationId: post-changecountryspecialdays
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCountrySpecialDaysCommand'
            example:
              specialDays:
                - id: string
                  name: string
                  isHoliday: true
                  dates:
                    - '2020-01-20'
              id: string
          text/json:
            schema:
              $ref: '#/components/schemas/ChangeCountrySpecialDaysCommand'
            example:
              specialDays:
                - id: string
                  name: string
                  isHoliday: true
                  dates:
                    - '2020-01-20'
              id: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/ChangeCountrySpecialDaysCommand'
            example:
              specialDays:
                - id: string
                  name: string
                  isHoliday: true
                  dates:
                    - '2020-01-20'
              id: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringOkResponse'
              example:
                success: true
                result: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
              example:
                success: true
                message: string
                errors:
                  - property: string
                    code: string
                    message: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /changeRegionVenues:
    post:
      tags:
        - Regions
      summary: AppyWay Change Region Venues
      description: Change Region Venues
      operationId: post-changeregionvenues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRegionVenuesCommand'
            example:
              venues:
                - id: string
                  name: string
                  eventsMustSupplyHours: true
                  events:
                    - name: string
                      date: '2020-01-20'
                      start: '2024-10-11'
                      end: '2024-10-11'
              id: string
          text/json:
            schema:
              $ref: '#/components/schemas/ChangeRegionVenuesCommand'
            example:
              venues:
                - id: string
                  name: string
                  eventsMustSupplyHours: true
                  events:
                    - name: string
                      date: '2020-01-20'
                      start: '2024-10-11'
                      end: '2024-10-11'
              id: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/ChangeRegionVenuesCommand'
            example:
              venues:
                - id: string
                  name: string
                  eventsMustSupplyHours: true
                  events:
                    - name: string
                      date: '2020-01-20'
                      start: '2024-10-11'
                      end: '2024-10-11'
              id: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringOkResponse'
              example:
                success: true
                result: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
              example:
                success: true
                message: string
                errors:
                  - property: string
                    code: string
                    message: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllActivityTypes:
    post:
      tags:
        - ActivityTypes
      summary: AppyWay Fetch All Activity Types
      description: Returns a list with all the activity types.
      operationId: post-fetchallactivitytypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AuthorityTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    canHaveRestrictions: true
                    canHaveShape: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllAuthorityTypes:
    post:
      tags:
        - AuthorityTypes
      summary: AppyWay Fetch All Authority Types
      description: Returns a list with all the authority types.
      operationId: post-fetchallauthoritytypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AuthorityTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    canHaveRestrictions: true
                    canHaveShape: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllBaseMaps:
    post:
      tags:
        - BaseMaps
      summary: AppyWay Fetch All Base Maps
      description: >-
        Return a list with all supported base maps and availability for
        supported countries.
      operationId: post-fetchallbasemaps
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseMapIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    availableInCountries:
                      - string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllCountries:
    post:
      tags:
        - Countries
      summary: AppyWay Fetch All Countries
      description: Returns a list with all the supported countries.
      operationId: post-fetchallcountries
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountryIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: string
                    name: string
                    specialDays:
                      - id: string
                        name: string
                        isHoliday: true
                        dates:
                          - '2020-01-20'
                    bounds:
                      -   - 0
                    defaultBaseMapId: 0
                    entitlementTypes:
                      - 0
                    restrictionTypes:
                      - 0
                    assetTypes:
                      - 0
                    countryCode: string
                    currencyCode: string
                    languageCode: string
                    hasMetricSpeedLimits: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllEntitlementTypes:
    post:
      tags:
        - EntitlementTypes
      summary: AppyWay Fetch All Entitlement Types
      description: Returns a list with all the entitlement types.
      operationId: post-fetchallentitlementtypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/EntitlementTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    code: string
                    restrictionTypeIds:
                      - 0
                    applicableExemptionTypeIds:
                      - 0
                    hasTariff: true
                    restrictionTypeLegalNames:
                      - restrictionTypeId: 0
                        legalName: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllExceptionTypes:
    post:
      tags:
        - ExceptionTypes
      summary: AppyWay Fetch All Exception Types
      description: Returns a list with all the exception types.
      operationId: post-fetchallexceptiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExceptionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllExemptionTimeTypes:
    post:
      tags:
        - ExemptionTimeTypes
      summary: AppyWay Fetch All Exemption Time Types
      description: Returns a list with all the exemption time types.
      operationId: post-fetchallexemptiontimetypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExemptionTimeTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllExemptionTypes:
    post:
      tags:
        - ExemptionTypes
      summary: AppyWay Fetch All Exemption Types
      description: Returns a list with all the exemption types.
      operationId: post-fetchallexemptiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExemptionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllFacilityTypes:
    post:
      tags:
        - FacilityTypes
      summary: AppyWay Fetch All Facility Types
      description: Returns a list with all the facility types.
      operationId: post-fetchallfacilitytypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityTypeIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllFuelTypes:
    post:
      tags:
        - FuelTypes
      summary: AppyWay Fetch All Fuel Types
      description: Returns a list with all the fuel types.
      operationId: post-fetchallfueltypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FuelTypeIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllMovingExceptionTypes:
    post:
      tags:
        - MovingExceptionTypes
      summary: AppyWay Fetch All Moving Exception Types
      description: Returns a list with all the moving exception types.
      operationId: post-fetchallmovingexceptiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/MovingExceptionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    applicableRestrictionTypes:
                      - movingRestrictionTypeId: 0
                        movingRestrictionTypeOptionIds:
                          - 0
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllMovingRestrictionTypes:
    post:
      tags:
        - MovingRestrictionTypes
      summary: AppyWay Fetch All Moving Restriction Types
      description: Returns a list with all the moving restriction types.
      operationId: post-fetchallmovingrestrictiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/MovingRestrictionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    property: string
                    unit: string
                    options:
                      - id: 0
                        name: string
                        value: 0
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllNoteVisibilityTypes:
    post:
      tags:
        - NoteVisibilityTypes
      summary: AppyWay Fetch All Note Visibility Types
      description: Returns a list with all the note visibility types.
      operationId: post-fetchallnotevisibilitytypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/NoteVisibilityTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllOffStreetRestrictionTypes:
    post:
      tags:
        - OffStreetRestrictionTypes
      summary: AppyWay Fetch All OffStreet Restriction Types
      description: Returns a list with all the off street restriction types.
      operationId: post-fetchalloffstreetrestrictiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RestrictionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    code: string
                    canHaveNoLoadingRules: true
                    canHaveTariff: true
                    canHaveEmptyEntitlements: true
                    defaultWidth: 0
                    isTroItem: true
                    legalName: string
                    hasBayCount: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllOnStreetParkingTypes:
    post:
      tags:
        - OnStreetParkingTypes
      summary: AppyWay Fetch All On-Street Parking Types
      description: Returns a list with all the on-street parking types.
      operationId: post-fetchallonstreetparkingtypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/OnStreetParkingTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllPaymentMethods:
    post:
      tags:
        - PaymentMethods
      summary: AppyWay Fetch All Payment Methods
      description: Returns a list with all the supported payment methods.
      operationId: post-fetchallpaymentmethods
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentMethodIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllPaymentProviders:
    post:
      tags:
        - PaymentProviders
      summary: AppyWay Fetch All Payment Providers
      description: Returns a list with all the supported payment providers.
      operationId: post-fetchallpaymentproviders
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentProviderIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: string
                    name: string
                    paymentsUrl: string
                    paymentsTelephone: string
                    paymentsAppDeepLinks: {}
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllPermittedVehicles:
    post:
      tags:
        - PermittedVehicles
      summary: AppyWay Fetch All Permitted Vehicles
      description: >-
        Returns a list with all the permitted vehicles and associated moving
        restriction types.
      operationId: post-fetchallpermittedvehicles
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PermittedVehicleIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    restrictionTypeIds:
                      - 0
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllPermitTypes:
    post:
      tags:
        - PermitTypes
      summary: AppyWay Fetch All Permit Types
      description: Returns a list with all the permit types.
      operationId: post-fetchallpermittypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermitTypeIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllRegions:
    post:
      tags:
        - Regions
      summary: AppyWay Fetch All Regions
      description: Returns a list with all the supported country regions.
      operationId: post-fetchallregions
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegionIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: string
                    countryId: string
                    name: string
                    venues:
                      - id: string
                        name: string
                        eventsMustSupplyHours: true
                        events:
                          - name: string
                            date: '2020-01-20'
                            start: '2024-10-11'
                            end: '2024-10-11'
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllRestrictionTypes:
    post:
      tags:
        - RestrictionTypes
      summary: AppyWay Fetch All Restriction Types
      description: Returns a list with all the restriction types.
      operationId: post-fetchallrestrictiontypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RestrictionTypeIReadOnlyCollectionOkResponse
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
                    code: string
                    canHaveNoLoadingRules: true
                    canHaveTariff: true
                    canHaveEmptyEntitlements: true
                    defaultWidth: 0
                    isTroItem: true
                    legalName: string
                    hasBayCount: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllVehicleTypes:
    post:
      tags:
        - VehicleTypes
      summary: AppyWay Fetch All Vehicle Types
      description: Returns a list with all the vehicle types.
      operationId: post-fetchallvehicletypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleTypeIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    name: string
                    description: string
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchAllZoneTypes:
    post:
      tags:
        - ZoneTypes
      summary: AppyWay Fetch All Zone Types
      description: Returns a list with all the zone types.
      operationId: post-fetchallzonetypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneTypeIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                  - id: 0
                    code: string
                    name: string
                    description: string
                    canHaveRestrictions: true
                    canHaveShape: true
        '304':
          description: Not Modified
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchCountryById:
    post:
      tags:
        - Countries
      summary: AppyWay Fetch Country By Id
      description: Returns a country object if a valid identifier is provided.
      operationId: post-fetchcountrybyid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchCountryByIdQuery'
            example:
              id: string
          text/json:
            schema:
              $ref: '#/components/schemas/FetchCountryByIdQuery'
            example:
              id: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/FetchCountryByIdQuery'
            example:
              id: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountryOkResponse'
              example:
                success: true
                result:
                  id: string
                  name: string
                  specialDays:
                    - id: string
                      name: string
                      isHoliday: true
                      dates:
                        - '2020-01-20'
                  bounds:
                    -   - 0
                  defaultBaseMapId: 0
                  entitlementTypes:
                    - 0
                  restrictionTypes:
                    - 0
                  assetTypes:
                    - 0
                  countryCode: string
                  currencyCode: string
                  languageCode: string
                  hasMetricSpeedLimits: true
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
              example:
                success: true
                message: string
                errors:
                  - property: string
                    code: string
                    message: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /fetchRegionById:
    post:
      tags:
        - Regions
      summary: AppyWay Fetches a Region By Id
      description: Returns a country region object if a valid identifier is provided.
      operationId: post-fetchregionbyid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRegionByIdQuery'
            example:
              id: string
          text/json:
            schema:
              $ref: '#/components/schemas/FetchRegionByIdQuery'
            example:
              id: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/FetchRegionByIdQuery'
            example:
              id: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegionOkResponse'
              example:
                success: true
                result:
                  id: string
      

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appyway/refs/heads/main/openapi/appyway-platform-api-openapi.yml