openapi: 3.0.1 info: title: AppyWay Traffic Data API version: '1.0' description: >- The AppyWay Traffic Data API provides real-time and historical traffic data for developers to integrate into their applications. This data includes information on traffic congestion, accidents, road closures, and other key events that can impact a driver's journey. By utilizing this API, developers can provide their users with up-to-date traffic information, optimize routes for more efficient travel, and enhance overall road safety. With AppyWay's Traffic Data API, users can enjoy a smoother and more seamless driving experience, ultimately saving time and reducing stress on the road. servers: - url: https://api.appyway.com/v1/traffic-data paths: /authorities/getAll: get: tags: - Authorities summary: >- AppyWay Gets the basic authority information for all authorities that you are entitled to access description: >- Gets the basic authority information for all authorities that you are entitled to access operationId: get-authorities-getall responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthorityListResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AuthorityListResult' example: success: true data: - id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true text/json: schema: $ref: '#/components/schemas/AuthorityListResult' example: success: true data: - id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /authorities/getFullBySlug: get: tags: - Authorities summary: AppyWay Get Full Authority By Slug description: >- Returns an object which has the location of the documents containing the full restrictions of an authority
The documentation provided here shows the model you will find at these locations. The initial object contains only the URL's.
You will have to fetch the documents from the returned authority URL's operationId: get-authorities-getfullbyslug parameters: - name: slug in: query description: >- The name of the authority. You can find this by making a request to the getAll endpoint schema: type: string - name: maxDate in: query description: >- Format - date-time (as date-time in RFC3339). The date at which you wish to view the restrictions schema: type: string format: date-time responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult' example: success: true data: ospsUrl: - type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string properties: onStreetParkingId: string zoneId: string authorityId: string address: street: string postcode: string city: string country: string length: 0 bays: 0 restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string locationNumber: string terminalIds: - string exemptionsSet: setGuid: string setId: string tariffsSet: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string electricPoint: manufacturer: string manufacturerContactNumber: string chargeFee: string website: string electricConnections: - type: 0 name: string description: string quantity: 0 venueId: string sourceTag: string sensorIds: - string centroid: latitude: 0 longitude: 0 tags: - string linkedOspIds: - string properties: {} zonesUrl: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string coordinates: - - - 0 properties: zoneId: string authorityId: string parentZoneId: string type: 1 name: string restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string venueId: string sourceTag: string tags: - string properties: {} setsUrl: operatingHoursSets: - guid: string setId: string name: string formattedName: string operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' exemptionsSets: - guid: string setId: string name: string formattedName: string exemptions: - exemptionTypeId: 0 parkingEntitlementTypeId: 0 exemptionTimeTypeId: 0 exemptionApplies: true maxStay: 0 noReturn: 0 exceptionsSets: - guid: string setId: string name: string formattedName: string exceptions: allHolidaysRestrictionExceptionTypeId: 0 allHolidaysOperatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' daySpecificRestrictionExceptions: - publicHolidayOrNamedDayId: string restrictionExceptionTypeId: 0 operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' tariffSets: - guid: string setId: string name: string formattedName: string tariffs: - setName: string parkingEntitlementTypeIds: - 0 details: - price: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 emissionsAdjustments: emissionsBandSetId: string adjustments: - emissionsBandId: string amount: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 duration: 0 minimumPriceIncrement: 0 singlePaymentCanCrossMidnight: true from: 0 upTo: 0 timeFrom: '2024-10-11' timeTo: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 months: - 0 days: - 0 timeType: 0 emissionsBandSets: - guid: string setId: string name: string formattedName: string emissionsBands: - id: string name: string emissions: min: 0 max: 0 fuelTypes: - 1 registrationYears: min: 0 max: 0 isEmpty: true mtfsUrl: type: string features: - geoType: string featureId: string featureType: 0 authorityId: string note: string streetName: string guid: string properties: {} text/json: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult' example: success: true data: ospsUrl: - type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string properties: onStreetParkingId: string zoneId: string authorityId: string address: street: string postcode: string city: string country: string length: 0 bays: 0 restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string locationNumber: string terminalIds: - string exemptionsSet: setGuid: string setId: string tariffsSet: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string electricPoint: manufacturer: string manufacturerContactNumber: string chargeFee: string website: string electricConnections: - type: 0 name: string description: string quantity: 0 venueId: string sourceTag: string sensorIds: - string centroid: latitude: 0 longitude: 0 tags: - string linkedOspIds: - string properties: {} zonesUrl: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string coordinates: - - - 0 properties: zoneId: string authorityId: string parentZoneId: string type: 1 name: string restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string venueId: string sourceTag: string tags: - string properties: {} setsUrl: operatingHoursSets: - guid: string setId: string name: string formattedName: string operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' exemptionsSets: - guid: string setId: string name: string formattedName: string exemptions: - exemptionTypeId: 0 parkingEntitlementTypeId: 0 exemptionTimeTypeId: 0 exemptionApplies: true maxStay: 0 noReturn: 0 exceptionsSets: - guid: string setId: string name: string formattedName: string exceptions: allHolidaysRestrictionExceptionTypeId: 0 allHolidaysOperatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' daySpecificRestrictionExceptions: - publicHolidayOrNamedDayId: string restrictionExceptionTypeId: 0 operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' tariffSets: - guid: string setId: string name: string formattedName: string tariffs: - setName: string parkingEntitlementTypeIds: - 0 details: - price: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 emissionsAdjustments: emissionsBandSetId: string adjustments: - emissionsBandId: string amount: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 duration: 0 minimumPriceIncrement: 0 singlePaymentCanCrossMidnight: true from: 0 upTo: 0 timeFrom: '2024-10-11' timeTo: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 months: - 0 days: - 0 timeType: 0 emissionsBandSets: - guid: string setId: string name: string formattedName: string emissionsBands: - id: string name: string emissions: min: 0 max: 0 fuelTypes: - 1 registrationYears: min: 0 max: 0 isEmpty: true mtfsUrl: type: string features: - geoType: string featureId: string featureType: 0 authorityId: string note: string streetName: string guid: string properties: {} '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /exportAuthorityMovingRestrictionsById/{authorityId}.geojson: get: tags: - GIS summary: AppyWay Export Authority moving Restrictions as GeoJSON by ID description: Returns a GeoJSON containing the moving restrictions of an authority. operationId: get-exportauthoritymovingrestrictionsbyid-authorityid-geojson parameters: - name: authorityId in: path description: Format - uuid. The ID of the authority. required: true schema: type: string format: uuid - name: restrictions in: query description: >- The set of moving restriction IDs. If left empty will export all allowed restrictions schema: uniqueItems: true type: array items: type: integer format: int32 responses: '200': description: Success '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /exportAuthorityRestrictionsById/{authorityId}.geojson: get: tags: - GIS summary: AppyWay Export Authority static Restrictions as GeoJSON by ID description: Returns a GeoJSON containing the restrictions of an authority.
operationId: get-exportauthorityrestrictionsbyid-authorityid-geojson parameters: - name: authorityId in: path description: Format - uuid. The ID of the authority. required: true schema: type: string format: uuid - name: restrictions in: query description: >- The set of static restriction IDs. If left empty will export all allowed restrictions schema: uniqueItems: true type: array items: type: integer format: int32 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GeoJsonExportStreamResultOkResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/GeoJsonExportStreamResultOkResponse' example: success: true result: content: canRead: true canWrite: true canSeek: true canTimeout: true length: 0 position: 0 readTimeout: 0 writeTimeout: 0 gZipped: true text/json: schema: $ref: '#/components/schemas/GeoJsonExportStreamResultOkResponse' example: success: true result: content: canRead: true canWrite: true canSeek: true canTimeout: true length: 0 position: 0 readTimeout: 0 writeTimeout: 0 gZipped: true '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/BadRequestResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' example: success: true message: string errors: - property: string code: string message: string text/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' /exportAuthorityRestrictionsBySlug/{slug}.geojson: get: tags: - GIS summary: AppyWay Export Authority static Restrictions as GeoJSON by a given slug. description: Returns a GeoJSON containing the moving restrictions of an authority. operationId: get-exportauthorityrestrictionsbyslug-slug-geojson parameters: - name: slug in: path description: The slug used to identify the authority eg. hackney required: true schema: type: string - name: restrictions in: query description: >- The set of static restriction IDs. If left empty will export all allowed restrictions schema: uniqueItems: true type: array items: type: integer format: int32 responses: '200': description: Success '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /fetchAllAuthorities: post: tags: - Authorities summary: >- AppyWay Fetch basic authority information for all authorities that you are entitled to access description: >- Fetch basic authority information for all authorities that you are entitled to access operationId: post-fetchallauthorities responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthorityIReadOnlyCollectionOkResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AuthorityIReadOnlyCollectionOkResponse' example: success: true result: - id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true text/json: schema: $ref: '#/components/schemas/AuthorityIReadOnlyCollectionOkResponse' example: success: true result: - id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /fetchFullAuthorityBySlug: post: tags: - Authorities summary: AppyWay Fetch the basic authority information by slug description: Returns the the basic authority information by slug (authority name) operationId: post-fetchfullauthoritybyslug requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/FetchFullAuthorityBySlugQuery' example: slug: string application/json: schema: $ref: '#/components/schemas/FetchFullAuthorityBySlugQuery' example: slug: string text/json: schema: $ref: '#/components/schemas/FetchFullAuthorityBySlugQuery' example: slug: string application/*+json: schema: $ref: '#/components/schemas/FetchFullAuthorityBySlugQuery' example: slug: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/FullAuthorityOkResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/FullAuthorityOkResponse' example: success: true result: id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true shape: type: string crs: type: string properties: name: string coordinates: - - - 0 text/json: schema: $ref: '#/components/schemas/FullAuthorityOkResponse' example: success: true result: id: string name: string regionId: string countryId: string authoritySlugs: - string ordnanceSurvey: apiKey: string license: string hasFreeParkingOutsideZone: true timeZoneId: string privacyPolicyUrl: string paymentProviderId: string centroid: latitude: 0 longitude: 0 boundingBox: topLeft: latitude: 0 longitude: 0 bottomRight: latitude: 0 longitude: 0 fallbackZoneId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string tags: - string authorityType: 0 legalName: string capabilities: allowIsPubliclyViewable: true allowChargePointRequests: true isVisibleOnPublicConsultation: true enableSessionRecordingInternal: true enableSessionRecordingPublic: true inMaintenanceMode: true enableAssets: true capabilitiesState: isStaticPubliclyViewable: true isMovingPubliclyViewable: true isOffStreetPubliclyViewable: true acceptChargePointRequests: true hideTariffsOnMapSchedules: true hideTariffsOnStreets: true hideRestrictedSpeedLimitsOnStreets: true highwayAuthority: string dataQuality: 1 lastTmoUpdate: string reviewTerminalIds: true shape: type: string crs: type: string properties: name: string coordinates: - - - 0 '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/BadRequestResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' example: success: true message: string errors: - property: string code: string message: string text/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' /fetchFullAuthorityInfoBySlug: post: tags: - Authorities summary: AppyWay Fetch Full Authority By Slug description: >- Returns an object which has the location of the documents containing the full restrictions of an authority
The documentation provided here shows the model you will find at these locations. The initial object contains only the URL's.
You will have to fetch the documents from the returned authority URL's operationId: post-fetchfullauthorityinfobyslug requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/FetchFullAuthorityInfoBySlugQuery' example: slug: string maxDate: string application/json: schema: $ref: '#/components/schemas/FetchFullAuthorityInfoBySlugQuery' example: slug: string maxDate: string text/json: schema: $ref: '#/components/schemas/FetchFullAuthorityInfoBySlugQuery' example: slug: string maxDate: string application/*+json: schema: $ref: '#/components/schemas/FetchFullAuthorityInfoBySlugQuery' example: slug: string maxDate: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocOkResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocOkResponse' example: success: true result: ospsUrl: - type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string properties: onStreetParkingId: string zoneId: string authorityId: string address: street: string postcode: string city: string country: string length: 0 bays: 0 restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string locationNumber: string terminalIds: - string exemptionsSet: setGuid: string setId: string tariffsSet: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string electricPoint: manufacturer: string manufacturerContactNumber: string chargeFee: string website: string electricConnections: - type: 0 name: string description: string quantity: 0 venueId: string sourceTag: string sensorIds: - string centroid: latitude: 0 longitude: 0 tags: - string linkedOspIds: - string properties: {} zonesUrl: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string coordinates: - - - 0 properties: zoneId: string authorityId: string parentZoneId: string type: 1 name: string restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string venueId: string sourceTag: string tags: - string properties: {} setsUrl: operatingHoursSets: - guid: string setId: string name: string formattedName: string operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' exemptionsSets: - guid: string setId: string name: string formattedName: string exemptions: - exemptionTypeId: 0 parkingEntitlementTypeId: 0 exemptionTimeTypeId: 0 exemptionApplies: true maxStay: 0 noReturn: 0 exceptionsSets: - guid: string setId: string name: string formattedName: string exceptions: allHolidaysRestrictionExceptionTypeId: 0 allHolidaysOperatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' daySpecificRestrictionExceptions: - publicHolidayOrNamedDayId: string restrictionExceptionTypeId: 0 operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' tariffSets: - guid: string setId: string name: string formattedName: string tariffs: - setName: string parkingEntitlementTypeIds: - 0 details: - price: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 emissionsAdjustments: emissionsBandSetId: string adjustments: - emissionsBandId: string amount: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 duration: 0 minimumPriceIncrement: 0 singlePaymentCanCrossMidnight: true from: 0 upTo: 0 timeFrom: '2024-10-11' timeTo: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 months: - 0 days: - 0 timeType: 0 emissionsBandSets: - guid: string setId: string name: string formattedName: string emissionsBands: - id: string name: string emissions: min: 0 max: 0 fuelTypes: - 1 registrationYears: min: 0 max: 0 isEmpty: true mtfsUrl: type: string features: - geoType: string featureId: string featureType: 0 authorityId: string note: string streetName: string guid: string properties: {} text/json: schema: $ref: '#/components/schemas/AuthoritySnapshotInfoDocOkResponse' example: success: true result: ospsUrl: - type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string properties: onStreetParkingId: string zoneId: string authorityId: string address: street: string postcode: string city: string country: string length: 0 bays: 0 restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string locationNumber: string terminalIds: - string exemptionsSet: setGuid: string setId: string tariffsSet: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string electricPoint: manufacturer: string manufacturerContactNumber: string chargeFee: string website: string electricConnections: - type: 0 name: string description: string quantity: 0 venueId: string sourceTag: string sensorIds: - string centroid: latitude: 0 longitude: 0 tags: - string linkedOspIds: - string properties: {} zonesUrl: type: string features: - type: string id: string geometry: type: string crs: type: string properties: name: string coordinates: - - - 0 properties: zoneId: string authorityId: string parentZoneId: string type: 1 name: string restrictionTypeDetails: - restrictionTypeId: 0 operatingHoursSets: - setGuid: string setId: string parkingEntitlementTypeIds: - 0 exceptionsSet: setGuid: string setId: string notes: - noteVisibilityTypeId: 0 appliesToRestrictionTypeIds: - 0 priority: 0 title: string message: string url: string telephone: string venueId: string sourceTag: string tags: - string properties: {} setsUrl: operatingHoursSets: - guid: string setId: string name: string formattedName: string operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' exemptionsSets: - guid: string setId: string name: string formattedName: string exemptions: - exemptionTypeId: 0 parkingEntitlementTypeId: 0 exemptionTimeTypeId: 0 exemptionApplies: true maxStay: 0 noReturn: 0 exceptionsSets: - guid: string setId: string name: string formattedName: string exceptions: allHolidaysRestrictionExceptionTypeId: 0 allHolidaysOperatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' daySpecificRestrictionExceptions: - publicHolidayOrNamedDayId: string restrictionExceptionTypeId: 0 operatingHours: standardDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' eventDays: - ruleTime: months: - 0 days: - 0 weekNumbers: - 0 hours: - start: '2024-10-11' end: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 parkingEntitlementTypeIds: - 0 maxStay: 0 minStay: 0 noReturn: 0 noReturnUntil: '2024-10-11' tariffSets: - guid: string setId: string name: string formattedName: string tariffs: - setName: string parkingEntitlementTypeIds: - 0 details: - price: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 emissionsAdjustments: emissionsBandSetId: string adjustments: - emissionsBandId: string amount: 0 surchargeDetail: surchargeType: 0 surchargeTypeEnum: 0 value: 0 notes: string ruleType: 0 duration: 0 minimumPriceIncrement: 0 singlePaymentCanCrossMidnight: true from: 0 upTo: 0 timeFrom: '2024-10-11' timeTo: '2024-10-11' firstDate: month: 0 day: 0 lastDate: month: 0 day: 0 months: - 0 days: - 0 timeType: 0 emissionsBandSets: - guid: string setId: string name: string formattedName: string emissionsBands: - id: string name: string emissions: min: 0 max: 0 fuelTypes: - 1 registrationYears: min: 0 max: 0 isEmpty: true mtfsUrl: type: string features: - geoType: string featureId: string featureType: 0 authorityId: string note: string streetName: string guid: string properties: {} '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/BadRequestResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' example: success: true message: string errors: - property: string code: string message: string text/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' /ping: get: tags: - Status summary: AppyWay Ping description: Returns Status (pong) of the API service operationId: get-ping responses: '200': description: Success '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /wfs: get: tags: - GIS summary: AppyWay Executes a Web Feature Service (WFS) query. description: Executes a Web Feature Service (WFS) query. operationId: get-wfs responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WfsStreamActionResultOkResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/WfsStreamActionResultOkResponse' example: success: true result: {} text/json: schema: $ref: '#/components/schemas/WfsStreamActionResultOkResponse' example: success: true result: {} '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/BadRequestResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' example: success: true message: string errors: - property: string code: string message: string text/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: schemas: Addition: type: object properties: id: type: string format: uuid changeSetId: type: string format: uuid entityType: $ref: '#/components/schemas/EntityType' date: type: string format: date-time updatedDate: type: string format: date-time inverseOf: type: string format: uuid nullable: true entity: description: Should be either a GeoJson Feature or a Set. nullable: true entityId: type: string format: uuid entityIds: type: array items: type: string format: uuid nullable: true additionalProperties: false Address: type: object properties: label: type: string nullable: true countryCode: type: string nullable: true countryName: type: string nullable: true state: type: string nullable: true county: type: string nullable: true city: type: string nullable: true district: type: string nullable: true street: type: string nullable: true houseNumber: type: string nullable: true postalCode: type: string nullable: true additionalProperties: false AddressCms: type: object properties: street: type: string nullable: true postcode: type: string nullable: true city: type: string nullable: true country: type: string nullable: true additionalProperties: false Authority: type: object properties: id: type: string format: uuid name: type: string nullable: true regionId: type: string nullable: true countryId: type: string nullable: true authoritySlugs: type: array items: type: string nullable: true ordnanceSurvey: $ref: '#/components/schemas/OrdnanceSurvey' hasFreeParkingOutsideZone: type: boolean nullable: true timeZoneId: type: string description: IANA time zone ID. nullable: true privacyPolicyUrl: type: string nullable: true paymentProviderId: type: string description: >- The default Payment ProviderId for the authority. See the Reference API for more information. format: uuid nullable: true centroid: $ref: '#/components/schemas/LatLng' boundingBox: $ref: '#/components/schemas/BoundingBox' fallbackZoneId: type: string format: uuid notes: type: array items: $ref: '#/components/schemas/NoteCms' nullable: true tags: type: array items: type: string nullable: true authorityType: type: integer format: int32 legalName: type: string nullable: true capabilities: $ref: '#/components/schemas/Capabilities' capabilitiesState: $ref: '#/components/schemas/CapabilitiesState' highwayAuthority: type: string nullable: true dataQuality: $ref: '#/components/schemas/DataQuality' lastTmoUpdate: type: string format: date-time nullable: true reviewTerminalIds: type: boolean additionalProperties: false AuthorityConfiguration: type: object properties: authoritySlugs: type: array items: type: string nullable: true name: type: string nullable: true timeZoneId: type: string nullable: true osApiKey: type: string nullable: true tags: type: array items: type: string nullable: true capabilities: $ref: '#/components/schemas/Capabilities' highwayAuthority: type: string nullable: true dataQuality: $ref: '#/components/schemas/DataQuality' lastTmoUpdate: type: string format: date-time nullable: true additionalProperties: false AuthorityIReadOnlyCollectionOkResponse: type: object properties: success: type: boolean readOnly: true result: type: array items: $ref: '#/components/schemas/Authority' nullable: true additionalProperties: false AuthorityInfo: type: object properties: authorityId: type: string nullable: true authoritySlugs: type: array items: type: string nullable: true name: type: string nullable: true legalName: type: string nullable: true ordnanceSurvey: $ref: '#/components/schemas/OrdnanceSurvey' made: type: integer format: int32 published: type: integer format: int32 proposal: type: integer format: int32 editingProposal: type: integer format: int32 editingDraft: type: integer format: int32 draft: type: integer format: int32 additionalProperties: false AuthorityInfoArrayResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/AuthorityInfo' nullable: true additionalProperties: false AuthorityListResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/Authority' nullable: true additionalProperties: false AuthorityOrders: type: object properties: authorityId: type: string format: uuid authorityName: type: string nullable: true orders: type: array items: $ref: '#/components/schemas/OrderInfo' nullable: true additionalProperties: false AuthorityOrdersArrayResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/AuthorityOrders' nullable: true additionalProperties: false AuthorityRestrictionSettings: type: object properties: staticRestrictionDefaults: type: array items: $ref: '#/components/schemas/StaticRestrictionDefaults' nullable: true isStaticPubliclyViewable: type: boolean isMovingPubliclyViewable: type: boolean additionalProperties: false AuthorityRestrictionSettingsResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/AuthorityRestrictionSettings' additionalProperties: false AuthorityResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/Authority' additionalProperties: false AuthoritySettings: type: object properties: legalName: type: string nullable: true hasFreeParkingOutsideZone: type: boolean nullable: true privacyPolicyUrl: type: string nullable: true paymentProviderId: type: string description: >- The default Payment ProviderId for the authority. See the Reference API for more information. format: uuid nullable: true defaultEntitlements: type: array items: $ref: '#/components/schemas/EntitlementDefault' nullable: true osLicenseKey: type: string nullable: true capabilitiesState: $ref: '#/components/schemas/CapabilitiesState' reviewTerminalIds: type: boolean additionalProperties: false AuthoritySnapshotInfoDoc: type: object properties: ospsUrl: type: array items: $ref: '#/components/schemas/GeometryOspFeatureCollection' description: >- Provides the URL where you can fetch the OSPs as a list of FeatureCollections by Zone ID nullable: true zonesUrl: $ref: '#/components/schemas/PolygonZoneFeatureCollection' setsUrl: $ref: '#/components/schemas/SetCollection' mtfsUrl: $ref: '#/components/schemas/MFeatureCollection' additionalProperties: false AuthoritySnapshotInfoDocOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/AuthoritySnapshotInfoDoc' additionalProperties: false AuthoritySnapshotInfoDocResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/AuthoritySnapshotInfoDoc' additionalProperties: false 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 BoundingBox: type: object properties: topLeft: $ref: '#/components/schemas/LatLng' bottomRight: $ref: '#/components/schemas/LatLng' additionalProperties: false Capabilities: type: object properties: allowIsPubliclyViewable: type: boolean allowChargePointRequests: type: boolean isVisibleOnPublicConsultation: type: boolean enableSessionRecordingInternal: type: boolean enableSessionRecordingPublic: type: boolean inMaintenanceMode: type: boolean enableAssets: type: boolean additionalProperties: false CapabilitiesState: type: object properties: isStaticPubliclyViewable: type: boolean isMovingPubliclyViewable: type: boolean isOffStreetPubliclyViewable: type: boolean acceptChargePointRequests: type: boolean hideTariffsOnMapSchedules: type: boolean hideTariffsOnStreets: type: boolean hideRestrictedSpeedLimitsOnStreets: type: boolean additionalProperties: false CarParkCmsBlob: type: object properties: carParkId: type: string nullable: true dataOriginId: type: string nullable: true name: type: string nullable: true subTitle: type: string nullable: true description: type: string nullable: true otherInformation: type: string nullable: true telephone: type: string nullable: true website: type: string nullable: true paymentTelephone: type: string nullable: true paymentUrl: type: string nullable: true type: type: integer format: int32 locationDetails: $ref: '#/components/schemas/LocationDetailsCms' locationProvider: type: integer format: int32 nullable: true openHours: type: array items: $ref: '#/components/schemas/RuleTimeCms' nullable: true timesOfOperation: type: array items: $ref: '#/components/schemas/CarParkTimesOfOperationCms' nullable: true reviews: type: array items: $ref: '#/components/schemas/ReviewCms' nullable: true notes: type: array items: $ref: '#/components/schemas/NoteCms' nullable: true bays: type: integer format: int32 nullable: true disabledSpaces: type: integer format: int32 nullable: true chargingPoints: type: integer format: int32 nullable: true motorcycleBays: type: integer format: int32 nullable: true isFree: type: boolean nullable: true isFreeMotorcycle: type: boolean nullable: true hasLifts: type: boolean nullable: true isManned: type: boolean nullable: true cardsAccepted: type: boolean nullable: true canPayByMobile: type: boolean nullable: true hasToilets: type: boolean nullable: true heightRestriction: type: string nullable: true seasonTicket: type: string nullable: true timeType: type: integer format: int32 nullable: true sourceTag: type: string nullable: true partition: type: string nullable: true layout: type: array items: $ref: '#/components/schemas/SmartCarparkFloorCms' nullable: true ownerId: type: string nullable: true authorityId: type: string nullable: true locationNumber: type: string nullable: true counterType: $ref: '#/components/schemas/CarparkConfiguration' surfaceType: $ref: '#/components/schemas/SurfaceType' timezoneSystemId: type: string nullable: true hasBLEPayment: type: boolean hasCarpool: type: boolean hasBLETag: type: boolean maxStay: type: integer format: int32 nullable: true gracePeriod: type: integer format: int32 nullable: true tags: type: array items: type: string nullable: true parentId: type: string nullable: true readOnly: true registrationEnabled: type: boolean additionalProperties: false description: Car park model used by Explorer. CarParkCmsBlobResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/CarParkCmsBlob' additionalProperties: false CarParkLight: type: object properties: name: type: string nullable: true eTag: type: string nullable: true carParkId: type: string nullable: true dataOriginId: type: string nullable: true additionalProperties: false CarParkLightListResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/CarParkLight' nullable: true additionalProperties: false CarParkTimesOfOperationCms: type: object properties: type: type: integer format: int32 time: type: array items: $ref: '#/components/schemas/RuleTimeCms' nullable: true tariffs: type: array items: $ref: '#/components/schemas/TariffForTimesAndDatesCms' nullable: true maxStay: type: integer description: Maximum stay duration in minutes. format: int32 nullable: true minStay: type: integer description: Min stay duration in minutes. format: int32 nullable: true noReturn: type: integer description: No return duration in minutes. format: int32 nullable: true additionalProperties: false CarparkConfiguration: enum: - 0 - 1 - 2 type: integer format: int32 ChangeSet: type: object properties: changeSetId: type: string format: uuid orderId: type: string format: uuid creationDate: type: string format: date-time closedDate: type: string format: date-time nullable: true summary: type: string nullable: true reason: type: string nullable: true changeSetState: $ref: '#/components/schemas/ChangeSetState' additionalProperties: false ChangeSetItem: type: object properties: entityIds: type: array items: type: string format: uuid nullable: true id: type: string format: uuid changeSetId: type: string format: uuid entityType: $ref: '#/components/schemas/EntityType' date: type: string format: date-time updatedDate: type: string format: date-time inverseOf: type: string format: uuid nullable: true additionalProperties: false ChangeSetState: enum: - 0 - 1 - 2 - 3 type: integer description: > Indication of if and how a ChangeSet is applied to the active restrictions. *OpenOrConfirmed (0) - The ChangeSet is either open and able to accept new changes, or confirmed and closed to new changes. It is not yet ready to be applied. This depends on the order type. *PendingApply (1) - The ChangeSet is ready to be applied, but has not yet been applied to the active restrictions. It will not accept any new changes. *Applied (2) - The ChangeSet has been applied and is now part of the active restrictions. *Reverted (3) - The ChangeSet used to be part of the active restrictions but has since been reverted. format: int32 ChangeType: enum: - 0 - 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 type: integer description: |2 *OperatingHoursSetAssignment (0) *TariffSetAssignment (1) *ExemptionSetAssignment (2) *ExceptionSetAssignment (3) *GeoSpatial (4) *BayCount (5) *StreetName (6) *AddRestriction (7) *RemoveRestriction (8) *LocationCode (9) *Tags (10) *SensorIds (11) *VenueId (12) *ZoneType (13) *ZoneName (14) *ParentZoneId (15) *MovingFeature (16) *OperatingHoursSetDefinition (17) *TariffSetDefinition (18) *ExemptionSetDefinition (19) *ExceptionSetDefinition (20) *AssetSubtype (21) *EmissionsBandSetDefinition (22) *PaymentMethod (23) *SurfaceType (24) *CarParkAttributes (25) *CarParkInfo (26) *CarParkBayCounts (27) *EntityDocuments (28) *TerminalIds (29) format: int32 Crs: type: object properties: type: type: string nullable: true properties: $ref: '#/components/schemas/CrsProperties' additionalProperties: false CrsProperties: type: object properties: name: type: string nullable: true additionalProperties: false DataQuality: enum: - 1 - 2 - 3 - 4 type: integer description: |2 *HdPlus (1) *Hd (2) *Md (3) *Sd (4) format: int32 DaySpecificRestrictionExceptionCms: type: object properties: publicHolidayOrNamedDayId: type: string description: >- Reference to the applicable day defined on the Ylp.Reference.Contracts.Model.Country nullable: true restrictionExceptionTypeId: type: integer description: >- Type of exception that applies. See the reference API for more information format: int32 operatingHours: $ref: '#/components/schemas/OperatingHoursCms' additionalProperties: false DeleteOrderRequest: type: object properties: authorityId: type: string format: uuid orderId: type: string format: uuid additionalProperties: false DocumentState: enum: - 0 - 1 - 2 type: integer description: |2 *Generating (0) *Ready (1) *Failed (2) format: int32 DocumentType: enum: - 0 - 1 - 2 - 3 type: integer description: >2 *Maps (0) - Represents the 'Proposed Order' and 'Made Order' map documents. Older documents will include the Written Order document at the beginning. This is always system-generated and there should only be one document of this type per state change. *PublicNoticeDocument (1) - Represents the 'Notice of Proposal' and 'Notice of Making' documents. May be uploaded by a user but is also system-generated. *WrittenOrderDocument (2) - Represents the order's motivation text. Users may opt to generate this from a template but they may also upload their own instead or in addition to the system-generated document. *SupportingDocument (3) - Represents a general user-uploaded document. format: int32 DownloadEntityDocumentQuery: type: object properties: authorityId: type: string format: uuid entityId: type: string format: uuid documentId: type: string format: uuid additionalProperties: false ElectricConnectionCms: type: object properties: type: type: integer format: int32 name: type: string nullable: true description: type: string nullable: true quantity: type: integer format: int32 additionalProperties: false ElectricPointCms: type: object properties: manufacturer: type: string nullable: true manufacturerContactNumber: type: string nullable: true chargeFee: type: string nullable: true website: type: string nullable: true electricConnections: type: array items: $ref: '#/components/schemas/ElectricConnectionCms' nullable: true additionalProperties: false EmbedParams: type: object properties: type: type: string nullable: true embedReport: $ref: '#/components/schemas/EmbeddedReport' embedToken: $ref: '#/components/schemas/EmbedToken' additionalProperties: false EmbedParamsOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/EmbedParams' additionalProperties: false EmbedToken: type: object properties: token: type: string nullable: true tokenId: type: string format: uuid expiration: type: string format: date-time additionalProperties: false EmbeddedReport: type: object properties: reportId: type: string format: uuid reportName: type: string nullable: true embedUrl: type: string nullable: true additionalProperties: false EmbeddedReportListOkResponse: type: object properties: success: type: boolean readOnly: true result: type: array items: $ref: '#/components/schemas/EmbeddedReport' nullable: true additionalProperties: false EmissionsBandCms: type: object properties: id: type: string description: Unique identifier format: uuid name: type: string description: Band name nullable: true emissions: $ref: '#/components/schemas/Int32Range' fuelTypes: type: array items: $ref: '#/components/schemas/FuelTypeCms' description: | List of applicable fuel types *Petrol (1) *Diesel (2) *Hybrid (3) *Electric (4) *HydrogenFuelCell (5) *LPG (6) nullable: true registrationYears: $ref: '#/components/schemas/Int32Range' additionalProperties: false EmissionsBandSet: type: object properties: guid: type: string format: uuid setId: type: string nullable: true name: type: string nullable: true formattedName: type: string nullable: true readOnly: true emissionsBands: type: array items: $ref: '#/components/schemas/EmissionsBandCms' nullable: true additionalProperties: false EntitlementDefault: type: object properties: restrictionTypeId: type: integer format: int32 entitlements: type: array items: type: integer format: int32 nullable: true additionalProperties: false EntityDocumentMetadata: type: object properties: documentId: type: string format: uuid entityId: type: string format: uuid creationDate: type: string format: date-time type: type: integer format: int32 nullable: true fileName: type: string nullable: true isPublic: type: boolean additionalProperties: false EntityDocumentMetadataListOkResponse: type: object properties: success: type: boolean readOnly: true result: type: array items: $ref: '#/components/schemas/EntityDocumentMetadata' nullable: true additionalProperties: false EntityDocumentMetadataUpdate: type: object properties: documentId: type: string format: uuid fileName: type: string nullable: true type: type: integer format: int32 additionalProperties: false EntityDocumentMetadataUpdateRequest: type: object properties: entityId: type: string format: uuid authorityId: type: string format: uuid metadatas: type: array items: $ref: '#/components/schemas/EntityDocumentMetadataUpdate' nullable: true additionalProperties: false EntityType: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: |2 *Authority (0) *Zone (1) *Osp (2) *OperatingHourSet (3) *TariffSet (4) *ExemptionSet (5) *ExceptionSet (6) *MovingFeature (7) *Asset (8) *EmissionsBandSet (9) *CarPark (10) format: int32 Error: type: object properties: property: type: string nullable: true code: type: string nullable: true message: type: string nullable: true additionalProperties: false ExceptionsCms: type: object properties: allHolidaysRestrictionExceptionTypeId: type: integer description: The exception type that applies on every public holiday format: int32 nullable: true allHolidaysOperatingHours: $ref: '#/components/schemas/OperatingHoursCms' daySpecificRestrictionExceptions: type: array items: $ref: '#/components/schemas/DaySpecificRestrictionExceptionCms' description: >- A list of Ylp.Cms.Core.Domain.Model.DaySpecificRestrictionExceptionCms for specific days nullable: true additionalProperties: false ExceptionsSet: type: object properties: guid: type: string format: uuid setId: type: string nullable: true name: type: string nullable: true formattedName: type: string nullable: true readOnly: true exceptions: $ref: '#/components/schemas/ExceptionsCms' additionalProperties: false ExemptionCms: type: object properties: exemptionTypeId: type: integer description: >- The type of the exemption. See the reference API for more information format: int32 parkingEntitlementTypeId: type: integer description: >- The entitlement one must have to be eligible for this exemption. See the reference API for more information format: int32 exemptionTimeTypeId: type: integer description: >- Time when the exemption is applicable. See the reference API for more information format: int32 exemptionApplies: type: boolean description: >- Whether the exemption is in effect (this can be used to override a different exemption) maxStay: type: integer description: The maximum stay duration when eligible for this exemption format: int32 nullable: true noReturn: type: integer description: >- The time before you can return to the same place after having reached the max stay duration format: int32 nullable: true additionalProperties: false ExemptionsSet: type: object properties: guid: type: string format: uuid setId: type: string nullable: true name: type: string nullable: true formattedName: type: string nullable: true readOnly: true exemptions: type: array items: $ref: '#/components/schemas/ExemptionCms' nullable: true additionalProperties: false ExportTemplateRequest: type: object properties: orderId: type: string format: uuid publishDate: type: string format: date-time nullable: true activationDate: type: string format: date-time nullable: true summaryText: type: string nullable: true reasonText: type: string nullable: true additionalProperties: false Feature: type: object properties: type: type: string nullable: true id: type: string nullable: true additionalProperties: false FeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/Feature' nullable: true properties: nullable: true additionalProperties: false FeatureCollectionResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/FeatureCollection' additionalProperties: false FetchCustomerLatestUnsolvedSupportTicketQuery: required: - email type: object properties: email: minLength: 1 type: string format: email createdAfter: type: string format: date-time nullable: true additionalProperties: false FetchCustomerLatestUnsolvedSupportTicketQueryResult: type: object properties: externalReferenceId: type: string nullable: true externalUrl: type: string nullable: true email: type: string nullable: true createdOn: type: string format: date-time additionalProperties: false FetchCustomerLatestUnsolvedSupportTicketQueryResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: >- #/components/schemas/FetchCustomerLatestUnsolvedSupportTicketQueryResult additionalProperties: false FetchEmbeddedReportInfoByIdQuery: type: object properties: reportId: type: string format: uuid additionalProperties: false FetchEntityDocumentsMetadataQuery: type: object properties: authorityId: type: string format: uuid entityId: type: string format: uuid documentIds: type: array items: type: string format: uuid nullable: true additionalProperties: false FetchFullAuthorityBySlugQuery: required: - slug type: object properties: slug: minLength: 1 type: string description: >- The name of the authority. You can find this by making a request to fetchAllAuthorities endpoint additionalProperties: false FetchFullAuthorityInfoBySlugQuery: required: - slug type: object properties: slug: minLength: 1 type: string description: >- The name of the authority. You can find this by making a request to fetchAllAuthorities endpoint maxDate: type: string description: The date at which you wish to view the restrictions format: date-time nullable: true additionalProperties: false FuelTypeCms: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: |2 *Petrol (1) *Diesel (2) *Hybrid (3) *Electric (4) *HydrogenFuelCell (5) *LPG (6) format: int32 FullAuthority: type: object properties: id: type: string format: uuid name: type: string nullable: true regionId: type: string nullable: true countryId: type: string nullable: true authoritySlugs: type: array items: type: string nullable: true ordnanceSurvey: $ref: '#/components/schemas/OrdnanceSurvey' hasFreeParkingOutsideZone: type: boolean nullable: true timeZoneId: type: string description: IANA time zone ID. nullable: true privacyPolicyUrl: type: string nullable: true paymentProviderId: type: string description: >- The default Payment ProviderId for the authority. See the Reference API for more information. format: uuid nullable: true centroid: $ref: '#/components/schemas/LatLng' boundingBox: $ref: '#/components/schemas/BoundingBox' fallbackZoneId: type: string format: uuid notes: type: array items: $ref: '#/components/schemas/NoteCms' nullable: true tags: type: array items: type: string nullable: true authorityType: type: integer format: int32 legalName: type: string nullable: true capabilities: $ref: '#/components/schemas/Capabilities' capabilitiesState: $ref: '#/components/schemas/CapabilitiesState' highwayAuthority: type: string nullable: true dataQuality: $ref: '#/components/schemas/DataQuality' lastTmoUpdate: type: string format: date-time nullable: true reviewTerminalIds: type: boolean shape: $ref: '#/components/schemas/Polygon' additionalProperties: false FullAuthorityOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/FullAuthority' additionalProperties: false FullChangeSet: type: object properties: changeSetId: type: string format: uuid orderId: type: string format: uuid creationDate: type: string format: date-time closedDate: type: string format: date-time nullable: true summary: type: string nullable: true reason: type: string nullable: true changeSetState: $ref: '#/components/schemas/ChangeSetState' additions: type: array items: $ref: '#/components/schemas/Addition' nullable: true modifications: type: array items: $ref: '#/components/schemas/Modification' nullable: true revocations: type: array items: $ref: '#/components/schemas/Revocation' nullable: true changeSetItems: type: array items: $ref: '#/components/schemas/ChangeSetItem' nullable: true readOnly: true isEmpty: type: boolean readOnly: true additionalProperties: false FullChangeSetResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/FullChangeSet' additionalProperties: false FullOrder: type: object properties: orderType: $ref: '#/components/schemas/OrderType' regulationMode: $ref: '#/components/schemas/RegulationMode' orderId: type: string format: uuid name: type: string nullable: true authorityId: type: string format: uuid state: $ref: '#/components/schemas/OrderState' activationDate: type: string format: date-time nullable: true consultationStartDate: type: string format: date-time nullable: true consultationEndDate: type: string format: date-time nullable: true consultationPeriod: type: string description: Duration in ISO format [-][d'.']hh':'mm':'ss['.'fffffff] nullable: true readOnly: true example: 3.17:25:30.5000000 summary: type: string nullable: true reason: type: string nullable: true validationState: $ref: '#/components/schemas/OrderValidationState' validationReason: type: string nullable: true tileText: type: string nullable: true tiles: type: array items: $ref: '#/components/schemas/BoundingBox' nullable: true customMotivationPageHtml: type: string nullable: true stateChanges: type: array items: $ref: '#/components/schemas/StateChange' nullable: true history: type: array items: $ref: '#/components/schemas/StateChange' description: The order's StateChanges in Date order, read only. nullable: true lastModified: type: string format: date-time nullable: true readOnly: true changeSets: type: array items: $ref: '#/components/schemas/FullChangeSet' nullable: true proposalDate: type: string description: >- The date this order is scheduled to be proposed (for permanent orders) or published (for experimental orders). format: date-time nullable: true validationHash: type: string nullable: true benefitTypesJson: type: string nullable: true benefitTypes: uniqueItems: true type: array items: type: integer format: int32 nullable: true additionalProperties: false FullOrderResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/FullOrder' additionalProperties: false GeoJsonExportStreamResult: type: object properties: content: $ref: '#/components/schemas/Stream' gZipped: type: boolean additionalProperties: false GeoJsonExportStreamResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/GeoJsonExportStreamResult' additionalProperties: false Geometry: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' additionalProperties: false GeometryOspFeature: type: object properties: type: type: string nullable: true id: type: string nullable: true geometry: $ref: '#/components/schemas/Geometry' properties: $ref: '#/components/schemas/Osp' additionalProperties: false GeometryOspFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/GeometryOspFeature' nullable: true properties: nullable: true additionalProperties: false GeometryOspPublicFeaturePropertiesFeature: type: object properties: type: type: string nullable: true id: type: string nullable: true geometry: $ref: '#/components/schemas/Geometry' properties: $ref: '#/components/schemas/OspPublicFeatureProperties' additionalProperties: false GeometryOspPublicFeaturePropertiesFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/GeometryOspPublicFeaturePropertiesFeature' nullable: true properties: nullable: true additionalProperties: false GuidIEnumerableResult: type: object properties: success: type: boolean readOnly: true data: type: array items: type: string format: uuid nullable: true additionalProperties: false GuidListOkResponse: type: object properties: success: type: boolean readOnly: true result: type: array items: type: string format: uuid nullable: true additionalProperties: false GuidResult: type: object properties: success: type: boolean readOnly: true data: type: string format: uuid additionalProperties: false HereMapsItem: type: object properties: title: type: string nullable: true id: type: string nullable: true resultType: type: string nullable: true address: $ref: '#/components/schemas/Address' position: $ref: '#/components/schemas/Position' mapView: $ref: '#/components/schemas/MapView' additionalProperties: false HereMapsResult: type: object properties: items: type: array items: $ref: '#/components/schemas/HereMapsItem' nullable: true additionalProperties: false HoursCms: type: object properties: start: type: string description: >- ISO-8601 time pattern, extended as required to accommodate nanoseconds. example: '00:00:00' end: type: string description: >- ISO-8601 time pattern, extended as required to accommodate nanoseconds. example: '00:00:00' additionalProperties: false Int32Range: type: object properties: min: type: integer format: int32 nullable: true max: type: integer format: int32 nullable: true additionalProperties: false LatLng: type: object properties: latitude: type: number format: double longitude: type: number format: double additionalProperties: false LinkedEntitlementSet: type: object properties: setGuid: type: string format: uuid setId: type: string description: GUID of the applicable set. nullable: true parkingEntitlementTypeIds: type: array items: type: integer format: int32 description: >- The entitlement IDs to which this set applies. See the reference API for more information. nullable: true additionalProperties: false description: >- A SetId and a list of EntitlementTypeIds linked to a particular restriction type on an OSP or Zone entity. LinkedSet: type: object properties: setGuid: type: string format: uuid setId: type: string description: GUID of the applicable set. nullable: true additionalProperties: false description: >- A SetId linked to a particular restriction type on an OSP or Zone entity. The set cannot support Entitlements. LocationDetailsCms: type: object properties: latitude: type: number format: double longitude: type: number format: double shape: $ref: '#/components/schemas/Geometry' address: $ref: '#/components/schemas/AddressCms' line: $ref: '#/components/schemas/Geometry' centroid: $ref: '#/components/schemas/Point' additionalProperties: false MFeature: type: object properties: geoType: type: string nullable: true featureId: type: string format: uuid featureType: $ref: '#/components/schemas/MovingTrafficFeatureType' authorityId: type: string format: uuid note: type: string nullable: true streetName: type: string nullable: true guid: type: string format: uuid readOnly: true additionalProperties: false MFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/MFeature' nullable: true properties: nullable: true additionalProperties: false MapView: type: object properties: west: type: number format: double south: type: number format: double east: type: number format: double north: type: number format: double additionalProperties: false Modification: type: object properties: id: type: string format: uuid changeSetId: type: string format: uuid entityType: $ref: '#/components/schemas/EntityType' date: type: string format: date-time updatedDate: type: string format: date-time inverseOf: type: string format: uuid nullable: true changeType: $ref: '#/components/schemas/ChangeType' entityIds: type: array items: type: string format: uuid nullable: true restrictionTypeId: type: integer format: int32 nullable: true producesNoOverallChange: type: boolean readOnly: true splitFrom: type: string format: uuid nullable: true additionalProperties: false MonthAndDayCms: type: object properties: month: type: integer format: int32 day: type: integer format: int32 additionalProperties: false MovingTrafficFeatureType: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 type: integer description: |2 *WeightLimitEnvironmental (0) *HeightLimit (1) *WidthLimit (2) *LengthLimit (3) *SpeedLimit (4) *ProhibitedTurn (5) *ProhibitedEntry (6) *PrescribedTurn (7) *OneWay (8) *CycleLane (9) *BusLane (10) *YellowBoxJunction (11) *PlayStreetZone (12) *PedestrianZone (13) *PedestrianAndCycleZone (14) *SpeedLimitZone (15) *ProhibitedAccess (16) *ProhibitedOvertaking (17) *BusGate (18) *WeightLimitStructural (19) *HighOccupancyVehicleLane (20) *Route (21) *Greenway (22) format: int32 NewOrder: type: object properties: name: type: string nullable: true orderType: $ref: '#/components/schemas/OrderType' regulationMode: $ref: '#/components/schemas/RegulationMode' reason: type: string nullable: true summary: type: string nullable: true authorityId: type: string format: uuid additionalProperties: false NoteCms: type: object properties: noteVisibilityTypeId: type: integer description: >- See the Reference API for more information on types of visibility for notes. format: int32 appliesToRestrictionTypeIds: type: array items: type: integer format: int32 nullable: true priority: type: integer format: int32 title: type: string nullable: true message: type: string nullable: true url: type: string nullable: true telephone: type: string nullable: true additionalProperties: false OkResponse: type: object properties: success: type: boolean readOnly: true additionalProperties: false OperatingHoursCms: type: object properties: standardDays: type: array items: $ref: '#/components/schemas/RuleCms' description: List of Ylp.Cms.Core.Domain.Model.RuleCms applicable on normal days nullable: true eventDays: type: array items: $ref: '#/components/schemas/RuleCms' description: >- List of Ylp.Cms.Core.Domain.Model.RuleCms applicable on event days in an associated venue nullable: true additionalProperties: false OperatingHoursSet: type: object properties: guid: type: string format: uuid setId: type: string nullable: true name: type: string nullable: true formattedName: type: string nullable: true readOnly: true operatingHours: $ref: '#/components/schemas/OperatingHoursCms' additionalProperties: false Order: type: object properties: orderType: $ref: '#/components/schemas/OrderType' regulationMode: $ref: '#/components/schemas/RegulationMode' orderId: type: string format: uuid name: type: string nullable: true authorityId: type: string format: uuid state: $ref: '#/components/schemas/OrderState' activationDate: type: string format: date-time nullable: true consultationStartDate: type: string format: date-time nullable: true consultationEndDate: type: string format: date-time nullable: true consultationPeriod: type: string description: Duration in ISO format [-][d'.']hh':'mm':'ss['.'fffffff] nullable: true readOnly: true example: 3.17:25:30.5000000 summary: type: string nullable: true reason: type: string nullable: true validationState: $ref: '#/components/schemas/OrderValidationState' validationReason: type: string nullable: true tileText: type: string nullable: true tiles: type: array items: $ref: '#/components/schemas/BoundingBox' nullable: true customMotivationPageHtml: type: string nullable: true stateChanges: type: array items: $ref: '#/components/schemas/StateChange' nullable: true history: type: array items: $ref: '#/components/schemas/StateChange' description: The order's StateChanges in Date order, read only. nullable: true lastModified: type: string format: date-time nullable: true readOnly: true changeSets: type: array items: $ref: '#/components/schemas/ChangeSet' nullable: true proposalDate: type: string description: >- The date this order is scheduled to be proposed (for permanent orders) or published (for experimental orders). format: date-time nullable: true validationHash: type: string nullable: true benefitTypesJson: type: string nullable: true benefitTypes: uniqueItems: true type: array items: type: integer format: int32 nullable: true additionalProperties: false OrderArrayResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/Order' nullable: true additionalProperties: false OrderDocument: type: object properties: documentId: type: string format: uuid orderId: type: string format: uuid stateChangeId: type: string format: uuid nullable: true creationDate: type: string format: date-time type: $ref: '#/components/schemas/DocumentType' documentState: $ref: '#/components/schemas/DocumentState' fileName: type: string nullable: true isSystemGenerated: type: boolean readOnly: true url: type: string nullable: true readOnly: true systemGeneratedAt: type: string format: date-time nullable: true additionalProperties: false OrderDocumentIEnumerableResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/OrderDocument' nullable: true additionalProperties: false OrderDocumentListResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/OrderDocument' nullable: true additionalProperties: false OrderDocumentPatch: type: object properties: documentId: type: string format: uuid fileName: type: string nullable: true documentType: $ref: '#/components/schemas/DocumentType' additionalProperties: false OrderGraphSnapshot: type: object properties: orderId: type: string format: uuid hash: type: string nullable: true message: type: string nullable: true fullSnapshotName: type: string nullable: true readOnly: true localSnapshotName: type: string nullable: true readOnly: true additionalProperties: false OrderGraphSnapshotResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/OrderGraphSnapshot' additionalProperties: false OrderInfo: type: object properties: orderId: type: string format: uuid name: type: string nullable: true state: $ref: '#/components/schemas/OrderState' orderType: $ref: '#/components/schemas/OrderType' regulationMode: $ref: '#/components/schemas/RegulationMode' date: type: string format: date-time changeSetIds: type: array items: type: string format: uuid nullable: true additionalProperties: false OrderQueryArgs: type: object properties: authorityId: type: string format: uuid nullable: true orderIds: type: array items: type: string format: uuid nullable: true regulationMode: $ref: '#/components/schemas/RegulationMode' orderTypes: type: array items: $ref: '#/components/schemas/OrderType' description: |2 *Tro (0) *DataEdit (2) *Consolidation (3) *Experimental (4) nullable: true states: type: array items: $ref: '#/components/schemas/OrderState' description: >2 *EditingDraft (0) - The order is being configured in Mapper. *Draft (1) - The order has been configured but is not yet ready for proposal. *Proposal (2) - The order is listed in Public Consultation and feedback is being collected. *EditingProposal (3) - The order is being updated in Mapper in response to initial feedback received through Public Consultation. *Published (4) - The order has been approved and (if a permanent order) will automatically have its state changed to Ylp.Cms.Core.Domain.Orders.Model.OrderState.Made on the activation date. If an experimental order, the order's changes have been applied to the active restrictions in Mapper. *Made (5) - The activation date has been reached and the order's changes must be applied to the active restrictions in Mapper. The order must be manually verified and applied by the data team. *Rejected (6) - The order has received enough negative feedback through Public Consultation that it has been cancelled. *Scheduled (7) - The order has been scheduled for proposal at a later date. *Reverted (8) - The changes in the order have been reverted. *MakingPermanent (9) - The experimental order is scheduled to be made permanent on the activation date, when its state will be automatically be changed to Ylp.Cms.Core.Domain.Orders.Model.OrderState.Made. nullable: true changeSetIds: type: array items: type: string format: uuid nullable: true additionalProperties: false OrderResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/Order' additionalProperties: false OrderState: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 type: integer description: >2 *EditingDraft (0) - The order is being configured in Mapper. *Draft (1) - The order has been configured but is not yet ready for proposal. *Proposal (2) - The order is listed in Public Consultation and feedback is being collected. *EditingProposal (3) - The order is being updated in Mapper in response to initial feedback received through Public Consultation. *Published (4) - The order has been approved and (if a permanent order) will automatically have its state changed to Ylp.Cms.Core.Domain.Orders.Model.OrderState.Made on the activation date. If an experimental order, the order's changes have been applied to the active restrictions in Mapper. *Made (5) - The activation date has been reached and the order's changes must be applied to the active restrictions in Mapper. The order must be manually verified and applied by the data team. *Rejected (6) - The order has received enough negative feedback through Public Consultation that it has been cancelled. *Scheduled (7) - The order has been scheduled for proposal at a later date. *Reverted (8) - The changes in the order have been reverted. *MakingPermanent (9) - The experimental order is scheduled to be made permanent on the activation date, when its state will be automatically be changed to Ylp.Cms.Core.Domain.Orders.Model.OrderState.Made. format: int32 OrderType: enum: - 0 - 2 - 3 - 4 type: integer description: |2 *Tro (0) *DataEdit (2) *Consolidation (3) *Experimental (4) format: int32 OrderValidationState: enum: - 0 - 1 - 2 type: integer description: |2 *Unknown (0) *Invalid (1) *Valid (2) format: int32 OrdnanceSurvey: type: object properties: apiKey: type: string nullable: true license: type: string nullable: true additionalProperties: false Osp: type: object properties: onStreetParkingId: type: string description: GUID of the OSP nullable: true zoneId: type: string description: GUID of the zone this OSP belongs to nullable: true authorityId: type: string description: GUID of the authority this OSP belongs to nullable: true address: $ref: '#/components/schemas/AddressCms' length: type: number description: Length in meters of the OSP. Can be null format: double nullable: true bays: type: integer description: Number of bays that are in this OSP format: int32 nullable: true restrictionTypeDetails: type: array items: $ref: '#/components/schemas/SetRestrictionDetail' description: Information about which set of restrictions apply to this OSP nullable: true notes: type: array items: $ref: '#/components/schemas/NoteCms' description: List of free text information about this OSP nullable: true electricPoint: $ref: '#/components/schemas/ElectricPointCms' venueId: type: string description: >- The venue to which this OSP is linked to. This determines when an OSP should follow the event day restriction instead of standard operating hours nullable: true sourceTag: type: string description: Internal tracking ID nullable: true sensorIds: type: array items: type: string description: List of sensors that are linked to the OSP (obsolete) nullable: true centroid: $ref: '#/components/schemas/LatLng' tags: type: array items: type: string nullable: true linkedOspIds: type: array items: type: string description: >- IDs of any OSPs that are 'linked' to this one. When calculating parking availability and cost, the restrictions of any linked OSPs should be taken into account as well as the restrictions of this OSP. Used for scenarios where multiple OSPs apply to the same section of kerb. nullable: true additionalProperties: false OspPublicFeatureProperties: type: object properties: onStreetParkingId: type: string description: GUID of the OSP nullable: true authorityId: type: string description: GUID of the authority this OSP belongs to nullable: true zoneId: type: string description: GUID of the zone this OSP belongs to nullable: true restrictionTypeDetails: type: array items: $ref: '#/components/schemas/SetRestrictionDetail' description: Information about which set of restrictions apply to this OSP nullable: true venueId: type: string description: >- The venue to which this OSP is linked to. This determines when an OSP should follow the event day restriction instead of standard operating hours nullable: true centroid: $ref: '#/components/schemas/LatLng' additionalProperties: false Point: type: object properties: type: type: string nullable: true crs: $ref: '#/components/schemas/Crs' coordinates: type: array items: type: number format: double nullable: true additionalProperties: false Polygon: 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 PolygonZoneFeature: type: object properties: type: type: string nullable: true id: type: string nullable: true geometry: $ref: '#/components/schemas/Polygon' properties: $ref: '#/components/schemas/Zone' additionalProperties: false PolygonZoneFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/PolygonZoneFeature' nullable: true properties: nullable: true additionalProperties: false PolygonZonePublicFeaturePropertiesFeature: type: object properties: type: type: string nullable: true id: type: string nullable: true geometry: $ref: '#/components/schemas/Polygon' properties: $ref: '#/components/schemas/ZonePublicFeatureProperties' additionalProperties: false PolygonZonePublicFeaturePropertiesFeatureCollection: type: object properties: type: type: string nullable: true features: type: array items: $ref: '#/components/schemas/PolygonZonePublicFeaturePropertiesFeature' nullable: true properties: nullable: true additionalProperties: false Position: type: object properties: lat: type: number format: double lng: type: number format: double additionalProperties: false ProblemDetails: type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} PublicAuthoritySnapshotInfoDoc: type: object properties: ospsUrl: type: array items: $ref: >- #/components/schemas/GeometryOspPublicFeaturePropertiesFeatureCollection description: >- Provides the URL where you can fetch the OSPs as a list of FeatureCollections by Zone ID nullable: true zonesUrl: $ref: >- #/components/schemas/PolygonZonePublicFeaturePropertiesFeatureCollection setsUrl: $ref: '#/components/schemas/PublicSetCollection' mtfsUrl: $ref: '#/components/schemas/MFeatureCollection' additionalProperties: false PublicAuthoritySnapshotInfoDocResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/PublicAuthoritySnapshotInfoDoc' additionalProperties: false PublicSetCollection: type: object properties: operatingHoursSets: type: array items: $ref: '#/components/schemas/OperatingHoursSet' nullable: true tariffSets: type: array items: $ref: '#/components/schemas/TariffSet' nullable: true exceptionsSets: type: array items: $ref: '#/components/schemas/ExceptionsSet' nullable: true emissionsBandSets: type: array items: $ref: '#/components/schemas/EmissionsBandSet' nullable: true additionalProperties: false RegulationMode: enum: - 1 - 2 - 3 type: integer description: |2 *Static (1) *Moving (2) *OffStreet (3) format: int32 Result: type: object properties: successValue: type: boolean readOnly: true additionalProperties: false ReviewCms: type: object properties: username: type: string nullable: true rating: type: number format: double dateAndTime: type: string format: date-time description: type: string nullable: true additionalProperties: false Revocation: type: object properties: id: type: string format: uuid changeSetId: type: string format: uuid entityType: $ref: '#/components/schemas/EntityType' date: type: string format: date-time updatedDate: type: string format: date-time inverseOf: type: string format: uuid nullable: true entity: description: Should be either a GeoJson Feature or a Set. nullable: true entityId: type: string format: uuid entityIds: type: array items: type: string format: uuid nullable: true additionalProperties: false RuleCms: type: object properties: ruleTime: $ref: '#/components/schemas/RuleTimeCms' parkingEntitlementTypeIds: type: array items: type: integer format: int32 description: >- Determines who this rule applies to. See the reference API for more information nullable: true maxStay: type: integer description: Maximum stay duration in minutes. format: int32 nullable: true minStay: type: integer description: Minimum stay duration in minutes. format: int32 nullable: true noReturn: type: integer description: No return duration in minutes. format: int32 nullable: true noReturnUntil: type: string description: No return duration in minutes. nullable: true example: '00:00:00' additionalProperties: false RuleTimeCms: type: object properties: months: type: array items: type: integer format: int32 nullable: true days: type: array items: type: integer format: int32 description: Applicable Days nullable: true weekNumbers: type: array items: type: integer format: int32 description: Week number to apply Days nullable: true hours: type: array items: $ref: '#/components/schemas/HoursCms' nullable: true firstDate: $ref: '#/components/schemas/MonthAndDayCms' lastDate: $ref: '#/components/schemas/MonthAndDayCms' additionalProperties: false SetCollection: type: object properties: operatingHoursSets: type: array items: $ref: '#/components/schemas/OperatingHoursSet' nullable: true exemptionsSets: type: array items: $ref: '#/components/schemas/ExemptionsSet' nullable: true exceptionsSets: type: array items: $ref: '#/components/schemas/ExceptionsSet' nullable: true tariffSets: type: array items: $ref: '#/components/schemas/TariffSet' nullable: true emissionsBandSets: type: array items: $ref: '#/components/schemas/EmissionsBandSet' nullable: true isEmpty: type: boolean readOnly: true additionalProperties: false SetRestrictionDetail: type: object properties: restrictionTypeId: type: integer description: >- Type of the bay this restriction applies to. See the reference API for more information format: int32 operatingHoursSets: type: array items: $ref: '#/components/schemas/LinkedEntitlementSet' description: Indicates the hours of operation when the restriction is in effect. nullable: true exceptionsSet: $ref: '#/components/schemas/LinkedSet' locationNumber: type: string description: >- Used in conjunction with the payment provider on the authority to determine how the charge the user nullable: true terminalIds: type: array items: type: string description: The IDs of the payment terminals available at this OSP. nullable: true exemptionsSet: $ref: '#/components/schemas/LinkedSet' tariffsSet: type: array items: $ref: '#/components/schemas/LinkedEntitlementSet' description: >- Indicates the applicable tariffs in the case of restrictions that can have a tariff nullable: true additionalProperties: false SmartCarParkInfo: type: object properties: carparkId: type: string nullable: true name: type: string nullable: true address: type: string nullable: true operatingHoursText: type: string nullable: true additionalProperties: false SmartCarParkInfoListResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/SmartCarParkInfo' nullable: true additionalProperties: false SmartCarparkBayCms: type: object properties: bayId: type: string nullable: true shape: $ref: '#/components/schemas/Geometry' sensorIds: type: array items: type: string nullable: true bayType: type: string nullable: true maxStay: type: integer format: int32 nullable: true gracePeriod: type: integer format: int32 nullable: true name: type: string nullable: true bayFloorOrder: type: integer format: int32 nullable: true additionalProperties: false SmartCarparkBayCountCms: type: object properties: count: type: integer format: int32 type: type: string nullable: true additionalProperties: false SmartCarparkFloorCms: type: object properties: floorId: type: string nullable: true shape: $ref: '#/components/schemas/Geometry' name: type: string nullable: true floorOrder: type: integer format: int32 bayCounts: type: array items: $ref: '#/components/schemas/SmartCarparkBayCountCms' description: Represents bay counts for bays not represented nullable: true bays: type: array items: $ref: '#/components/schemas/SmartCarparkBayCms' description: Represents all individually declared bays for a given carpark nullable: true enterSensors: type: array items: type: string nullable: true exitSensors: type: array items: type: string nullable: true additionalProperties: false SmartCarparkTariffsRequest: type: object properties: carparkId: type: string nullable: true operatingHoursText: type: string nullable: true additionalProperties: false StateChange: type: object properties: stateChangeId: type: string format: uuid orderId: type: string format: uuid previousState: $ref: '#/components/schemas/OrderState' newState: $ref: '#/components/schemas/OrderState' date: type: string format: date-time changeSetId: type: string format: uuid nullable: true documents: type: array items: $ref: '#/components/schemas/OrderDocument' nullable: true additionalProperties: false StateChangeInfo: type: object properties: tiles: type: array items: $ref: '#/components/schemas/BoundingBox' nullable: true customMotivationPageHtml: type: string nullable: true reason: type: string nullable: true summary: type: string nullable: true activationDate: type: string description: When a published order should be made. format: date-time nullable: true consultationStartDate: type: string format: date-time nullable: true consultationEndDate: type: string format: date-time nullable: true proposalDate: type: string description: When a scheduled order should be proposed. format: date-time nullable: true authorityId: type: string format: uuid orderId: type: string format: uuid newState: $ref: '#/components/schemas/OrderState' benefitTypes: uniqueItems: true type: array items: type: integer format: int32 nullable: true additionalProperties: false StaticRestrictionDefaults: type: object properties: restrictionTypeId: type: integer description: The RestrictionTypeId these defaults apply to. format: int32 operatingHoursSets: type: array items: $ref: '#/components/schemas/LinkedEntitlementSet' description: >- The sets of operating hours and their parking permissions to be assigned by default to newly added OSP restriction types matching the RestrictionTypeId of these defaults. nullable: true exemptionsSet: $ref: '#/components/schemas/LinkedSet' exceptionsSet: $ref: '#/components/schemas/LinkedSet' entitlements: type: array items: type: integer format: int32 description: >- The parking permissions to be assigned by default to the next non-default set of operating hours assigned to OSP restriction types matching the RestrictionTypeId of these defaults. nullable: true additionalProperties: false Stream: type: object properties: canRead: type: boolean readOnly: true canWrite: type: boolean readOnly: true canSeek: type: boolean readOnly: true canTimeout: type: boolean readOnly: true length: type: integer format: int64 readOnly: true position: type: integer format: int64 readTimeout: type: integer format: int32 writeTimeout: type: integer format: int32 additionalProperties: false StringResult: type: object properties: success: type: boolean readOnly: true data: type: string nullable: true additionalProperties: false SurchargeType: enum: - 0 - 1 type: integer description: |2 *Flat (0) *Percentage (1) format: int32 SurfaceType: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer format: int32 Suspension: type: object properties: suspensionId: type: string nullable: true authorityId: type: string nullable: true externalId: type: string nullable: true externalSource: type: string nullable: true name: type: string nullable: true reason: type: string nullable: true times: type: array items: $ref: '#/components/schemas/SuspensionTime' nullable: true timesText: type: string nullable: true ospIds: type: array items: type: string nullable: true additionalProperties: false SuspensionArrayResult: type: object properties: success: type: boolean readOnly: true data: type: array items: $ref: '#/components/schemas/Suspension' nullable: true additionalProperties: false SuspensionResult: type: object properties: success: type: boolean readOnly: true data: $ref: '#/components/schemas/Suspension' additionalProperties: false SuspensionTime: type: object properties: days: type: array items: type: integer format: int32 description: Dates of the week when the suspension is active nullable: true hours: type: array items: $ref: '#/components/schemas/HoursCms' description: >- Hours of the day when the suspension is active (only on Ylp.Cms.Core.Suspensions.Model.SuspensionTime.Days) nullable: true startDate: type: string description: First date when the suspension is active (inclusive) format: date-time nullable: true endDate: type: string description: Last date when the suspension is active (inclusive) format: date-time nullable: true additionalProperties: false TariffDetailCms: type: object properties: price: type: integer description: |- The price in pence charged for parking for the indicated Ylp.Cms.Core.Domain.Model.TariffDetailCms.Duration. format: int32 surchargeDetail: $ref: '#/components/schemas/TariffDetailSurchargeCms' emissionsAdjustments: $ref: '#/components/schemas/TariffEmissionsAdjustmentSetCms' duration: type: integer description: >- The duration in minutes for which you can park if you pay Ylp.Cms.Core.Domain.Model.TariffDetailCms.Price. Null if there is a fixed charge regardless of duration. format: int32 nullable: true minimumPriceIncrement: type: integer description: >- The smallest unit by which the price can increment. If null, then the minimum increment will be the same as Ylp.Cms.Core.Domain.Model.TariffDetailCms.Price. format: int32 nullable: true singlePaymentCanCrossMidnight: type: boolean description: |- Indicates whether a payment of one minimum increment is allowed to cross over midnight. from: type: integer description: |- The offset in minutes into a parking session from which this rate applies. format: int32 upTo: type: integer description: |- Set on variable rate tariffs to indicate the maximum stay length for which this entry applies. format: int32 nullable: true additionalProperties: false description: |- One entry in the tariff details in a Ylp.Cms.Core.Domain.Model.TariffForTimesAndDatesCms. TariffDetailSurchargeCms: type: object properties: surchargeType: type: integer description: Required property that determines how surcharge is calculated format: int32 surchargeTypeEnum: $ref: '#/components/schemas/SurchargeType' value: type: integer description: '' format: int32 nullable: true notes: type: string description: Additional of Surcharge including Rules nullable: true ruleType: type: integer format: int32 nullable: true additionalProperties: false TariffEmissionsAdjustmentCms: type: object properties: emissionsBandId: type: string description: >- Identifier of the corresponding Ylp.Cms.Core.Domain.Model.EmissionsBandCms. format: uuid amount: type: integer description: >- Amout in pence by which to adjust the price. A positive value represents a surcharge, a negative value represents a discount. format: int32 surchargeDetail: $ref: '#/components/schemas/TariffDetailSurchargeCms' additionalProperties: false description: >- An adjustment to a tariff for vehicles that fall into a specified Ylp.Cms.Core.Domain.Model.EmissionsBandCms. TariffEmissionsAdjustmentSetCms: type: object properties: emissionsBandSetId: type: string description: >- Identifier of the corresponding Ylp.Cms.Core.Domain.Model.Sets.EmissionsBandSet. format: uuid adjustments: type: array items: $ref: '#/components/schemas/TariffEmissionsAdjustmentCms' description: >- The adjustments to apply to the tariff. There should be one entry for each band in the corresponding Ylp.Cms.Core.Domain.Model.Sets.EmissionsBandSet. nullable: true additionalProperties: false description: >- A set of adjustments to the price defined in a Ylp.Cms.Core.Domain.Model.TariffDetailCms according to the bands defined in a Ylp.Cms.Core.Domain.Model.Sets.EmissionsBandSet. TariffForTimesAndDatesCms: type: object properties: setName: type: string description: The name of the tariff set to which this tariff belongs. nullable: true parkingEntitlementTypeIds: type: array items: type: integer format: int32 description: The payment types for which these tariff details apply. nullable: true details: type: array items: $ref: '#/components/schemas/TariffDetailCms' description: |- The details of the tariff that applies for the entitlement types and dates indicated by this entry. nullable: true timeFrom: type: string description: |- For tariffs that vary by time of day, this indicates the (inclusive) start time from which these particular tariff details apply. nullable: true example: '00:00:00' timeTo: type: string description: |- For tariffs that vary by time of day, this indicates the (exclusive) end time to which these particular tariff details apply. nullable: true example: '00:00:00' firstDate: $ref: '#/components/schemas/MonthAndDayCms' lastDate: $ref: '#/components/schemas/MonthAndDayCms' months: type: array items: type: integer format: int32 description: The months of the year on which these details apply. nullable: true days: type: array items: type: integer format: int32 description: |- The days of the week (1 = Mon, 7 = Sun) on which these details apply. nullable: true timeType: type: integer description: Indicates the Type of Tariff format: int32 nullable: true additionalProperties: false description: |- Contains tariff details applicable to a particular set of dates and times, and for a particular set of entitlement types. TariffSet: type: object properties: guid: type: string format: uuid setId: type: string nullable: true name: type: string nullable: true formattedName: type: string nullable: true readOnly: true tariffs: type: array items: $ref: '#/components/schemas/TariffForTimesAndDatesCms' nullable: true additionalProperties: false UpdateOrderParameters: type: object properties: authorityId: type: string format: uuid orderId: type: string format: uuid name: type: string nullable: true summary: type: string nullable: true reason: type: string nullable: true additionalProperties: false WfsStreamActionResult: type: object additionalProperties: false WfsStreamActionResultOkResponse: type: object properties: success: type: boolean readOnly: true result: $ref: '#/components/schemas/WfsStreamActionResult' additionalProperties: false Zone: type: object properties: zoneId: type: string description: GUID of the zone nullable: true authorityId: type: string description: GUID of the authority this zone belongs to nullable: true parentZoneId: type: string description: GUID of the zone in which this zone is contained (can be null) nullable: true type: $ref: '#/components/schemas/ZoneType' name: type: string description: Name of the zone nullable: true restrictionTypeDetails: type: array items: $ref: '#/components/schemas/ZoneSetRestrictionDetail' description: Default restrictions that apply in this zone nullable: true notes: type: array items: $ref: '#/components/schemas/NoteCms' description: Free text notes applicable to this zone nullable: true venueId: type: string description: >- VenueID to which this zone is associated. This will influence when event day operating hours are in effect nullable: true sourceTag: type: string description: Internal tracking code nullable: true tags: type: array items: type: string nullable: true additionalProperties: false ZonePublicFeatureProperties: type: object properties: zoneId: type: string description: GUID of the zone nullable: true authorityId: type: string description: GUID of the authority this zone belongs to nullable: true name: type: string description: Name of the zone nullable: true restrictionTypeDetails: type: array items: $ref: '#/components/schemas/ZoneSetRestrictionDetail' description: Default restrictions that apply in this zone nullable: true type: $ref: '#/components/schemas/ZoneType' venueId: type: string description: >- VenueID to which this zone is associated. This will influence when event day operating hours are in effect nullable: true additionalProperties: false ZoneSetRestrictionDetail: type: object properties: restrictionTypeId: type: integer description: >- Type of the bay this restriction applies to. See the reference API for more information format: int32 operatingHoursSets: type: array items: $ref: '#/components/schemas/LinkedEntitlementSet' description: Indicates the hours of operation when the restriction is in effect. nullable: true exceptionsSet: $ref: '#/components/schemas/LinkedSet' additionalProperties: false ZoneType: enum: - 1 - 2 - 3 - 4 - 5 - 7 - 8 - 9 - 10 - 11 - 12 type: integer description: > Known zone types. *ControlledParkingZone (1) - An ordinary zone in which authority-defined restrictions are in place. *RestrictedParkingZone (2) - A zone in which parking is never allowed. *FreeParking (3) - A zone in which parking is always allowed. *Private (4) - A region not under authority control (such as a shopping centre). *CongestionCharge (5) - A region in which congestion charges apply. *Container (7) - A zone that exists to contain OSPs that don't really belong in a zone. *ResidentsParkingScheme (8) - Same structure as a controlled parking zone *PermitParkingArea (9) - Area of residential streets where parking is reserved for permit holders Gn++n++ a sign at the entrance to the street will show that parking is for permit holders only. PPAs may not have signs or bay markings within them. Sometimes there may be small plates to remind motorists of the controls in place *PedestrianZone (10) - Area where no parking is allowed *PedestrianAndCycleZone (11) - Area where no parking is allowed *Estate (12) - A housing estate under authority control. 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 responses: TooManyRequests: description: Too many requests Unauthorized: description: Unauthorized Forbidden: description: Forbidden security: - apiKey: [] - oAuth2: [] tags: - name: Authorities - name: GIS - name: Status