AppyWay Availability API

openapi: 3.2.0
info:
  title: AppyWay RealTime Availability API
  version: '1.0'
  description: AppyWay Availability RealTime API allows businesses to access real-time data on parking availability, traffic congestion, and road closure information.
servers:
- url: https://api.appyway.com/v1/availability-realtime
security:
- apiKey: []
- oAuth2: []
tags:
- name: Availability
paths:
  /queries/fetchAvailabilityByEntityIds:
    post:
      tags:
      - Availability
      summary: AppyWay Fetch realtime availability by entity Ids
      description: Returns the availability for the list of given entity Ids.
      operationId: post-queries-fetchavailabilitybyentityids
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchAvailabilityByEntityIdsQuery'
            example:
              ids:
              - string
          text/json:
            schema:
              $ref: '#/components/schemas/FetchAvailabilityByEntityIdsQuery'
            example:
              ids:
              - string
          application/*+json:
            schema:
              $ref: '#/components/schemas/FetchAvailabilityByEntityIdsQuery'
            example:
              ids:
              - string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParkingAvailabilityIReadOnlyCollectionOkResponse'
              example:
                success: true
                result:
                - entityId: string
                  entityType: 1
                  dataSourceType: 0
                  groupId: string
                  totalSpaces: 0
                  availableSpaces: 0
                  parentId: 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'
components:
  responses:
    TooManyRequests:
      description: Too many requests
    Forbidden:
      description: Forbidden
    Unauthorized:
      description: Unauthorized
  schemas:
    EntityType:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: 'Enumeration for the different types of Entity


        *OnStreet (1) - An on street parking area

        *CarPark (2) - An off-street parking facility (car park) including surface and multi-storey car parks.

        *Zone (3) - A zone is an area defined by the local authority that acts as a container for a set of OnStreet and Carpark entities.

        A zone may define common parking rules that are applicable generally across parts of the kerb (e.g. Single Yellow Lines) and may

        define rules parking entities that can be overridden by individual entities.

        *Authority (4) - Defines the area controlled by a particular local authority. Authorities may contain zones and may also contain parking entities directly.

        *CarParkFloor (5) - An off-street parking facility (car park) floor.

        *CarParkBay (6) - An off-street parking facility (car park) bay.

        '
      format: int32
    BadRequestResponse:
      type: object
      properties:
        success:
          type: boolean
          readOnly: true
        message:
          type:
          - string
          - 'null'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ParkingAvailability:
      type: object
      properties:
        entityId:
          type:
          - string
          - 'null'
          description: Unique identifier for this entity
        entityType:
          $ref: '#/components/schemas/EntityType'
        dataSourceType:
          $ref: '#/components/schemas/DataSourceType'
        groupId:
          type:
          - string
          - 'null'
          description: Aggregation Group Id
        totalSpaces:
          type: integer
          description: Total Vehicle Spaces for the Entity
          format: int32
        availableSpaces:
          type:
          - integer
          - 'null'
          description: Available Vehicle Spaces for the Entity
          format: int32
        parentId:
          type:
          - string
          - 'null'
          description: OnStreetParking will have a ParentId as the AuthorityId, CarPark will have a ParentId as the CarParkId
      additionalProperties: false
      description: Parking Availability model for our Entities
    ParkingAvailabilityIReadOnlyCollectionOkResponse:
      type: object
      properties:
        success:
          type: boolean
          readOnly: true
        result:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ParkingAvailability'
      additionalProperties: false
    FetchAvailabilityByEntityIdsQuery:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of Ids of entities to get real time availability for
      additionalProperties: false
    Error:
      type: object
      properties:
        property:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    DataSourceType:
      enum:
      - 0
      - 1
      - 2
      - 4
      type: integer
      description: 'Enumeration for the different data source types


        *Unknown (0) - Unknown

        *Sensor (1) - Sensor

        *Barrier (2) - Barrier

        *Camera (4) - Camera

        '
      format: int32
  securitySchemes:
    apiKey:
      name: API-KEY
      in: header
      type: apiKey
    oAuth2:
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: https://auth.appyway.com/authorize
          tokenUrl: https://auth.appyway.com/oauth/token
      type: oauth2