openapi: 3.0.1 info: title: AppyWay Availability RealTime ActivityTypes Parking 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. This API provides up-to-the-minute updates on parking spots, helping users find and reserve parking spaces quickly and easily. By providing this information in real-time, businesses can improve customer satisfaction and reduce the frustration of searching for parking. Additionally, the API helps businesses optimize their operations by providing detailed information on traffic conditions and road closures, allowing for more efficient route planning and delivery scheduling. Overall, the AppyWay Availability RealTime API is a valuable tool for businesses looking to streamline their operations and improve the customer experience. servers: - url: https://api.appyway.com/v1/availability-realtime security: - apiKey: [] - oAuth2: [] tags: - name: Parking paths: /fetchEventDatesById: post: tags: - Parking summary: AppyWay Fetch event dates by id description: Searches for event dates with the supplied entity ID. operationId: post-fetcheventdatesbyid requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchEventDatesByIdQuery' example: entityId: string startDate: '2020-01-20' endDate: '2020-01-20' text/json: schema: $ref: '#/components/schemas/FetchEventDatesByIdQuery' example: entityId: string startDate: '2020-01-20' endDate: '2020-01-20' application/*+json: schema: $ref: '#/components/schemas/FetchEventDatesByIdQuery' example: entityId: string startDate: '2020-01-20' endDate: '2020-01-20' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingEntityEventDatesResultOkResponse' example: success: true result: entityId: string entityType: 1 entityETag: string timeZoneId: string eventDates: - '2020-01-20' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' example: success: true message: string '429': $ref: '#/components/responses/TooManyRequests' /fetchOperatingHoursById: post: tags: - Parking summary: AppyWay Fetch operating hours by id description: Searches for operating hours with the supplied entity ID. operationId: post-fetchoperatinghoursbyid requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdQuery' example: entityId: string includeNotApplicableOperatingHours: true dates: - '2020-01-20' includeClosedPeriods: true includeApplicableOperatingHoursDetail: true date: '2020-01-20' vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 endDate: '2020-01-20' startDate: '2020-01-20' text/json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdQuery' example: entityId: string includeNotApplicableOperatingHours: true dates: - '2020-01-20' includeClosedPeriods: true includeApplicableOperatingHoursDetail: true date: '2020-01-20' vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 endDate: '2020-01-20' startDate: '2020-01-20' application/*+json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdQuery' example: entityId: string includeNotApplicableOperatingHours: true dates: - '2020-01-20' includeClosedPeriods: true includeApplicableOperatingHoursDetail: true date: '2020-01-20' vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 endDate: '2020-01-20' startDate: '2020-01-20' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingEntityOperatingHoursResultOkResponse' example: success: true result: entityId: string entityType: 1 entityETag: string timeZoneId: string operatingHours: - paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 notApplicableOperatingHours: - paymentMethodIds: - 0 requirements: vehicleTypeIds: - 0 activityTypeIds: - 0 fuelTypeIds: - 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 applicableOperatingHoursDetail: - paymentMethodIds: - 0 requirements: vehicleTypeIds: - 0 activityTypeIds: - 0 fuelTypeIds: - 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 closedPeriods: - start: '2020-01-20T00:00:00.0000000+00:00' end: '2020-01-20T00:00:00.0000000+00:00' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' example: success: true message: string '429': $ref: '#/components/responses/TooManyRequests' /fetchOperatingHoursByIds: post: tags: - Parking summary: AppyWay Fetch operating hours by ids description: Searches for operating hours with the supplied entities IDs. operationId: post-fetchoperatinghoursbyids requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdsQuery' example: ids: - string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 date: '2020-01-20' startDate: '2020-01-20' endDate: '2020-01-20' dates: - '2020-01-20' includeNotApplicableOperatingHours: true includeApplicableOperatingHoursDetail: true includeClosedPeriods: true text/json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdsQuery' example: ids: - string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 date: '2020-01-20' startDate: '2020-01-20' endDate: '2020-01-20' dates: - '2020-01-20' includeNotApplicableOperatingHours: true includeApplicableOperatingHoursDetail: true includeClosedPeriods: true application/*+json: schema: $ref: '#/components/schemas/FetchOperatingHoursByIdsQuery' example: ids: - string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 date: '2020-01-20' startDate: '2020-01-20' endDate: '2020-01-20' dates: - '2020-01-20' includeNotApplicableOperatingHours: true includeApplicableOperatingHoursDetail: true includeClosedPeriods: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingEntityOperatingHoursResultIReadOnlyCollectionOkResponse' example: success: true result: - entityId: string entityType: 1 entityETag: string timeZoneId: string operatingHours: - paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 notApplicableOperatingHours: - paymentMethodIds: - 0 requirements: vehicleTypeIds: - 0 activityTypeIds: - 0 fuelTypeIds: - 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 applicableOperatingHoursDetail: - paymentMethodIds: - 0 requirements: vehicleTypeIds: - 0 activityTypeIds: - 0 fuelTypeIds: - 0 permits: - permitTypeId: 0 openPeriods: - start: '2024-10-11' end: '2024-10-11' date: '2020-01-20' status: 1 closedPeriods: - start: '2020-01-20T00:00:00.0000000+00:00' end: '2020-01-20T00:00:00.0000000+00:00' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /fetchParkingEntityById: post: tags: - Parking summary: AppyWay Fetch a parking Entity by ID description: Retrieves a parking entity by its ID operationId: post-fetchparkingentitybyid requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchParkingEntityByIdQuery' example: id: string text/json: schema: $ref: '#/components/schemas/FetchParkingEntityByIdQuery' example: id: string application/*+json: schema: $ref: '#/components/schemas/FetchParkingEntityByIdQuery' example: id: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingEntityOkResponse' example: success: true result: entityId: string entityType: 1 name: string eTag: string address: street: string city: string country: string postcode: string locationCode: string totalCapacity: 0 zoneId: string authorityId: string features: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string geometries: - type: string crs: type: string properties: name: string properties: basemap: 1 properties: {} paymentMethodIds: - 0 operator: id: string name: string cardPaymentsExternalUrl: string paymentsTelephone: string paymentsAppDeepLinks: {} telephone: string website: string onStreetParkingTypeIds: - 1 facilityTypeIds: - 0 venueId: string '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' example: success: true message: string '429': $ref: '#/components/responses/TooManyRequests' /fetchParkingQuoteById: post: tags: - Parking summary: AppyWay Fetch a parking quote by id description: 'Searches for a parking result with the supplied ID. Result indicates whether parking is allowed at the location. If parking is allowed for all or part of the requested window, the result contains a list of quotes containing information such as price, payment methods, maximum stay and no return policy.' operationId: post-fetchparkingquotebyid requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchParkingQuoteByIdQuery' example: startTime: string entityId: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 duration: 3.17:25:30.5000000 endTime: string text/json: schema: $ref: '#/components/schemas/FetchParkingQuoteByIdQuery' example: startTime: string entityId: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 duration: 3.17:25:30.5000000 endTime: string application/*+json: schema: $ref: '#/components/schemas/FetchParkingQuoteByIdQuery' example: startTime: string entityId: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 duration: 3.17:25:30.5000000 endTime: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingEntitySearchResultOkResponse' example: success: true result: entityId: string entityType: 1 quotes: - cost: 0 currency: string minCost: 0 minStayUntil: string canExtendUntil: string pricedUntil: string noReturnUntil: string freeUntil: string becomesFreeAt: string isFreeParking: true paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 rulesApplyUntil: string surcharge: value: 0 valueType: 1 criteria: vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 maxVehicleManufactureYear: 0 distance: 0 parkingAllowed: 1 entityETag: string '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' example: success: true message: string '429': $ref: '#/components/responses/TooManyRequests' /fetchParkingQuotesByIds: post: tags: - Parking summary: AppyWay Fetch parking quotes by ids description: 'Searches for a parking result with the supplied IDs. Result indicates whether parking is allowed at the location. If parking is allowed for all or part of the requested window, the result contains a list of quotes containing information such as price, payment methods, maximum stay and no return policy.' operationId: post-fetchparkingquotesbyids requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchParkingQuotesByIdsQuery' example: startTime: string duration: 3.17:25:30.5000000 vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 ids: - string endTime: string text/json: schema: $ref: '#/components/schemas/FetchParkingQuotesByIdsQuery' example: startTime: string duration: 3.17:25:30.5000000 vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 ids: - string endTime: string application/*+json: schema: $ref: '#/components/schemas/FetchParkingQuotesByIdsQuery' example: startTime: string duration: 3.17:25:30.5000000 vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 ids: - string endTime: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingQuotesResponseOkResponse' example: success: true result: requestedStartTime: string requestedDuration: 3.17:25:30.5000000 parking: - entityId: string entityType: 1 quotes: - cost: 0 currency: string minCost: 0 minStayUntil: string canExtendUntil: string pricedUntil: string noReturnUntil: string freeUntil: string becomesFreeAt: string isFreeParking: true paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 rulesApplyUntil: string surcharge: value: 0 valueType: 1 criteria: vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 maxVehicleManufactureYear: 0 distance: 0 parkingAllowed: 1 entityETag: string '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /fetchPaymentProvidersByParkingEntityId: post: tags: - Parking summary: AppyWay Fetch payment providers by parking entity ID description: Returns payment providers for the given parking entity ID operationId: post-fetchpaymentprovidersbyparkingentityid requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchPaymentProvidersByParkingEntityIdQuery' example: entityId: string text/json: schema: $ref: '#/components/schemas/FetchPaymentProvidersByParkingEntityIdQuery' example: entityId: string application/*+json: schema: $ref: '#/components/schemas/FetchPaymentProvidersByParkingEntityIdQuery' example: entityId: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PaymentProvidersResponseOkResponse' example: success: true result: paymentProviders: - id: string name: string cardPaymentsExternalUrl: string paymentsTelephone: string paymentsAppDeepLinks: {} '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' example: success: true message: string '429': $ref: '#/components/responses/TooManyRequests' /findParkingEntitiesByCentreAndViewportSize: post: tags: - Parking summary: AppyWay Find parking entities by centre and viewport size description: 'This query creates a square viewport with the centre at ViewportCentre and side length of ViewportSize. It then returns a list of all the parking entities within the bounds of that polygon, along with their distance from the DistanceCalculationLocation if supplied, or the viewport centre if not. Entities are ordered by this distance.' operationId: post-findparkingentitiesbycentreandviewportsize requestBody: content: application/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByCentreAndViewportSizeQuery' example: viewportCenter: lat: 0 lng: 0 viewportSize: 0 filters: excludeEntityTypes: - 1 onStreetParkingTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 text/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByCentreAndViewportSizeQuery' example: viewportCenter: lat: 0 lng: 0 viewportSize: 0 filters: excludeEntityTypes: - 1 onStreetParkingTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 application/*+json: schema: $ref: '#/components/schemas/FindParkingEntitiesByCentreAndViewportSizeQuery' example: viewportCenter: lat: 0 lng: 0 viewportSize: 0 filters: excludeEntityTypes: - 1 onStreetParkingTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByViewportResponseOkResponse' example: success: true result: entities: - entity: entityId: string entityType: 1 name: string eTag: string address: street: string city: string country: string postcode: string locationCode: string totalCapacity: 0 zoneId: string authorityId: string features: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string geometries: - type: string crs: type: string properties: name: string properties: basemap: 1 properties: {} paymentMethodIds: - 0 operator: id: string name: string cardPaymentsExternalUrl: string paymentsTelephone: string paymentsAppDeepLinks: {} telephone: string website: string onStreetParkingTypeIds: - 1 facilityTypeIds: - 0 venueId: string distance: 0 '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' /findParkingEntitiesByViewport: post: tags: - Parking summary: AppyWay Find parking entities by viewport description: 'This query creates a custom viewport from the supplied GeoJson polygon. It then returns a list of all the parking entities within the bounds of that polygon, along with their distance from the DistanceCalculationLocation if supplied, or the viewport centre if not. Entities are ordered by this distance.' operationId: post-findparkingentitiesbyviewport requestBody: content: application/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 onStreetParkingTypes: - 1 filters: excludeEntityTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 text/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 onStreetParkingTypes: - 1 filters: excludeEntityTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 application/*+json: schema: $ref: '#/components/schemas/FindParkingEntitiesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 onStreetParkingTypes: - 1 filters: excludeEntityTypes: - 1 distanceCalculationLocation: lat: 0 lng: 0 geometryPreference: basemap: 1 geometryTypes: - 1 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FindParkingEntitiesByViewportResponseOkResponse' example: success: true result: entities: - entity: entityId: string entityType: 1 name: string eTag: string address: street: string city: string country: string postcode: string locationCode: string totalCapacity: 0 zoneId: string authorityId: string features: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string geometries: - type: string crs: type: string properties: name: string properties: basemap: 1 properties: {} paymentMethodIds: - 0 operator: id: string name: string cardPaymentsExternalUrl: string paymentsTelephone: string paymentsAppDeepLinks: {} telephone: string website: string onStreetParkingTypeIds: - 1 facilityTypeIds: - 0 venueId: string distance: 0 '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' /findParkingQuotesByCentreAndViewportSize: post: tags: - Parking summary: AppyWay Find parking quotes by centre and viewport size description: "This query creates a square viewport with the centre at ViewportCentre and side length of ViewportSize.\r\nIt then returns a list of search results for all parking entities within the bounds of that polygon.\r\nResults are ordered by proximity to the DistanceCalculationLocation if supplied, or the viewport centre if not.\r\n \r\nEach result indicates whether parking is allowed at that location. If parking is allowed for all or part of the requested window,\r\nthe result contains a list of quotes containing information such as price, payment methods, maximum stay and no return policy." operationId: post-findparkingquotesbycentreandviewportsize requestBody: content: application/json: schema: $ref: '#/components/schemas/FindParkingQuotesByCentreAndViewportSizeQuery' example: viewportSize: 0 viewportCenter: lat: 0 lng: 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 duration: 3.17:25:30.5000000 endTime: string distanceCalculationLocation: lat: 0 lng: 0 text/json: schema: $ref: '#/components/schemas/FindParkingQuotesByCentreAndViewportSizeQuery' example: viewportSize: 0 viewportCenter: lat: 0 lng: 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 duration: 3.17:25:30.5000000 endTime: string distanceCalculationLocation: lat: 0 lng: 0 application/*+json: schema: $ref: '#/components/schemas/FindParkingQuotesByCentreAndViewportSizeQuery' example: viewportSize: 0 viewportCenter: lat: 0 lng: 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 duration: 3.17:25:30.5000000 endTime: string distanceCalculationLocation: lat: 0 lng: 0 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingSearchResponseOkResponse' example: success: true result: requestedStartTime: string requestedDuration: 3.17:25:30.5000000 parking: - entityId: string entityType: 1 quotes: - cost: 0 currency: string minCost: 0 minStayUntil: string canExtendUntil: string pricedUntil: string noReturnUntil: string freeUntil: string becomesFreeAt: string isFreeParking: true paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 rulesApplyUntil: string surcharge: value: 0 valueType: 1 criteria: vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 maxVehicleManufactureYear: 0 distance: 0 parkingAllowed: 1 entityETag: string generalOnstreetPolicy: 1 '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' /findParkingQuotesByViewport: post: tags: - Parking summary: AppyWay Find parking quotes by viewport description: "This query creates a custom viewport from the supplied GeoJson polygon.\r\nIt then returns a list of search results for all parking entities within the bounds of that polygon.\r\nResults are ordered by proximity to the DistanceCalculationLocation if supplied, or the viewport centre if not.\r\n \r\nEach result indicates whether parking is allowed at that location. If parking is allowed for all or part of the requested window,\r\nthe result contains a list of quotes containing information such as price, payment methods, maximum stay and no return policy." operationId: post-findparkingquotesbyviewport requestBody: content: application/json: schema: $ref: '#/components/schemas/FindParkingQuotesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 distanceCalculationLocation: lat: 0 lng: 0 duration: 3.17:25:30.5000000 endTime: string text/json: schema: $ref: '#/components/schemas/FindParkingQuotesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 distanceCalculationLocation: lat: 0 lng: 0 duration: 3.17:25:30.5000000 endTime: string application/*+json: schema: $ref: '#/components/schemas/FindParkingQuotesByViewportQuery' example: viewport: type: string crs: type: string properties: name: string coordinates: - - - 0 startTime: string vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 filters: excludeEntityTypes: - 1 excludePaidParking: true excludeFreeParking: true excludeNoParking: true excludeTruncatedParking: true excludeCostGreaterThan: 0 distanceCalculationLocation: lat: 0 lng: 0 duration: 3.17:25:30.5000000 endTime: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ParkingSearchResponseOkResponse' example: success: true result: requestedStartTime: string requestedDuration: 3.17:25:30.5000000 parking: - entityId: string entityType: 1 quotes: - cost: 0 currency: string minCost: 0 minStayUntil: string canExtendUntil: string pricedUntil: string noReturnUntil: string freeUntil: string becomesFreeAt: string isFreeParking: true paymentMethodIds: - 0 permittedContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 rulesApplyUntil: string surcharge: value: 0 valueType: 1 criteria: vehicleOperatorContext: vehicleTypeId: 0 activityTypeId: 0 fuelTypeId: 0 permits: - permitTypeId: 0 maxVehicleManufactureYear: 0 distance: 0 parkingAllowed: 1 entityETag: string generalOnstreetPolicy: 1 '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: Forbidden: description: Forbidden Unauthorized: description: Unauthorized TooManyRequests: description: Too many requests schemas: SurchargeDetails: type: object properties: value: type: number description: The amount of the surcharge format: float valueType: $ref: '#/components/schemas/SurchargeValueType' criteria: $ref: '#/components/schemas/SurchargeCriteria' additionalProperties: false description: 'Details of a surcharge that may be applied to a parking charge, including the amount of the surcharge and the criteria under which it is applied.' Permit: type: object properties: permitTypeId: type: integer description: The type of the permit format: int32 additionalProperties: false description: A permit that can be held by a vehicle operator Geometry: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' additionalProperties: false ParkingEntitySearchResult: type: object properties: entityId: type: string description: Identifier of the parking entity nullable: true entityType: $ref: '#/components/schemas/MapEntityType' quotes: type: array items: $ref: '#/components/schemas/ParkingQuote' description: 'List of quotes for parking at this parking entity. If the context of the search means that there are multiple prices returned, one quote will be generated for each price and the quotes will be decorated with the payment methods, bay types and vehicle operator context for which they are valid. If parking is not allowed, no quotes are returned.' nullable: true distance: type: number description: How far away the parking entity is, in meters. Distances are relative to the DistanceCalculationLocation if supplied in the query, otherwise they are relative to the centre of the viewport. format: double nullable: true parkingAllowed: $ref: '#/components/schemas/ParkingAllowed' entityETag: type: string description: 'The Etag of the current latest version of the Parking Entity referred to by this result. This allows clients to determine if they have the latest version of the parking entity in their local cache and only request the entity if it is missing.' nullable: true additionalProperties: false description: Represents a single result returned from a search for Parking Entities. SurchargeValueType: enum: - 1 - 2 type: integer description: 'Indicates how clients should interpret the value in a SurchargeDetails object - as a flat rate (absolute cost) or percentage of the original charge *FlatRate (1) - The value should be interpreted as an absolute amount *Percentage (2) - The value should be interpreted as a percentage of the original cost (before surcharge) ' format: int32 GeometryCollection: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' geometries: type: array items: $ref: '#/components/schemas/Geometry' nullable: true additionalProperties: false ParkingEntityEventDatesResult: type: object properties: entityId: type: string description: Identifier of the parking entity. nullable: true entityType: $ref: '#/components/schemas/MapEntityType' entityETag: type: string description: 'The Etag of the current latest version of the Parking Entity referred to by this result. This allows clients to determine if they have the latest version of the parking entity in their local cache and only request the entity if it is missing.' nullable: true timeZoneId: type: string description: 'Entity Timezone Id in IANA (TZDB) format (eg: Europe/London).' nullable: true eventDates: type: array items: type: string description: ISO-8601 date pattern example: '2020-01-20' description: List of event dates for this parking entity. nullable: true additionalProperties: false OnStreetParkingType: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - -1 type: integer description: 'Indicates the type of on an OnStreet bay. *StandardBay (1) - Standard bay (paid or free) *DisabledBay (2) - A bay requiring a disabled badge / permit during restricted hours *MotorcycleBay (3) - Designated motorcycle bay *ElectricBay (4) - A bay designated for electric vehicles only *CarClubBay (5) - A bay designated for Car Club members only during restricted hours *CoachBay (6) - A bay with space for a coach *LoadingBay (7) - A bay that allows Loading Only during restricted hours *TaxiBay (8) - Taxi bay *ResidentBay (9) - A bay designated for resident permit holders during restricted hours *SpecialBay (10) - A bay with special restrictions, e.g. RNLI, High Court or Ambulance bays *SingleYellowLine (11) - Single yellow line *DoubleYellowLine (12) - Double yellow line *SingleRedLine (13) - Single red line *DoubleRedLine (14) - Double red line *SingleYellowKerbMark (15) - Single yellow kerb marks *DoubleYellowKerbMark (16) - Double yellow kerb marks *KeepClearLine (17) - Keep Clear lines *DroppedKerbDriveway (18) - A dropped kerb driveway *RedRouteBay (19) - Red route bay *BusStop (20) - Bus stop *BusinessBay (21) - A business bay *DoctorBay (22) - A doctor''s bay *HospitalBay (23) - An hospital bay *MarketTraderBay (24) - A market trader bay *HotelBay (25) - A Hotel bay *PoliceBay (26) - A police bay *RnliBay (27) - An RNLI bay *SupremeCourtBay (28) - Supreme court bay *AmbulanceBay (29) - An ambulance bay *CycleHireBay (30) - Cycle hire bay *CycleHangar (31) - Cycle hangar *AdvisorySchoolKeepClearLine (32) - Advisory school keep clear line *MobileLibraryBay (33) - A mobile library bay *DiplomatBay (34) - A diplomat bay *FireBrigade (35) - Fire brigade *CycleRack (36) - Cycle rack *SchoolKeepClearLine (37) - School keep clear line *None (-1) - Standard bay (paid or free) ' format: int32 FindParkingEntitiesByViewportResult: type: object properties: entity: $ref: '#/components/schemas/ParkingEntity' distance: type: number description: How far away the parking entity is, in meters. Distances are relative to the DistanceCalculationLocation if supplied in the query, otherwise they are relative to the centre of the viewport. format: double nullable: true additionalProperties: false description: Models a single result from a Search Parking Entities by Viewport call MapEntityType: enum: - 1 - 2 - 3 - 4 type: integer description: 'Enumeration for the different types of Map Entity - objects returned by the API that can be drawn on a map. *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 On-Street and Car park 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. ' format: int32 GeometryPreference: type: object properties: basemap: $ref: '#/components/schemas/BasemapTranslation' geometryTypes: type: array items: $ref: '#/components/schemas/GeometryType' description: 'List of the types of geometries you want to receive for this basemap *POI (1) - Point of interest: A single point, will be of type "Point" *Kerb (2) - Single line along the kerbedge, will be of type "LineString" *Outline (3) - A complete representation of the parking area, will be of type "Polygon". Only available for Ordnance Survey base maps ' nullable: true additionalProperties: false description: Indicates the type of geometries you want to retrieve OperatingHours: type: object properties: paymentMethodIds: type: array items: type: integer format: int32 description: Payment method(s) for which these operating hours are valid nullable: true permittedContext: $ref: '#/components/schemas/VehicleOperatorContext' openPeriods: type: array items: $ref: '#/components/schemas/OpenPeriod' description: Open periods nullable: true additionalProperties: false description: Contextualized operating hours for an entity SurchargeCriteria: type: object properties: vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' maxVehicleManufactureYear: type: integer description: The latest year of manufacture of the vehicle for which the surcharge applies format: int32 nullable: true additionalProperties: false description: The criteria for which a surcharge may be applied Error: type: object properties: property: type: string nullable: true code: type: string nullable: true message: type: string nullable: true additionalProperties: false FetchParkingQuoteByIdQuery: required: - entityId - startTime type: object properties: entityId: minLength: 1 type: string description: Identifier of the Parking Entity to fetch startTime: minLength: 1 type: string description: 'Start of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time endTime: type: string description: 'End of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time duration: type: string description: Requested duration readOnly: true example: 3.17:25:30.5000000 vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' additionalProperties: false GeometryType: enum: - 1 - 2 - 3 type: integer description: 'Different types of geometries that can be returned *POI (1) - Point of interest: A single point, will be of type "Point" *Kerb (2) - Single line along the kerbedge, will be of type "LineString" *Outline (3) - A complete representation of the parking area, will be of type "Polygon". Only available for Ordnance Survey base maps ' format: int32 BasemapTranslation: enum: - 1 - 2 type: integer description: 'Enumeration for the different types of base maps *OrdnanceSurvey (1) - Ordnance Survey: Realistic mapping *OpenStreetMaps (2) - Open street map. ' format: int32 ParkingEntityOperatingHoursResult: type: object properties: entityId: type: string description: Identifier of the parking entity nullable: true entityType: $ref: '#/components/schemas/MapEntityType' entityETag: type: string description: 'The Etag of the current latest version of the Parking Entity referred to by this result. This allows clients to determine if they have the latest version of the parking entity in their local cache and only request the entity if it is missing.' nullable: true timeZoneId: type: string description: 'Entity Timezone Id in IANA (TZDB) format (eg: Europe/London)' nullable: true operatingHours: type: array items: $ref: '#/components/schemas/OperatingHours' description: 'List of operating hours for this parking entity. If the context of the search means that there are multiple operating hours returned, one list of operating hours will be generated for each payment methods, bay types and vehicle operator context for which they are valid.' nullable: true notApplicableOperatingHours: type: array items: $ref: '#/components/schemas/OperatingHoursRequirements' description: Not applicable operation hours requirements nullable: true applicableOperatingHoursDetail: type: array items: $ref: '#/components/schemas/OperatingHoursRequirements' description: Applicable operation hours requirements details nullable: true closedPeriods: type: array items: $ref: '#/components/schemas/DateTimeRange' description: Closed periods nullable: true additionalProperties: false ParkingQuotesResponse: type: object properties: requestedStartTime: type: string description: This is the query start time after it has been normalized. This is what was used for the quote calculations. format: date-time requestedDuration: type: string description: This is the query end time after it has been normalized. This is what was used for the quote calculations. example: 3.17:25:30.5000000 parking: type: array items: $ref: '#/components/schemas/ParkingEntitySearchResult' description: List of Parking Entities returned by the response nullable: true additionalProperties: false FindParkingEntitiesByViewportFilters: type: object properties: excludeEntityTypes: type: array items: $ref: '#/components/schemas/MapEntityType' description: 'If supplied, entities that have the given Map Entity types will be excluded from the response. Passing Zone or Authority entity types will result in a Bad Request response. *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 On-Street and Car park 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. ' nullable: true additionalProperties: false description: Filters that a caller can apply to limit the results returned when searching for parking entities by viewport ParkingQuote: type: object properties: cost: type: number description: The total cost of parking given the context of the quote. format: float currency: type: string description: Currency of the value in the Cost field nullable: true minCost: type: number description: 'Minimum cost for parking. This is the minimum amount the user will pay for parking, regardless of when they leave the space.' format: float nullable: true minStayUntil: type: string description: 'The amount of time that the vehicle operator is entitled to stay in the space if they pay the amount specified in the MinCost field, i.e. the minimum duration that must be paid for in order to park.' format: date-time nullable: true canExtendUntil: type: string description: 'The maximum time until which the user can park. This value ignores the requested window and is the latest time the user is able to remain parked in the space if they were to extend their session beyond the requested window. Dates/times are returned in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time nullable: true pricedUntil: type: string description: 'The maximum time until which the user can park for the price specified in the ''cost'' field. The ''cost'' field is the cost for the requested time window, but that price may entitle the user to park longer than requested, in which case this field holds the time that the cost will entitle them to park. Dates/times are returned in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time nullable: true noReturnUntil: type: string description: The 'no return until', i.e. the time after parking during which the user is not allowed to return to the bay. format: date-time nullable: true freeUntil: type: string description: "If it is free to park in the bay at the start of the requested time window, this returns the maximum time up to which\r\nthe user can park for free. If the bay is paid parking from the start of the window, FreeUntil will be null.\r\n \r\nIf the bay is free 24/7, this value will be 7 days from start time, which is the maximum session length supported by the Appyway API." format: date-time nullable: true becomesFreeAt: type: string description: 'If the user has to pay to park at the start of the requested time window, this returns the first time at which the user can park for free. If the bay is free parking from the start of the window OR free parking is never available in the bay, BecomesFreeAt will be null.' format: date-time nullable: true isFreeParking: type: boolean description: TRUE if parking is free, false if it is paid. readOnly: true paymentMethodIds: type: array items: type: integer format: int32 description: Payment method(s) for which this quote is valid nullable: true permittedContext: $ref: '#/components/schemas/VehicleOperatorContext' rulesApplyUntil: type: string description: 'The date and time until the rules on which this quote is based apply. Dates/times are returned in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time nullable: true surcharge: $ref: '#/components/schemas/SurchargeDetails' additionalProperties: false description: A contextualized quote for a parking session, including related data such as No Return and Minimum Cost ParkingEntitySearchResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingEntitySearchResult' additionalProperties: false OpenPeriodStatus: enum: - 1 - 2 - 3 type: integer description: 'Indicates the status of an open period *Free (1) - Free period *Paid (2) - Paid period *Mixed (3) - Mixed (free or paid depending on tariff) ' format: int32 BadRequestResponse: type: object properties: success: type: boolean readOnly: true message: type: string nullable: true errors: type: array items: $ref: '#/components/schemas/Error' nullable: true additionalProperties: false FetchOperatingHoursByIdsQuery: type: object properties: ids: type: array items: type: string description: List of Ids of entities to fetch nullable: true vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' date: type: string description: 'The date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-01).' nullable: true example: '2020-01-20' startDate: type: string description: 'Start date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-01). Date takes precedence if set.' nullable: true example: '2020-01-20' endDate: type: string description: 'End date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-03). Date takes precedence if set.' nullable: true example: '2020-01-20' dates: type: array items: type: string description: ISO-8601 date pattern example: '2020-01-20' description: 'Dates for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-03). Date, StartDate and EndDate takes precedence if set.' nullable: true includeNotApplicableOperatingHours: type: boolean description: Include all operation hours requirements for contexts that do not apply to the driver making the request. includeApplicableOperatingHoursDetail: type: boolean description: Include a detail version of operation hours requirements that apply for the given context. includeClosedPeriods: type: boolean description: Include closed periods that apply for the given context. additionalProperties: false FindParkingQuotesByViewportFilters: type: object properties: excludeEntityTypes: type: array items: $ref: '#/components/schemas/MapEntityType' description: 'If supplied, entities that have the given Map Entity types will be excluded from the response. Passing Zone or Authority entity types will result in a Bad Request response. *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 On-Street and Car park 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. ' nullable: true excludePaidParking: type: boolean description: TRUE to exclude paid parking bays from the result. Optional. Defaults to FALSE if omitted. nullable: true excludeFreeParking: type: boolean description: TRUE to exclude free parking bays from the result. Optional. Defaults to FALSE if omitted. nullable: true excludeNoParking: type: boolean description: TRUE to exclude from the result any bays where parking is not allowed for the entirety of the requested time window for the given vehicle operator. Optional. Defaults to FALSE if omitted. nullable: true excludeTruncatedParking: type: boolean description: "TRUE to exclude from the result any bays where parking is not allowed for part of the requested time window for the given vehicle operator. Optional. Defaults to FALSE if omitted.\r\n \r\nNote that this filter does not imply the exclusion of bays where parking is not allowed for the entirety of the requested time window. To exclude such results, use the ExcludeNoParking filter.\r\nif using ExcludeTruncatedParking." nullable: true excludeCostGreaterThan: type: number description: "If supplied, bays for which the total cost over the requested duration exceeds the supplied value will not be included in the result.\r\n \r\nIf the ExcludePaidParking filter is set to TRUE, this property will have no effect." format: float nullable: true additionalProperties: false description: Filters that a caller can apply to limit the results returned when searching for parking by viewport ParkingEntity: type: object properties: entityId: type: string description: Unique identifier for this entity nullable: true entityType: $ref: '#/components/schemas/MapEntityType' name: type: string description: User-readable name for this entity nullable: true eTag: type: string description: 'ETag for the entity. The ETag is specific to each version of this entity and changes whenever the entity data changes. Clients can send the eTags of cached entities to the server when requesting data and the server can return only entities for which the current ETag does not match the requested tag - i.e. just those entities that have changed.' nullable: true address: $ref: '#/components/schemas/Address' locationCode: type: string description: A unique code for each parking entity assigned by a payment provider and is their identifier for payment purposes nullable: true totalCapacity: type: integer description: How many vehicles can be parked at the parking entity. May be approximate (in the case of unmarked bays) format: int32 nullable: true zoneId: type: string description: ID of the zone in which the parking entity resides nullable: true authorityId: type: string description: ID of the authority in which the parking entity resides nullable: true features: $ref: '#/components/schemas/GeometryCollectionFeatureInfoFeatureCollection' paymentMethodIds: type: array items: type: integer format: int32 description: Payment methods supported at this on-street location. nullable: true operator: $ref: '#/components/schemas/CarParkOperator' onStreetParkingTypeIds: type: array items: $ref: '#/components/schemas/OnStreetParkingType' description: 'The types of road markings represented by this entity. This property is only present for On Street Parking entities. *StandardBay (1) - Standard bay (paid or free) *DisabledBay (2) - A bay requiring a disabled badge / permit during restricted hours *MotorcycleBay (3) - Designated motorcycle bay *ElectricBay (4) - A bay designated for electric vehicles only *CarClubBay (5) - A bay designated for Car Club members only during restricted hours *CoachBay (6) - A bay with space for a coach *LoadingBay (7) - A bay that allows Loading Only during restricted hours *TaxiBay (8) - Taxi bay *ResidentBay (9) - A bay designated for resident permit holders during restricted hours *SpecialBay (10) - A bay with special restrictions, e.g. RNLI, High Court or Ambulance bays *SingleYellowLine (11) - Single yellow line *DoubleYellowLine (12) - Double yellow line *SingleRedLine (13) - Single red line *DoubleRedLine (14) - Double red line *SingleYellowKerbMark (15) - Single yellow kerb marks *DoubleYellowKerbMark (16) - Double yellow kerb marks *KeepClearLine (17) - Keep Clear lines *DroppedKerbDriveway (18) - A dropped kerb driveway *RedRouteBay (19) - Red route bay *BusStop (20) - Bus stop *BusinessBay (21) - A business bay *DoctorBay (22) - A doctor''s bay *HospitalBay (23) - An hospital bay *MarketTraderBay (24) - A market trader bay *HotelBay (25) - A Hotel bay *PoliceBay (26) - A police bay *RnliBay (27) - An RNLI bay *SupremeCourtBay (28) - Supreme court bay *AmbulanceBay (29) - An ambulance bay *CycleHireBay (30) - Cycle hire bay *CycleHangar (31) - Cycle hangar *AdvisorySchoolKeepClearLine (32) - Advisory school keep clear line *MobileLibraryBay (33) - A mobile library bay *DiplomatBay (34) - A diplomat bay *FireBrigade (35) - Fire brigade *CycleRack (36) - Cycle rack *SchoolKeepClearLine (37) - School keep clear line *None (-1) - Standard bay (paid or free) ' nullable: true facilityTypeIds: type: array items: type: integer format: int32 description: Any special facilities available at this on-street location, e.g. charging points for EVs. This property is only present for On Street Parking entities. nullable: true venueId: type: string description: The venue id nullable: true additionalProperties: false description: Base class for Map Entities that support parking, either on-street or car parks CrsProperties: type: object properties: name: type: string nullable: true additionalProperties: false GeneralOnStreetPolicyType: enum: - 1 - 2 - 3 - 4 type: integer description: 'The different policies that may apply to sections of the kerb within a given area where no specific data is present. *Restricted (1) - Unspecified sections of kerb are restricted (no parking) for everyone. *LikelyRestricted (2) - Unspecified sections of kerb are likely to be restricted (no parking) for everyone. *LikelyUnrestricted (3) - Unspecified sections of kerb are likely to be unrestricted (free parking) *Unknown (4) - We cannot say with confidence whether or not unspecified kerb sections are restricted. ' format: int32 FindParkingEntitiesByCentreAndViewportSizeQuery: required: - viewportCenter - viewportSize type: object properties: viewportSize: maximum: 1225 minimum: 0 exclusiveMinimum: true type: integer description: Length of one side of the square viewport in meters. Required. Limited to 1.5 km2. format: int32 viewportCenter: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: Centre point for the query. Required. distanceCalculationLocation: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: 'Custom location within the viewport from which to calculate distances for returned entities. Optional. If omitted, distances will be calculated from the centre of the viewport. This field is useful if you want to display or order entities by distance from a given point that is not the centre of your requested viewport.' geometryPreference: $ref: '#/components/schemas/GeometryPreference' filters: $ref: '#/components/schemas/FindParkingEntitiesByViewportFilters' onStreetParkingTypes: type: array items: $ref: '#/components/schemas/OnStreetParkingType' description: 'If supplied, only on-street parking entities that have the given On-Street Parking types will be included in the response. If null, all types will be returned. *StandardBay (1) - Standard bay (paid or free) *DisabledBay (2) - A bay requiring a disabled badge / permit during restricted hours *MotorcycleBay (3) - Designated motorcycle bay *ElectricBay (4) - A bay designated for electric vehicles only *CarClubBay (5) - A bay designated for Car Club members only during restricted hours *CoachBay (6) - A bay with space for a coach *LoadingBay (7) - A bay that allows Loading Only during restricted hours *TaxiBay (8) - Taxi bay *ResidentBay (9) - A bay designated for resident permit holders during restricted hours *SpecialBay (10) - A bay with special restrictions, e.g. RNLI, High Court or Ambulance bays *SingleYellowLine (11) - Single yellow line *DoubleYellowLine (12) - Double yellow line *SingleRedLine (13) - Single red line *DoubleRedLine (14) - Double red line *SingleYellowKerbMark (15) - Single yellow kerb marks *DoubleYellowKerbMark (16) - Double yellow kerb marks *KeepClearLine (17) - Keep Clear lines *DroppedKerbDriveway (18) - A dropped kerb driveway *RedRouteBay (19) - Red route bay *BusStop (20) - Bus stop *BusinessBay (21) - A business bay *DoctorBay (22) - A doctor''s bay *HospitalBay (23) - An hospital bay *MarketTraderBay (24) - A market trader bay *HotelBay (25) - A Hotel bay *PoliceBay (26) - A police bay *RnliBay (27) - An RNLI bay *SupremeCourtBay (28) - Supreme court bay *AmbulanceBay (29) - An ambulance bay *CycleHireBay (30) - Cycle hire bay *CycleHangar (31) - Cycle hangar *AdvisorySchoolKeepClearLine (32) - Advisory school keep clear line *MobileLibraryBay (33) - A mobile library bay *DiplomatBay (34) - A diplomat bay *FireBrigade (35) - Fire brigade *CycleRack (36) - Cycle rack *SchoolKeepClearLine (37) - School keep clear line *None (-1) - Standard bay (paid or free) ' nullable: true additionalProperties: false description: 'Request for searching for Parking Entities for a square viewport. The viewport is defined by the latitude and longitude of the centre point and the length of one side.' ParkingAllowed: enum: - 1 - 2 - 3 type: integer description: 'Enum to indicate the different scenarios whereby parking may be allowed or denied. *FullSession (1) - Parking is allowed for the whole of the requested window *TruncatedSession (2) - Parking is allowed for part of the requested window only *NoParking (3) - Parking is not allowed. ' format: int32 ParkingEntityEventDatesResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingEntityEventDatesResult' additionalProperties: false FetchOperatingHoursByIdQuery: required: - entityId type: object properties: entityId: minLength: 1 type: string description: Identifier of the Parking Entity to fetch vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' date: type: string description: 'The date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-01).' nullable: true example: '2020-01-20' startDate: type: string description: 'Start date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-01). Date takes precedence if set.' nullable: true example: '2020-01-20' endDate: type: string description: 'End date for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-03). Date takes precedence if set.' nullable: true example: '2020-01-20' dates: type: array items: type: string description: ISO-8601 date pattern example: '2020-01-20' description: 'Dates for which to retrieve the operating hours provided in local format: YYYY-MM-DD (eg: 2021-01-03). Date, StartDate and EndDate takes precedence if set.' nullable: true includeNotApplicableOperatingHours: type: boolean description: Include all operation hours requirements for contexts that do not apply to the driver making the request. includeApplicableOperatingHoursDetail: type: boolean description: Include a detail version of operation hours requirements that apply for the given context. includeClosedPeriods: type: boolean description: Include closed periods that apply for the given context. additionalProperties: false VehicleOperatorRequirements: type: object properties: vehicleTypeIds: type: array items: type: integer format: int32 description: Vehicles types. See the reference API for more information. nullable: true activityTypeIds: type: array items: type: integer format: int32 description: Activity the operators perform at the kerbside (parking, loading). See the reference API for more information. nullable: true fuelTypeIds: type: array items: type: integer format: int32 description: Fuel types of the vehicles. See the reference API for more information. nullable: true permits: type: array items: $ref: '#/components/schemas/Permit' description: Any permits held by the operator (e.g. blue disabled badge, car club permit). See the reference API for more information. nullable: true additionalProperties: false OperatingHoursRequirements: type: object properties: paymentMethodIds: type: array items: type: integer format: int32 description: Payment method(s) for which these operating hours are valid nullable: true requirements: $ref: '#/components/schemas/VehicleOperatorRequirements' openPeriods: type: array items: $ref: '#/components/schemas/OpenPeriod' description: Operating hours nullable: true additionalProperties: false description: Operating hours requirements for an entity FindParkingQuotesByViewportQuery: required: - startTime - viewport type: object properties: startTime: minLength: 1 type: string description: 'Start of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time viewport: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' coordinates: type: array items: type: array items: type: array items: type: number format: double nullable: true additionalProperties: false description: Viewport for the query, expressed as a GeoJson polygon !:https://tools.ietf.org/html/rfc7946#section-3.1.6. Required. Limited to 1.5 km2. duration: type: string description: Requested duration readOnly: true example: 3.17:25:30.5000000 endTime: type: string description: 'End of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time distanceCalculationLocation: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: 'Custom location within the viewport from which to calculate distances for returned results. Optional. If omitted, distances will be calculated from the centre of the viewport. This field is useful if you want to display or order results by distance from a given point that is not the centre of your requested viewport.' vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' filters: $ref: '#/components/schemas/FindParkingQuotesByViewportFilters' additionalProperties: false description: Request for searching for Parking Quotes for a given viewport. The viewport is supplied as a GeoJson polygon. PaymentProvidersResponse: type: object properties: paymentProviders: type: array items: $ref: '#/components/schemas/PaymentProvider' description: Payment providers returned from the query nullable: true additionalProperties: false description: Response containing a list of payment providers FetchParkingEntityByIdQuery: required: - id type: object properties: id: minLength: 1 type: string description: Identifier of the Parking Entity to fetch additionalProperties: false FetchParkingQuotesByIdsQuery: required: - startTime type: object properties: startTime: minLength: 1 type: string description: 'Start of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time ids: type: array items: type: string description: List of Ids of entities to fetch nullable: true endTime: type: string description: 'End of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time duration: type: string description: Requested duration readOnly: true example: 3.17:25:30.5000000 vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' additionalProperties: false PaymentDeepLinks: type: object properties: schemas: type: array items: type: string description: 'Deep link schemas (eg: ringgo://, etc)' nullable: true packageName: type: string description: 'Deep link package name (only applies to android, eg: co.uk.ringgo.android)' nullable: true additionalProperties: false Crs: type: object properties: type: type: string nullable: true properties: $ref: '#/components/schemas/CrsProperties' additionalProperties: false FindParkingEntitiesByViewportQuery: required: - viewport type: object properties: viewport: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' coordinates: type: array items: type: array items: type: array items: type: number format: double nullable: true additionalProperties: false description: Viewport for the query, expressed as a GeoJson polygon !:https://tools.ietf.org/html/rfc7946#section-3.1.6. Required. Limited to 1.5 km2. distanceCalculationLocation: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: 'Custom location within the viewport from which to calculate distances for returned entities. Optional. If omitted, distances will be calculated from the centre of the viewport. This field is useful if you want to display or order entities by distance from a given point that is not the centre of your requested viewport.' geometryPreference: $ref: '#/components/schemas/GeometryPreference' onStreetParkingTypes: type: array items: $ref: '#/components/schemas/OnStreetParkingType' description: 'If supplied, only on-street parking entities that have the given On-Street Parking types will be included in the response. If null, all types will be returned. *StandardBay (1) - Standard bay (paid or free) *DisabledBay (2) - A bay requiring a disabled badge / permit during restricted hours *MotorcycleBay (3) - Designated motorcycle bay *ElectricBay (4) - A bay designated for electric vehicles only *CarClubBay (5) - A bay designated for Car Club members only during restricted hours *CoachBay (6) - A bay with space for a coach *LoadingBay (7) - A bay that allows Loading Only during restricted hours *TaxiBay (8) - Taxi bay *ResidentBay (9) - A bay designated for resident permit holders during restricted hours *SpecialBay (10) - A bay with special restrictions, e.g. RNLI, High Court or Ambulance bays *SingleYellowLine (11) - Single yellow line *DoubleYellowLine (12) - Double yellow line *SingleRedLine (13) - Single red line *DoubleRedLine (14) - Double red line *SingleYellowKerbMark (15) - Single yellow kerb marks *DoubleYellowKerbMark (16) - Double yellow kerb marks *KeepClearLine (17) - Keep Clear lines *DroppedKerbDriveway (18) - A dropped kerb driveway *RedRouteBay (19) - Red route bay *BusStop (20) - Bus stop *BusinessBay (21) - A business bay *DoctorBay (22) - A doctor''s bay *HospitalBay (23) - An hospital bay *MarketTraderBay (24) - A market trader bay *HotelBay (25) - A Hotel bay *PoliceBay (26) - A police bay *RnliBay (27) - An RNLI bay *SupremeCourtBay (28) - Supreme court bay *AmbulanceBay (29) - An ambulance bay *CycleHireBay (30) - Cycle hire bay *CycleHangar (31) - Cycle hangar *AdvisorySchoolKeepClearLine (32) - Advisory school keep clear line *MobileLibraryBay (33) - A mobile library bay *DiplomatBay (34) - A diplomat bay *FireBrigade (35) - Fire brigade *CycleRack (36) - Cycle rack *SchoolKeepClearLine (37) - School keep clear line *None (-1) - Standard bay (paid or free) ' nullable: true filters: $ref: '#/components/schemas/FindParkingEntitiesByViewportFilters' additionalProperties: false description: Request for searching for Parking Entities for a given viewport. The viewport is supplied as a GeoJson polygon. FetchEventDatesByIdQuery: type: object properties: entityId: type: string description: Identifier of the Parking Entity to fetch. nullable: true startDate: type: string description: 'Start date for which to retrieve the event dates provided in local format: YYYY-MM-DD (eg: 2021-01-01).' example: '2020-01-20' endDate: type: string description: 'End date for which to retrieve the event dates provided in local format: YYYY-MM-DD (eg: 2021-01-03).' example: '2020-01-20' additionalProperties: false GeometryCollectionFeatureInfoFeature: type: object properties: type: type: string nullable: true id: type: string nullable: true geometry: $ref: '#/components/schemas/GeometryCollection' properties: $ref: '#/components/schemas/FeatureInfo' additionalProperties: false FeatureInfo: type: object properties: basemap: $ref: '#/components/schemas/BasemapTranslation' additionalProperties: false description: Provides information about the geometry contained in the feature FindParkingEntitiesByViewportResponse: type: object properties: entities: type: array items: $ref: '#/components/schemas/FindParkingEntitiesByViewportResult' description: List of results from the entity search. nullable: true additionalProperties: false description: Response from calls that search for Parking Entities by viewport ParkingSearchResponse: type: object properties: requestedStartTime: type: string description: This is the query start time after it has been normalized. This is what was used for the quote calculations. format: date-time requestedDuration: type: string description: This is the query end time after it has been normalized. This is what was used for the quote calculations. example: 3.17:25:30.5000000 parking: type: array items: $ref: '#/components/schemas/ParkingEntitySearchResult' description: List of Parking Entities returned by the response nullable: true generalOnstreetPolicy: $ref: '#/components/schemas/GeneralOnStreetPolicyType' additionalProperties: false description: Response shape for parking search requests FetchPaymentProvidersByParkingEntityIdQuery: required: - entityId type: object properties: entityId: minLength: 1 type: string description: Identifier of the Parking Entity to fetch Payment Providers additionalProperties: false ParkingSearchResponseOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingSearchResponse' additionalProperties: false NotFoundResponse: type: object properties: success: type: boolean readOnly: true message: type: string nullable: true additionalProperties: false Address: type: object properties: street: type: string description: Street address nullable: true city: type: string description: Town or city nullable: true country: type: string description: Country nullable: true postcode: type: string description: Postal code nullable: true additionalProperties: false description: A standard address for an Onstreet bay or Car park FindParkingEntitiesByViewportResponseOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/FindParkingEntitiesByViewportResponse' additionalProperties: false FindParkingQuotesByCentreAndViewportSizeQuery: required: - startTime - viewportCenter - viewportSize type: object properties: startTime: minLength: 1 type: string description: 'Start of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time viewportCenter: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: Centre point for the query. Required. viewportSize: maximum: 1225 type: integer description: Length of one side of the square viewport in meters. Required. Limited to 1.5 km2. format: int32 endTime: type: string description: 'End of the window for which to retrieve state. Required. Dates/times should be provided in ISO8601 format: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)' format: date-time distanceCalculationLocation: type: object properties: lat: type: number description: Latitude format: double lng: type: number description: Longitude format: double additionalProperties: false description: 'Custom location within the viewport from which to calculate distances for returned results. Optional. If omitted, distances will be calculated from the centre of the viewport. This field is useful if you want to display or order results by distance from a given point that is not the centre of your requested viewport.' duration: type: string description: Requested duration readOnly: true example: 3.17:25:30.5000000 vehicleOperatorContext: $ref: '#/components/schemas/VehicleOperatorContext' filters: $ref: '#/components/schemas/FindParkingQuotesByViewportFilters' additionalProperties: false description: 'Request for searching for Parking Quotes for a square viewport. The viewport is defined by the latitude and longitude of the centre point and the length of one side.' VehicleOperatorContext: type: object properties: vehicleTypeId: type: integer description: Type of vehicle being operated. See the reference API for more information. format: int32 nullable: true activityTypeId: type: integer description: Activity the operator is seeking to perform at the kerbside (parking, loading). See the reference API for more information. format: int32 nullable: true fuelTypeId: type: integer description: Fuel type of the vehicle. See the reference API for more information. format: int32 nullable: true permits: type: array items: $ref: '#/components/schemas/Permit' description: Any permits types held by the operator (e.g. blue disabled badge, car club permit). See the reference API for more information. nullable: true additionalProperties: false description: 'A set of values that pertain to the driver looking to park (their vehicle, permits, intended activity) that affect whether or not they can park and/or the price they pay if they do.' DateTimeRange: type: object properties: start: type: string description: ISO-8601 date/time pattern, extended as required to accommodate nanoseconds. example: '2020-01-20T00:00:00' end: type: string description: ISO-8601 date/time pattern, extended as required to accommodate nanoseconds. example: '2020-01-20T00:00:00' additionalProperties: false CarParkOperator: type: object properties: id: type: string description: Unique identifier (if the payment provider is present on Reference API) nullable: true name: type: string description: Provider name nullable: true cardPaymentsExternalUrl: type: string description: URL for taking payments (if online payments are supported) nullable: true paymentsTelephone: type: string description: Phone number for taking payments (if pay-by-phone is supported) nullable: true paymentsAppDeepLinks: type: object additionalProperties: $ref: '#/components/schemas/PaymentDeepLinks' description: Payment Mobile apps deep links by platform nullable: true telephone: type: string description: Operator phone number nullable: true website: type: string description: Operator website nullable: true additionalProperties: false description: Details of the operator for a car park, including telephone numbers and URLs for phone and online payments (if applicable) ParkingEntityOperatingHoursResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingEntityOperatingHoursResult' additionalProperties: false GeometryCollectionFeatureInfoFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/GeometryCollectionFeatureInfoFeature' nullable: true properties: nullable: true additionalProperties: false OpenPeriod: type: object properties: start: type: string description: 'The local time of the day that the period starts Returned in local time format: hh:mm:ss (eg: 19:20:30)' example: 00:00:00 end: type: string description: 'The local time of the day that the period ends Returned in local time format: hh:mm:ss (eg: 19:20:30)' example: 00:00:00 date: type: string description: 'The local date that the period belongs Returned in local format: YYYY-MM-DD (eg: 2021-01-01)' example: '2020-01-20' status: $ref: '#/components/schemas/OpenPeriodStatus' additionalProperties: false PaymentProvider: type: object properties: id: type: string description: Unique identifier (if the payment provider is present on Reference API) nullable: true name: type: string description: Provider name nullable: true cardPaymentsExternalUrl: type: string description: URL for taking payments (if online payments are supported) nullable: true paymentsTelephone: type: string description: Phone number for taking payments (if pay-by-phone is supported) nullable: true paymentsAppDeepLinks: type: object additionalProperties: $ref: '#/components/schemas/PaymentDeepLinks' description: Payment Mobile apps deep links by platform nullable: true additionalProperties: false description: Indicates the payment provider that you can use to pay for an stay at a Parking Entity ParkingQuotesResponseOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingQuotesResponse' additionalProperties: false ParkingEntityOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/ParkingEntity' additionalProperties: false ParkingEntityOperatingHoursResultIReadOnlyCollectionOkResponse: type: object properties: success: type: boolean readOnly: true result: type: array items: $ref: '#/components/schemas/ParkingEntityOperatingHoursResult' nullable: true additionalProperties: false PaymentProvidersResponseOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/PaymentProvidersResponse' additionalProperties: false 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