openapi: 3.0.1
info:
title: AppyWay Availability RealTime ActivityTypes Authorities API
version: '1.0'
description: AppyWay Availability RealTime API allows businesses to access real-time data on parking availability, traffic congestion, and road closure information. This API provides up-to-the-minute updates on parking spots, helping users find and reserve parking spaces quickly and easily. By providing this information in real-time, businesses can improve customer satisfaction and reduce the frustration of searching for parking. Additionally, the API helps businesses optimize their operations by providing detailed information on traffic conditions and road closures, allowing for more efficient route planning and delivery scheduling. Overall, the AppyWay Availability RealTime API is a valuable tool for businesses looking to streamline their operations and improve the customer experience.
servers:
- url: https://api.appyway.com/v1/availability-realtime
security:
- apiKey: []
- oAuth2: []
tags:
- name: Authorities
paths:
/fetchAuthorityById:
post:
tags:
- Authorities
summary: AppyWay Fetch an authority by ID
description: Returns a specific authority by its ID
operationId: post-fetchauthoritybyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
text/json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
application/*+json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorityOkResponse'
example:
success: true
result:
entityId: string
name: string
eTag: string
notes:
- message: string
paymentProviders:
- id: string
name: string
cardPaymentsExternalUrl: string
paymentsTelephone: string
paymentsAppDeepLinks: {}
entityType: 1
countryId: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
hasFreeParkingOutsideZone: true
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/findAuthorityIdsByViewport:
post:
tags:
- Authorities
summary: AppyWay Find authority ids by viewport
description: Returns the Ids of authorities that are at least partially within the specified GeoJson viewport.
operationId: post-findauthorityidsbyviewport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FindAuthorityIdsByViewportQuery'
example:
viewport:
type: string
crs:
type: string
properties:
name: string
coordinates:
- - - 0
text/json:
schema:
$ref: '#/components/schemas/FindAuthorityIdsByViewportQuery'
example:
viewport:
type: string
crs:
type: string
properties:
name: string
coordinates:
- - - 0
application/*+json:
schema:
$ref: '#/components/schemas/FindAuthorityIdsByViewportQuery'
example:
viewport:
type: string
crs:
type: string
properties:
name: string
coordinates:
- - - 0
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthoritySearchResponseOkResponse'
example:
success: true
result:
authorities:
- entityId: string
countryId: string
entityETag: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
example:
success: true
message: string
errors:
- property: string
code: string
message: string
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/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: null
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
\n The documentation provided here shows the model you will find at these locations. The initial object contains only the URL's.
\n 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: null
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'
/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: null
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: null
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: null
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
\n The documentation provided here shows the model you will find at these locations. The initial object contains only the URL's.
\n 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: null
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: null
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:
OrdnanceSurvey:
type: object
properties:
apiKey:
type: string
nullable: true
license:
type: string
nullable: 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
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
DataQuality:
enum:
- 1
- 2
- 3
- 4
type: integer
description: '
*HdPlus (1)
*Hd (2)
*Md (3)
*Sd (4)
'
format: int32
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
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.
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
AuthoritySearchResponseOkResponse:
type: object
properties:
success:
type: boolean
readOnly: true
result:
$ref: '#/components/schemas/AuthoritySearchResponse'
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
LatLng:
type: object
properties:
latitude:
type: number
format: double
longitude:
type: number
format: double
additionalProperties: false
PaymentProvider:
type: object
properties:
id:
type: string
description: Unique identifier (if the payment provider is present on Reference API)
nullable: true
name:
type: string
description: Provider name
nullable: true
cardPaymentsExternalUrl:
type: string
description: URL for taking payments (if online payments are supported)
nullable: true
paymentsTelephone:
type: string
description: Phone number for taking payments (if pay-by-phone is supported)
nullable: true
paymentsAppDeepLinks:
type: object
additionalProperties:
$ref: '#/components/schemas/PaymentDeepLinks'
description: Payment Mobile apps deep links by platform
nullable: true
additionalProperties: false
description: Indicates the payment provider that you can use to pay for an stay at a Parking Entity
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
AuthorityOkResponse:
type: object
properties:
success:
type: boolean
readOnly: true
result:
$ref: '#/components/schemas/Authority'
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
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
BoundingBox:
type: object
properties:
topLeft:
$ref: '#/components/schemas/LatLng'
bottomRight:
$ref: '#/components/schemas/LatLng'
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
NotFoundResponse:
type: object
properties:
success:
type: boolean
readOnly: true
message:
type: string
nullable: true
additionalProperties: false
SurchargeType:
enum:
- 0
- 1
type: integer
description: '
*Flat (0)
*Percentage (1)
'
format: int32
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
FetchAuthorityByIdQuery:
required:
- id
type: object
properties:
id:
minLength: 1
type: string
description: Identifier of the Authority to fetch
additionalProperties: false
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.
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
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
GeometryCollection:
type: object
properties:
type:
type: string
nullable: true
crs:
$ref: '#/components/schemas/Crs'
geometries:
type: array
items:
$ref: '#/components/schemas/Geometry'
nullable: true
additionalProperties: false
AuthoritySnapshotInfoDocOkResponse:
type: object
properties:
success:
type: boolean
readOnly: true
result:
$ref: '#/components/schemas/AuthoritySnapshotInfoDoc'
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
MFeatureCollection:
type: object
properties:
type:
type: string
nullable: true
features:
type: array
items:
$ref: '#/components/schemas/MFeature'
nullable: true
properties:
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
CrsProperties:
type: object
properties:
name:
type: string
nullable: true
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.
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
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
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: '
*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
ZoneType:
enum:
- 1
- 2
- 3
- 4
- 5
- 7
- 8
- 9
- 10
- 11
- 12
type: integer
description: "Known zone types.\n\n*ControlledParkingZone (1) - An ordinary zone in which authority-defined restrictions are in place.\n*RestrictedParkingZone (2) - A zone in which parking is never allowed.\n*FreeParking (3) - A zone in which parking is always allowed.\n*Private (4) - A region not under authority control (such as a shopping centre).\n*CongestionCharge (5) - A region in which congestion charges apply.\n*Container (7) - A zone that exists to contain OSPs that don't really belong in a zone.\n*ResidentsParkingScheme (8) - Same structure as a controlled parking zone\n*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. \nPPAs may not have signs or bay markings within them. Sometimes there may be small plates to remind motorists of the controls in place\n*PedestrianZone (10) - Area where no parking is allowed\n*PedestrianAndCycleZone (11) - Area where no parking is allowed\n*Estate (12) - A housing estate under authority control.\n"
format: int32
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
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
AuthorityIReadOnlyCollectionOkResponse:
type: object
properties:
success:
type: boolean
readOnly: true
result:
type: array
items:
$ref: '#/components/schemas/Authority_2'
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
Authority_2:
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
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
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
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
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
MonthAndDayCms:
type: object
properties:
month:
type: integer
format: int32
day:
type: integer
format: int32
additionalProperties: false
AuthoritySearchResult:
type: object
properties:
entityId:
type: string
description: Entity ID of the authority referred to by this result
nullable: true
countryId:
type: string
description: Country ID of the authority referred to by this result
nullable: true
entityETag:
type: string
description: 'The Etag of the current latest version of the Authority referred to by this result. This allows
clients to determine if they have the latest version of the authority in their local cache and only
request the entity if it is missing.'
nullable: true
additionalProperties: false
Note:
type: object
properties:
message:
type: string
description: The text of the note
nullable: true
additionalProperties: false
description: Models a note that can be attached to an entity
Crs:
type: object
properties:
type:
type: string
nullable: true
properties:
$ref: '#/components/schemas/CrsProperties'
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
Authority:
type: object
properties:
entityId:
type: string
description: Unique identifier for this entity
nullable: true
name:
type: string
description: User-readable name for this entity
nullable: true
eTag:
type: string
description: 'ETag for the entity. The ETag is specific to each version of this entity and changes whenever the entity data changes. Clients can
send the eTags of cached entities to the server when requesting data and the server can return only entities for which the current ETag does
not match the requested tag - i.e. just those entities that have changed.'
nullable: true
notes:
type: array
items:
$ref: '#/components/schemas/Note'
description: Any special notes associated with this authority
nullable: true
paymentProviders:
type: array
items:
$ref: '#/components/schemas/PaymentProvider'
nullable: true
entityType:
$ref: '#/components/schemas/MapEntityType'
countryId:
type: string
description: ID of the country in which the authority resides
nullable: true
geometry:
$ref: '#/components/schemas/GeometryCollection'
hasFreeParkingOutsideZone:
type: boolean
description: "This flag gives an indication of whether parking is likely to be available outside of designated\r\ncontrolled parking zones. The flag indicates the availability of parking for sections of the kerb where\r\nthis API does NOT return a specific OnStreetParking result. If TRUE, parking is likely to be free and\r\nunrestricted where the Parking Search results do not indicate otherwise. if FALSE, it is likely to be no parking.\r\n \r\nThis is an indication only, and clients should inform their end users that they should always check local\r\nsignage when parking.\r\n \r\nIf NULL, it is not known whether parking is available for this authority outside of designated zones.\r\n \r\nNOTE that inside controlled parking zones, it is likely that parking is not available in areas where no\r\nOnStreetParking result is returned."
nullable: true
additionalProperties: false
description: Defines the area controlled by a particular local authority. Authorities may contain zones and may also contain parking entities directly.
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
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.
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
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
PolygonZoneFeatureCollection:
type: object
properties:
type:
type: string
nullable: true
features:
type: array
items:
$ref: '#/components/schemas/PolygonZoneFeature'
nullable: true
properties:
nullable: true
additionalProperties: false
Geometry:
type: object
properties:
type:
type: string
nullable: true
crs:
$ref: '#/components/schemas/Crs'
additionalProperties: false
AuthoritySnapshotInfoDocResult:
type: object
properties:
success:
type: boolean
readOnly: true
data:
$ref: '#/components/schemas/AuthoritySnapshotInfoDoc'
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
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
MapEntityType:
enum:
- 1
- 2
- 3
- 4
type: integer
description: 'Enumeration for the different types of Map Entity - objects returned by the API that can be drawn on a map.
*OnStreet (1) - An on-street parking area
*Carpark (2) - An off-street parking facility (car park) including surface and multi-storey car parks.
*Zone (3) - A zone is an area defined by the local authority that acts as a container for a set of On-Street and Car park entities.
A zone may define common parking rules that are applicable generally across parts of the kerb (e.g. Single Yellow Lines) and may
define rules parking entities that can be overridden by individual entities.
*Authority (4) - Defines the area controlled by a particular local authority. Authorities may contain zones and may also contain parking entities directly.
'
format: int32
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
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.'
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
FindAuthorityIdsByViewportQuery:
required:
- viewport
type: object
properties:
viewport:
type: object
properties:
type:
type: string
nullable: true
crs:
$ref: '#/components/schemas/Crs'
coordinates:
type: array
items:
type: array
items:
type: array
items:
type: number
format: double
nullable: true
additionalProperties: false
description: Viewport for the query, expressed as a GeoJson polygon !:https://tools.ietf.org/html/rfc7946#section-3.1.6. Required. Limited to 300km2.
additionalProperties: false
description: A request to search for zone default information by viewport
FuelTypeCms:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
description: '
*Petrol (1)
*Diesel (2)
*Hybrid (3)
*Electric (4)
*HydrogenFuelCell (5)
*LPG (6)
'
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
AuthoritySearchResponse:
type: object
properties:
authorities:
type: array
items:
$ref: '#/components/schemas/AuthoritySearchResult'
description: List of search results returned in this response
nullable: true
additionalProperties: false
description: Response shape for authority search requests
FullAuthorityOkResponse:
type: object
properties:
success:
type: boolean
readOnly: true
result:
$ref: '#/components/schemas/FullAuthority'
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
PaymentDeepLinks:
type: object
properties:
schemas:
type: array
items:
type: string
description: 'Deep link schemas (eg: ringgo://, etc)'
nullable: true
packageName:
type: string
description: 'Deep link package name (only applies to android, eg: co.uk.ringgo.android)'
nullable: true
additionalProperties: false
Int32Range:
type: object
properties:
min:
type: integer
format: int32
nullable: true
max:
type: integer
format: int32
nullable: true
additionalProperties: false
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
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
AuthorityListResult:
type: object
properties:
success:
type: boolean
readOnly: true
data:
type: array
items:
$ref: '#/components/schemas/Authority_2'
nullable: true
additionalProperties: false
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.'
Error:
type: object
properties:
property:
type: string
nullable: true
code:
type: string
nullable: true
message:
type: string
nullable: true
additionalProperties: false
responses:
Unauthorized:
description: Unauthorized
Forbidden:
description: Forbidden
TooManyRequests:
description: Too many requests
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