Skip to content

Interfaces

This is a list of data structures that A11yJSON specifies.

They are meant to be interfaces in the software development sense: This means you can either use them as they are, or mix them into your own entity definitions.

Accessibility

Describes the physical (and sometimes human rated) accessibility of a place.

NameType
accessibleWithPersonalProfile
ambientNoiseLevelVolume

Ambient noise level in dB(A) relative to a reference pressure of 0.00002 Pa. Median over a 10-second period at least.

animalPolicyAnimalPolicy

Object describing the owner's policy regarding visitors bringing animals with them.

desksundefined | Desk[]

Describes the accessibility of desks in the place. null indicates there are no desks, undefined or missing property indicates unknown.

entrancesundefined | Entrance[]

Describes the accessibility of entrances to the place.

hasAirConditioningboolean

Determines if there is air conditioning installed and actively used.

hasBrailleSignageboolean

true if there is braille navigation for/to this place, false if not.

hasInductionLoopboolean

true if the venue has induction loops installed in its functional units where this is relevant.

hasSoundAbsorptionboolean

Determines if there is sound absorption installed.

hasTactileGuideStripsboolean

true if the venue has tactile guide strips on the floor or at the walls, false if not. undefined or missing property indicates unknown.

hasTactileSignageboolean

true if there is tactile navigation for/to this place, false if not.

interactions Object with one or more of these keys:

arrive book buy change checkIn checkOut eat explore getFood listen pay play read rent roam see sell use useLockers visit watch watchMovies watchPlays workHere

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isQuietboolean

Determines if the venue is quiet (subjectively, by the assessor). If possible, use the ambientNoiseLevel property instead.

isWellLitboolean

Determines if the venue is well lit (subjectively, by the assessor). Will be replaced by a measurable lumen value in the future.

mediaundefined | Media[]

Information about media. null indicates there is no media, undefined or missing property indicates unknown.

offersActivitiesForPeopleWithPersonalProfile
parkingundefined | Parking

Information about parking facilities at/around the venue. null indicates there is no parking, undefined or missing property indicates unknown.

partiallyAccessibleWithPersonalProfile
pathwaysundefined | Pathways

Describes the accessibility of pathways to the place or inside the place’s boundaries (mixed)

pathwaysFromEntranceundefined | Pathways

For places inside other places (e.g. a room inside a building).

Describes the accessibility of pathways to the place. If an extra accessible entrance exists, describe pathways from there to this place.

pathwaysInsideundefined | Pathways

Describes the accessibility of pathways to the place or inside the place’s boundaries (mixed)

paymentundefined | Payment

Information about payment at the place. null indicates there is no payment possible/required, undefined or missing property indicates unknown.

restroomsundefined | Restroom[]

Describes the accessibility of restrooms in the place.

serviceContactLocalizedString
signageSystemsSignage[]

Describes local signage systems. If multiple different systems are used, describe them all.

smokingPolicyOne of the following strings:

allowedEverywhere dedicatedToSmoking inIsolatedArea inSeparateArea onlyOutside prohibited

Object describing the owner's smoking policy.

staffundefined | Staff

Information about the service staff. null indicates there is no staff, undefined or missing property indicates unknown.

surfaceundefined | Surface

Object describing the place's ground condition. If there are very different ground conditions, you can create multiple places and nest them.

tablesundefined | Desk[]

Information about tables (for example in a restaurant). null indicates there are no tables, undefined or missing property indicates unknown.

wheelchairAccessibilityGradeOne of the following strings:

fully not partially

Describes the general wheelchair accessibility of the place. This is a human-rated value.

wheelchairPlacesundefined | WheelchairPlaces

Information about wheelchair places. null indicates there are no places, undefined or missing property indicates unknown.

wifiWifiAccessibility

Describes the Wifi availability and accessibility at the place.

ActionMode

Describes necessary abilities and modes inputting information.

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

Who has access to this action?

activationForceForce

Force needed for the described input method.

activationTimeIntervalTimeInterval

Time interval needed for activation/engagement.

apiDocumentationUrlLocalizedString

The input API documentation URL.

attentionSpanTimeInterval

Attention time needed for activation/engagement.

bodyHeightLength

A supported body height.

bodyMassMass

A supported body weight.

brailleKeyboardboolean

The ability to write textual content with a braille keyboard is supported or needed.

brailleTextboolean

The ability to read braille is supported or needed.

burnHazardboolean

There is a burn hazard.

cableboolean

A cable is supported or needed.

capacitiveboolean

The action uses a capacity sensor, for example a touch sensor.

clapboolean

Clapping your hands is supported or needed.

clickboolean

The ability to click a button with a finger is supported or needed.

descriptionLocalizedString

Describes the output as human-readable text.

directionOne of the following strings:

backward clockwise counterclockwise down forward left right up

The direction of the action, relative to the body.

directionAxisOne of the following strings:

axial coronal sagittal

The direction axis of the action, relative to the body.

doubleClickboolean

The ability to click a button with a finger is supported or needed.

dragboolean

The ability to drag an object is supported or needed.

dragAndDropGestureboolean

The ability to do a virtual drag-and-drop finger/mouse gesture is supported or needed.

educationLevelNumber

Education level needed to understand the action.

http://www.ibe.unesco.org/en/glossary-curriculum-terminology/l/levels-education

  • early childhood education (level 0)
  • primary education (level 1)
  • lower secondary education (level 2)
  • upper secondary education (level 3)
  • postsecondary non-tertiary education (level 4)
  • short-cycle tertiary education (level 5)
  • bachelor’s or equivalent level (level 6)
  • master’s or equivalent level (level 7)
  • doctor or equivalent level (level 8).
eyeTrackerboolean

The ability to use an eye tracker is supported or needed.

faceRecognitionboolean

The input uses face recognition.

feedbackPerceptionMode

How is feedback given for an input?

fingerprintScanboolean

The input uses a fingerprint scanner.

handwritingboolean

The ability to write textual content by hand is supported or needed.

hapticboolean

Haptic input is supported or needed.

headPointerboolean

The ability to use a head pointer is supported or needed.

headphoneboolean

Headphones are supported or needed.

highContrastboolean

The input has high contrast elements, for example around buttons.

instructionsUrlLocalizedString

URL describing how to use the input mechanism.

irisScanboolean

The input uses an iris scanner.

isEasyToFindboolean

true if the item is easy to find, false if people might face difficulties trying to find the item, or undefined if this is unknown or irrelevant.

isEasyToUnderstandboolean

true if the input is easy to understand, false if people might face difficulties trying to understand how the input works, or undefined if this is unknown or irrelevant.

joystickboolean

The ability to use a joystick is supported or needed.

keyboardboolean

The ability to write textual content by typing on a keyboard is supported or needed.

keypadboolean

The ability to write numbers by typing on a keypad is supported or needed.

knobboolean

The action uses a knob.

knurledboolean

The input has a knurled surface, for example around buttons.

languagesstring[]

Input languages supported.

leftHandedboolean

You can or must give input with your left hand.

lickboolean

The ability to lick an object with your tongue is supported or needed (e.g. a lollipop)

morseCodeboolean

Morse code input is supported or needed.

mouseboolean

The ability to use a mouse is supported or needed.

moveboolean

The ability to move an object is supported or needed.

nameLocalizedString

Describes which output is meant. Helpful if there are multiple outputs.

necessaryClimbHeightLength

Height you need to be able to climb over (for obstacles)

necessaryEyeHeightLength

How tall do you have to be to perceive the content/output/signal.

necessaryGripHeightLength

The height you need to grip to perceive the content/output/signal.

optionalboolean

true if the action is optional, false if it is required.

paperboolean

Handling paper is supported or needed.

pedalboolean

The ability to use a pedal is supported or needed.

photoboolean

The input makes a photo.

pinchboolean

The ability to pinch an object is supported or needed.

pinchFingerGestureboolean

The ability to use a pinch finger gesture is supported or needed.

pressboolean

The ability to apply force to an object is supported or needed.

pullSwitchboolean

The ability to use a pull switch is supported or needed.

pullstringboolean

The ability to use a pullstring is supported or needed.

pushButtonboolean

The ability to use a push button is supported or needed.

pushSwitchboolean

The ability to use a push switch is supported or needed.

qrCodeboolean

A QR code is supported or needed.

raisedTextboolean

true if the controls or signs have raised letters, false if not.

requiredboolean

false if the action is optional, true if it is required.

rhythmboolean

The ability to use rhythm input is supported or needed.

rightHandedboolean

You can or must give input with your right hand.

rotateboolean

The ability to rotate an object is supported or needed.

rotateTwoFingersGestureboolean

The ability to use a two-finger rotation gesture is supported or needed.

scratchboolean

The ability to scratch is supported or needed.

screenboolean

A screen is supported or needed.

signLanguageboolean

The ability to use sign language is supported or needed.

singleHandedboolean

You can or must give input with one hand.

sipAndPuffboolean

The ability to use a sip and puff switch is supported or needed.

smellboolean

The ability to smell is supported or needed.

soundRecordingboolean

The input makes a sound recording.

speakboolean

The ability to speak is supported or needed.

squeezeboolean

The ability to squeeze an object is supported or needed.

stateCountnumber

State count for a button or switch, for example 2 for a toggle button, 3 for a 3-way button.

swipeFingerGestureboolean

The ability to use a swipe finger gesture is supported or needed.

swipeThreeFingersGestureboolean

The ability to use a three-finger swipe gesture is supported or needed.

swipeTwoFingersGestureboolean

The ability to use a three-finger swipe gesture is supported or needed.

tactileboolean

Tactile input is supported or needed.

tactileGuidesboolean

The input has tactile guides, for example around buttons.

tapboolean

The ability to tap an element with a finger is supported or needed.

tearApartboolean

The ability to tear something apart is supported or needed.

techSufficientTechCombination[]

Technology combinations that are sufficient to make use of the output.

techSupportedTechCombination[]

Technologies that are sufficient to make use of the output.

tiltboolean

The ability to tilt an object is supported or needed.

tongueboolean

The ability to move an object with your tongue is supported or needed.

touchboolean

Touch input is supported or needed.

touchscreenboolean

Touchscreen input is supported or needed.

trackballboolean

The ability to use a trackball is supported or needed.

tripleClickboolean

The ability to click a button with a finger is supported or needed.

turnboolean

The ability to turn an object is supported or needed.

turnKnobboolean

The ability to turn a knob is supported or needed.

twoHandedboolean

You can or must give input with both hands.

urlLocalizedString

URL where you can use the input mechanism, e.g. on your phone.

videoboolean

The input makes a video.

visualRecognitionboolean

true if the input user interface needs or supports visual input, false if not.

voiceActivationboolean

true if the control is activated by voice, false if not.

walkboolean

Walking is supported or needed.

waveboolean

Waving your hands is supported or needed.

weightMass

A weight you need to be able to lift.

wheelboolean

The input features a wheel.

wirelessboolean

The input is wireless.

AnimalPolicy

NameType
allowsAssistanceDogsboolean

true if the place allows visitors to bring assistance dogs, false if bringing them is explicitly prohibited, undefined if the policy is unknown.

allowsDogsboolean

true if the place allows visitors to bring dogs in general, false if bringing them is explicitly prohibited (with exception of dogs specified by allowsGuideDogs and allowsTherapyAnimals), undefined if the policy is unknown.

allowsGuideDogsboolean

true if the place allows visitors to bring guide dogs, false if bringing them is explicitly prohibited, undefined if the policy is unknown.

allowsServiceAnimalsboolean

true if the place allows bringing any kind of animal, false or undefined if not or if there are exceptions.

dogsNeedMuzzleboolean

true if the place denies entry to visitors bringing a dogs without muzzles, false if dogs without muzzles are explicitly allowed.

suppliesWaterForPetsboolean

true if the place supplies water for accompanying animals, false if explicitly not, or undefined if unknown.

CurrencyValue

Describes an amount of paid money in a specific currency, per specified unit, for a specific kind of access to a service or product.

Can represent free availability, by setting amount to 0, and not defining currency.

Don't use this for very small amounts of money (like sub-cent dollar amounts) as this uses no BigDecimal arithmetic.

The amount property is required.

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

For whom is this amount of money paid?

amount*number

The amount of money.

currencystring

The currency in which the amount is specified, as three-letter acronym.

Can be undefined if the amount is zero.

paymentTypesPayment[]

The payment method that is used to pay the amount of money.

perQuantity

Unit that is paid with the amount of money, e.g. "30 minutes", "1 hour", '1 GB', '3 pieces'

Desk

Describes a desk / table / cash desk / reception counter.

NameType
depthBelowLength

How much space is there under the desk? This can be used to determine if a wheelchair user can sit at the desk.

fixedHeightLength

How high is the desk? For variable-height desks, use minimalHeight and maximalHeight instead.

This can be used to determine if a wheelchair user can sit at the desk.

fixedHeightBelowLength

How much space is there below the desk? This can be used to determine if a wheelchair user can sit at the desk.

interactions Object with one or more of these keys:

changeHeight checkIn checkOut close enqueue getFood getReturn getShoppingBag handover handoverLuggage lock open openAndClose pay ringBell savePreset scan selfCheckout unlock unlockAndLock

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

intercomundefined | Intercom

Information about an intercom at this desk, if applicable.

null indicates there is no intercom.

isRollUnderboolean

true if the desk can be rolled under, false if not. This can be used to determine if a wheelchair user can sit at the desk.

maximalHeightLength

How high is the desk maximally? This is only for variable-height desks. Use fixedHeight for fixed-height desks. This can be used to determine if a wheelchair user can sit at the desk.

minimalHeightLength

How high is the desk minimally? This is only for variable-height desks. Use fixedHeight for fixed-height desks. This can be used to determine if a wheelchair user can sit at the desk.

nameLocalizedString

Name of the entrance (helpful if there are multiple entrances).

paymentundefined | Payment

Information about payment at this desk.

null indicates there is no payment possible/required.

queueSystemQueueSystem

Describes an associated queue system.

turningSpaceInFrontLength

How much space is there in front of the desk? This can be used to determine if a wheelchair user can sit at the desk.

widthBelowLength

How much space is there below the desk? This can be used to determine if a wheelchair user can sit at the desk.

Door

Describes the door of a place's entrance or to one of its facilities (e.g. to a shower, or to an elevator)

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

Defines who this door is for. See https://wiki.openstreetmap.org/wiki/Key:access for more information.

colorsstring[]

Describes the colors of the door itself, as HTML color strings. Don't include the door frame or door marking colors in this attribute, but use markingColors and doorFrameColors instead.

This can make the door easier to find.

If there are multiple colors, it might be enough to describe the most dominant one.

If there are multiple colors, but there is no predominant color, describe all of them.

This allows to determine the contrast to the wall and the door frame.

Its best to determine the color at daylight.

For glass doors, you can use 'transparent' as color.

doorFrameColorsstring[]

Describes the colors of the door frame, if existent. If they are similar, describe only one color. Use HTML color strings here.

This can make the door easier to find, and allows to determine the contrast to the door and the wall.

If there are multiple colors, it might be enough to describe the most dominant one.

If there are multiple colors, but there is no predominant color, describe all of them.

Its best to determine the color at daylight.

doorOpensToOutsideboolean

true if the door opens to the outside, false if it opens to the inside.

doorbellTopButtonHeightLength

Height of the door bell's top button. If there is a lowered extra door bell (often marked with a wheelchair user symbol), use the height of this one's top button.

grabBarsGrabBars

Describes grab bars in front of the door.

hasClearMarkingOnGlassDoorboolean

true if the door is a glass door, but is marked, false if the door is an unmarked glass door, undefined if it is no glass door or the condition is unknown.

hasErgonomicDoorHandleboolean

true if the door's handle is easy to use (subjectively by the assessor), false if not.

hasIntercomboolean

true if the door has an intercom system, false if not.

hasProximitySensorboolean

true if the door has a proximity sensor that triggers the opening mechanism, false if not.

hasSwitchboolean

true if the door has a switch that triggers the opening mechanism, false if not.

hasVisuallyContrastedFrameboolean

true if the door frame is visually contrasted to its surrounding wall, false if not.

interactions Object with one or more of these keys:

close lock open openAndClose ringDoorbell unlock unlockAndLock

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

intercomIntercom

Describes the intercom system of the door.

isAlwaysOpenboolean

true if the door is there, but always open, false if not.

isAutomaticboolean

true if the door opens automatically, false if not. The mechanism for opening the door is defined in other attributes.

isAutomaticOrAlwaysOpenboolean

true if the door is always open or automatic, false if it has to be opened manually.

isEasyToHoldOpenboolean

true if the door is easy to hold open (subjectively by the assessor), false if not.

isGlassDoorboolean

true if the door is a glass door, false if not.

isRevolvingboolean

true if the door is revolving (like a carousel), false if not.

isSlidingboolean

true if the door is a sliding door, false if not.

isTurnstileboolean

true if the door is a turnstile, false if not.

isVisuallyContrastedboolean

true if the door is visually contrasted to its surrounding wall, false if not.

markingColorsstring[]

Describes the colors of a door marking, if existent, as HTML color strings.

This can make the door easier to find.

If there are multiple colors, it might be enough to describe the most dominant one.

If there are multiple colors, but there is no predominant color, describe all of them.

Its best to determine the color at daylight.

nearbyWallColorsstring[]

Describes the colors of the walls right next the door. Use HTML color strings here.

This can make the door easier to find, and allows to determine the contrast to the door frame and the door.

  • If there are multiple colors, it might be enough to describe the most dominant one.
  • If there are multiple colors, but there is no predominant color, describe all of them.

Its best to determine the color at daylight.

needsDoorbellboolean

true if you need to ring a doorbell to pass the entrance, false if not.

needsEuroKeyboolean

true if you need a Euro key to open the door, false if it's in Europe outside UK and works without a key, undefined if it is unknown or needs a different key.

needsIntercomboolean

true if you need to use the intercom to pass this door, false if not.

needsKeyCardboolean

true if you need to use a keycard to pass the entrance, false if not.

needsKeyPadboolean

true if you need to use a key pad to pass this door, false if not.

needsRadarKeyboolean

true if you need a RADAR key to open the door, false if it's in the UK but you need no key or needs a different key.

needsSwitchToOpenboolean

true if the door needs pressing a switch to open, false if not.

thresholdHeightLength

Height of the door’s threshold / sill / step inside the door frame.

thresholdIsRoundedboolean

true if the threshold has rounded edges, false if not.

turningSpaceInFrontLength

Turning space in front of the door.

widthLength

Width of the door.

Entrance

Describes an entrance to a PlaceInfo.

NameType
geometryPointGeometry

The physical location of the entrance in WGS84 coordinates. Currently only a GeoJSON PointGeometry is supported.

propertiesEntranceProperties

EntranceProperties

Describes an entrance to a place.

NameType
doorundefined | Door

Object that describes the entrance’s door. null if there is no door.

elevatorEquipmentIdstring

reference to the equipment id if this entrance is an elevator (on accessibility.cloud)

hasFixedRampboolean

true if this entrance has a fixed ramp, false if not.

hasHoistboolean

true if there is a hoist / wheelchair lift, false if not.

hasRemovableRampboolean

true if there is a removable ramp, false if not. If there is a fixed ramp, this property MUST be undefined.

hasSignageboolean

If this entrance is NOT the main entrance: Is this entrance connected to the main entrance, and is there signage that points to this entrance?

intercomEquipmentIdstring

reference to the equipment id of the intercom of this entrance (on accessibility.cloud)

isLevelboolean

true if this entrance has no steps and needs no ramp, false if there are steps or a ramp.

isMainEntranceboolean

true if this is the main entrance, false if not.

nameLocalizedString

Name of the entrance (helpful if there are multiple entrances).

needsAppointmentboolean

true if you need an appointment to enter, false if not.

placeInfoIdstring

reference to the place that this entrance is connected to (on accessibility.cloud)

slopeAngleSlope

How steep is the ground at the entrance?

stairsStairs

Object that describes stairs that you have to take to use the entrance.

EquipmentInfo

Describes a facility equipment that is part of a place, like an elevator, an escalator, or a sitemap. Can contain attributes that are realtime updated to indicate operational status.

NameType
geometryPointGeometry

The physical location of the place in WGS84 coordinates. Currently only a GeoJSON PointGeometry is supported.

propertiesEquipmentProperties

EquipmentProperties

NameType
accessModestring[]

Access modes supported by this equipment.

accessModeSufficientstring[]

Access mode combinations that allow understanding and using the equipment.

accessibilityControlstring[]

The accessibility controls that allow controlling this equipment.

accessibilityFeaturestring[]

Indicates features that allow understanding or using the equipment.

accessibilityHazardstring[]

Indicates hazards that may be an obstacle to understanding or using the equipment.

alternativeRouteInstructionsLocalizedString

Short alternative routing instructions for travelers when they cannot use this facility.

The text MUST NOT have abbreviations to be readable aloud by a screen reader or voice assistant.

Software using this attribute MUST NOT assume that the equipment is out of operation if it the attribute is defined.

cabinLengthLength

Length / depth of the cabin when facing the equipment’s entrance, or undefined if the equipment has no cabin. For a hoist, this refers to the hoist platform itself.

cabinWidthLength

Width of the cabin when facing the equipment’s entrance, or undefined if the equipment has no cabin. For a hoist, this refers to the hoist platform itself.

categoryOne of the following strings:

bed bodyScanner elevator escalator flushMechanism hoist intercom luggageScanner movingWalkway powerOutlet ramp sitemap stairLift switch vendingMachine wardrobe

Type of the equipment or facility.

descriptionLocalizedString

Describes where the equipment is located. If only one description string is technically possible to maintain, it MUST not contain any abbreviations to allow being readable aloud by screen readers or voice assistants.

disruptionSourceImportIdstring

Data source ID of a secondary source used for realtime status info on accessibility.cloud

doorDoor

Object describing the door to the equipment, or undefined if there is no door.

emergencyIntercomIntercom

Describes the intercom system for emergency calls.

hasDoorsAtRightAnglesboolean

true if the equipment has doors at right angles to each other.

hasDoorsInBothDirectionsboolean

true if the equipment has doors in two directions, so wheelchair, rollator, bike or pushchair users do not have to move backwards to exit.

hasExternalFloorSelectionboolean

For elevators. true if the elevator needs a command to be entered outside the elevator, false if not.

hasLandingsboolean

true if the equipment has a landing platform, false if not. Helpful for escalators.

hasMirrorboolean

For elevators. true if the elevator has a mirror, false if not.

hasVisualEmergencyAlarmboolean

true if the equipment has a visual emergency alarm, false if not (for example, inside elevators).

heightOfControlsLength

Height of the lowest working controls that are needed to operate this equipment. undefined if the equipment needs no controls.

ids Object with one or more of these keys:

string

Values must be of type string.

IDs in other data sources that are linked to this equipment, indexed by schema/context.

interactions Object with one or more of these keys:

arriveAtFloor buy call callEmergency disable enable engage findYourDestination flush handover locateYourself ride scan selectFloor sell sleep toggle travel understand use

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isIndoorsboolean

true if the equipment is indoors, false if it’s fully or partially outdoors.

isSuitableForBicyclesboolean

For elevators. true if the elevator can carry a bicycle, false if not.

isWorkingboolean

Live status update.

true if the equipment is in operation, false if not, or undefined if it is unknown. When reading this attribute for showing it in a user interface, the user interface MUST show the operational status as ‘unknown’ if the status could be out of date, for example if it is older than 10 minutes.

When displaying the operational status, user interfaces SHOULD show the date saved in stateLastUpdate next to the operational status additionally for transparency.

languagesstring[]

Languages of the equipment’s visible controls and/or voice output.

longDescriptionLocalizedString

Contains the same information as description, but in a longer form which can be read out by a screen reader or voice assistant.

Words MUST be written out fully (e.g. ‘direction’ instead of ‘dir.‘, ‘ground’ instead of ‘G‘, ‘platform’ instead of ‘pl.’). The field MUST NOT contain any symbols (e.g. ->, <->, or ).

This MUST be suitable for people who have a visual impairment or use a screen reader or voice assistant (e.g. Amazon’s Alexa).

If only one description field can be used for technical reasons, then the written-out form MUST be given preference, because a short form can be generated from the long form more easily than the other way around.

This attribute SHOULD be used as aria-label-attribute in web content.

manufacturerNameLocalizedString

Official name of the company that manufactured the equipment.

manufacturerSerialNumberstring

Manufacturer serial number of the equipment / facility.

Intentionally not localizable to allow matching with other data, e.g. from manufacturer's own APIs.

originalDatastring

Original source data for this equipment (for easier debugging)

originalIdstring

ID of this equipment in the original data source. To simplify communication with the operator, it’s a good idea to use the operator facility management system ID here.

originalPlaceInfoIdstring

ID of the place that this equipment belongs to (unique in the original data source)

outOfOrderReasonLocalizedString

Live status update.

Reason why the equipment is not in operation. MUST be undefined if the equipment is in operation.

placeInfoIdstring

Place info ID that this equipment belongs to (accessibility.cloud ID)

placeSourceIdstring

ID of the place data source that this equipment belongs to (accessibility.cloud ID)

plannedCompletionDateDate

Live status update.

If isWorking is false, this is the planned date when the equipment will be in operation again.

MUST be undefined if the facility is currently in operation.

sameAsstring[]

URLs of this equipment in external data sources, for example in GTFS, IMDF or other sources.

servicePhoneNumberstring

Phone number where a service operator can be reached for help using this facility.

serviceWebsiteUrlstring

URL pointing to a website that describes the equipnent or it's current operational status.

shortDescriptionLocalizedString

Contains the same information as description, but in a shorter form, to save space on the screen. This CAN contain Unicode characters such as ⟷ or ↘︎ as well as abbreviations (e.g. ‘pl.’ instead of ‘platform’, ‘dir.’ instead of ‘direction’).

sourceIdstring

Data source ID on accessibility.cloud

sourceImportIdstring

Data import ID on accessibility.cloud

stateExplanationLocalizedString

Live status update.

Information about the current state. If isWorking is true, this can show information about future planned maintenance or construction work rendering this facility unusable.

The text MUST NOT have abbreviations to be readable aloud by a screen reader or voice assistant.

This field SHOULD only be used if a separation into individual disorder attributes (state, outOfOrderReason) is not technically possible (e.g. when existing APIs can not be further developed and users are only given one text field to describe the problem.)

stateLastUpdateDate

Live status update.

Date when the isWorking flag was updated by a realtime system.

GrabBars

Describes grab bars or hand rails.

The continuous property is required.

NameType
continuous*boolean

Indicates if the grab bars are continuous or not. Helpful for stair grab rails.

distanceBetweenBarsLength

Indicates how far the bars are apart.

foldableboolean

true if the grab bars can be folded, false if not..

inFrontOfTheUserboolean

true if there is a folding handle in front of the user, false if not.

Seen from the perspective

  • of somebody using a toilet
  • of somebody in front of stairs, facing upwards
  • of somebody in front of a door
interactions Object with one or more of these keys:

adjust findYourDestination foldDown foldUp localizeYourself

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

onUsersLeftSideboolean

true if there is a folding handle on left side, false if not.

Seen from the perspective

  • of somebody using a toilet
  • of somebody in front of stairs, facing upwards
  • of somebody in front of a door
onUsersRightSideboolean

true if there is a folding handle on right side, false if not.

Seen from the perspective

  • of somebody using a toilet
  • of somebody in front of stairs, facing upwards
  • of somebody in front of a door
topHeightFromFloorLength

Indicates how high the grab bars are (top edge, measured from the floor).

Interactable

NameType
interactions Object with one or more of these keys:

InteractionType

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

InteractionMode

Describes how you can interact with a thing and which abilities you need to do so.

NameType
actionActionMode

Action modes that are absolutely necessary to facilitate the interaction, e.g. ‘pushing a button’.

descriptionLocalizedString

Describes the output as human-readable text.

languagesstring[]

Input languages supported.

nameLocalizedString

Describes which output is meant. Helpful if there are multiple outputs.

optionalboolean

true if the interaction is optional, false if it is required.

perceptionPerceptionMode

Perception modes supported to facilitate the interaction.

requiredboolean

false if the interaction is optional, true if it is required.

Intercom

Describes a system to communicate over distance, e.g. a door intercom next to a doorbell.

NameType
ambientNoiseLevelVolume

The ambient noise level when using the intercom.

audioIsComprehensibleboolean

true if intercom system’s audio quality is good enough for understanding speech, false if not.

descriptionLocalizedString
hasAudioboolean

true if the door has an audio intercom system, false if not.

hasVideoCameraboolean

true if the door has a video intercom system, false if not.

hasVisualFeedbackOnConnectionboolean

true if the intercom system has a visual feedback, false if not. Visual feedback might be a screen or light that displays if a connection is established.

interactions Object with one or more of these keys:

call close hangUp identify open ring

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

necessaryGripHeightLength

The height of the top control element of the intercom system.

needsKeyPadboolean

true if you need to use a key pad to pass this door, false if not.

Media

Describes a media unit provided at this place, for example an exhibit at a museum or a movie in a cinema.

NameType
accessModestring[]

Access modes supported by this equipment.

accessModeSufficientstring[]

Access mode combinations that allow understanding and using the equipment.

accessibilityControlstring[]

The accessibility controls that allow controlling this equipment.

accessibilityFeaturestring[]

Indicates the access mode combinations that allow understanding and using the equipment.

accessibilityHazardstring[]

Indicates the access mode combinations that allow understanding and using the equipment.

hasAudioDescriptionboolean

Is the media unit provided with audio description?

hasContrastingBackgroundboolean

If the media unit is printed or on a screen, does it have high contrast between background and foreground?

hasDedicatedScreenForSubtitlesboolean

Relevant for movies, screens and presentations: Is there a dedicated screen where subtitles can be read?

hasPlainLanguageOptionboolean

Is the media unit provided in a Plain Language option?

hasRealTimeCaptioningboolean

Does the media unit have real time captioning?

hasSubtitlesboolean

Is the media unit provided with subtitles?

isAudioboolean

Is the media unit consumable as audio-only option?

isBrailleboolean

Is the media unit consumable or described for Braille readers?

isLargePrintboolean

If the media unit is printed, is the print large?

isTactileboolean

Is the media tactile?

languagesstring[]

Specifies which languages (including sign languages) in which the media unit is provided

nameLocalizedString

Name of the media unit (relevant if there are multiple units of the same kind)

sameAsstring[]

URLs that contain the media. Use this to link data, for example with RDF.

turningSpaceInFrontLength

If the media is consumed while the consumer is directly in front of it, this property specifies how much turning space there is in front of it.

typeOne of the following strings:

document exhibit guide menu movie play presentation screen tour website

Type of the media unit

Mirror

Describes a mirror.

heightFromGround and isAccessibleWhileSeated properties are required.

NameType
heightFromGround*Length

How far is the mirror's bottom from the ground?

interactions Object with one or more of these keys:

adjust clean move turn use

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isAccessibleWhileSeated*boolean

true if the mirror is accessible while sitting in a wheelchair, false if not.

isLocatedInsideRestroomboolean

true if the mirror is located inside the restroom, false if not.

Parking

NameType
countnumber
forWheelchairUsersundefined | WheelchairParking
interactions Object with one or more of these keys:

arrive enterVehicle exitVehicle park

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

Pathways

Describes one or multiple pathways inside a place.

NameType
isKerbstoneFreeboolean

true if the pathway is kerbstone-free, false if not.

surfaceSurface
widthLength

Width constraints of all pathways inside a place relevant for consumers.

widthAtObstaclesLength

Width constraints of all pathways inside a place relevant for consumers.

Payment

The Payment interface describes the payment options at a location.

NameType
acceptsBillsboolean
acceptsCoinsboolean
acceptsCreditCardsboolean
acceptsDebitCardsboolean
acceptsPaymentByMobilePhoneboolean
customPaymentMetaInfoLocalizedString[]
hasPortablePaymentSystemboolean

PerceptionMode

Describes necessary abilities and modes for interpreting information output, signals, or content.

NameType
accelerationAcceleration

Feedback force applied to the user.

activationSignalboolean

The output is an activation/engagement signal.

ambientNoiseLevelVolume

Ambient noise level in dB(A) relative to a reference pressure of 0.00002 Pa. Median over a 10-second period at least.

ambientTemperatureTemperature

The ambient temperature around the output.

animationboolean

The output is animated.

apiDocumentationUrlstring

The input API documentation URL.

attentionSpanTimeInterval

Attention time span needed to understand the output.

audibleClickboolean

The output has an acoustic click feedback.

audioDescriptionboolean

The output has audio description.

audioIsComprehensibleboolean

true if the system’s audio quality is good enough for understanding speech, false if it is difficult.

backgroundColorsstring[]

Background output HTML colors (for example, the background behind a text or icon).

backgroundMusicboolean

There is background music playing.

beepboolean

The output uses one or more beeps as signal.

bingboolean

The output uses one or more bing-like signals.

blackAndWhiteboolean

The output uses black and white colors.

brailleboolean

The ability to read braille is supported or needed.

breathingboolean

The light looks like it is breathing.

brightnessBrightness

The output's brightness.

byodboolean

true if you can or have to perceive the content with a device that you own.

cableboolean

A cable is supported or needed.

chartboolean

The output uses one or more charts.

colorCodeboolean

The output uses a discrete color code.

colorGradientboolean

The output uses a color gradient.

contentWarningLocalizedString

Lists potential content warnings you have to expect here. User interfaces should not show the content warning directly, but should instead show a button to show the content warning.

dedicatedScreenForSubtitlesboolean

The output has a dedicated screen for subtitles.

descriptionLocalizedString

Describes the content/output/signal as human-readable text.

durationTimeInterval

Time interval in which the output is active.

educationLevelNumber

Education level needed to understand the output.

http://www.ibe.unesco.org/en/glossary-curriculum-terminology/l/levels-education

  • early childhood education (level 0)
  • primary education (level 1)
  • lower secondary education (level 2)
  • upper secondary education (level 3)
  • postsecondary non-tertiary education (level 4)
  • short-cycle tertiary education (level 5)
  • bachelor’s or equivalent level (level 6)
  • master’s or equivalent level (level 7)
  • doctor or equivalent level (level 8).
flashboolean

The output is a flashing light.

flashingHazardboolean

true if the output is a flashing hazard, false if there is explicitly no flashing hazard and someone / something ensures this. This can be relevant for people with epilepsy.

fontSizeLength

Font size used in the output.

forceForce

Feedback force applied to the user.

forceFeedbackboolean

The content/output/signal has active force feedback.

foregroundColorsstring[]

Foreground output HTML colors (for example, the text or icon color).

framerateHertz

The framerate of animations.

frequencyHertz

The frequency of the output, for tones or flashes.

fullBodyboolean

The content/output/signal affects your full body.

handwrittenboolean

The content is handwritten.

hapticboolean

The output is haptic.

hapticClickboolean

The output has a haptic click feedback.

headphoneboolean

Headphones are supported or needed.

heatboolean

Heat perception is supported or needed.

highContrastboolean

The output is displayed in high contrast.

instructionsUrlLocalizedString

URL describing how to make use of the content/output/signal.

isEasyToFindboolean

true if the input is easy to find.

isEasyToUnderstandboolean

true if the input is easy to understand, false if people might face difficulties trying to understand how the input works, or undefined if this is unknown or irrelevant.

languagesstring[]

Content languages supported.

ledboolean

The output is an LED.

lightboolean

The output is a light.

morseboolean

The output uses morse code.

musicboolean

The output uses music.

nameLocalizedString

Describes which output is meant. Helpful if there are multiple signals/outputs/content lements.

necessaryEyeHeightLength

How tall do you have to be to perceive the content/output/signal.

necessaryGripHeightLength

The height you need to grip to perceive the content/output/signal.

needsHighConcentrationboolean

The output needs high concentration to understand.

numbersboolean

The output uses one or more numbers.

optionalboolean

true if the perception is optional, false if it is required.

paperboolean

The output is displayed on a paper.

pictogramsboolean

The output uses one or more pictograms.

pitchedToneboolean

The output uses a pitched tone as signal.

plainLanguageOptionboolean

The output has a plain language option.

printerboolean

The output is from a printer.

qrCodeboolean

A QR code is supported or needed.

radioboolean

A radio connection is supported or needed (e.g. WiFi, Bluetooth, NFC, etc.)

readboolean

The ability to read is supported or needed.

realTimeCaptioningboolean

The output has realtime captioning.

requiredboolean

false if the perception is required to make use of the main function of the described object, true if it is required.

rhythmicboolean

The output is rhythmic.

screenboolean

The output is displayed on a screen.

signLanguageboolean

The ability to understand sign language is supported or needed.

smellboolean

The ability to smell is supported or needed.

soundboolean

The output is acoustic.

soundVolumeVolume

The content/output/signal has active vibration feedback.

speechboolean

The ability to understand speech is supported or needed.

staticboolean

true if the output is usually static and does not change over time, false if it is dynamic and changes over time.

subtitlesboolean

The output has subtitles.

tactileboolean

The output is tactile.

tactileGuidesboolean

The output has tactile guides, for example around buttons.

tasteboolean

Tasting something is supported or needed.

techSufficientTechCombination[]

Technology combinations that are sufficient to make use of the content/output/signal.

techSupportedTechCombination[]

Technologies that are sufficient to make use of the content/output/signal.

temperatureTemperature

The temperature of the output.

urgencyOne of the following strings:

alarm alert debug info warning

Urgency of the content when perceived.

urlLocalizedString

URL where you can see or make use of the content/output/signal, e.g. on your phone.

vibrationboolean

The content/output/signal has active vibration feedback.

visualboolean

The output is visual.

PersonalProfile

Describes a person. This exists only to transform data from sources where no physical attributes of places have been captured as data directly. It's better to describe physical attributes of places and let people decide themselves which facilities they need or which place condition works for them.

NameType
blindnessboolean

true for a person that is blind.

guideDogboolean

true for a person that has a guide dog.

hearingImpairmentboolean

true for a person that has a hearing impairment.

learningImpairmentboolean

true for a person that has a learning impairment.

mobilityImpairmentboolean

true for a person that has a mobility impairment.

mutenessboolean

true for a person that is inable to speak.

visualImpairmentboolean

true for a person that has a visual impairment.

wheelchairboolean

true for a person that uses a wheelchair.

PlaceInfo

The PlaceInfo interface describes a physical location with added accessibility properties.

geometry and properties properties are required.

NameType
formatVersionstring

The format version this place info document was created with (Uses the npm module version from package.json) Not used right now, but added for future compatibility.

geometry*PointGeometry

The physical location of the place in WGS84 coordinates. Currently only a GeoJSON PointGeometry is supported.

properties*PlaceProperties

Holds additional place properties such as name and category and accessibility information

PlaceProperties

Properties of a place of interest.

The category property is required.

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

Defines who this restroom is for. See https://wiki.openstreetmap.org/wiki/Key:access for more information.

accessibilityundefined | Accessibility

The accessibility of this place. null indicates that this place has no data, undefined or missing property indicates unknown.

addressundefined | StructuredAddress

The address of this place. null indicates that this place has no address, undefined or missing property indicates unknown.

category*string

Category name of the place

descriptionLocalizedString

Text description containing helpful information for people with disabilities.

editPageUrlstring

URL of the original data source’s website on a subpage that allows to edit the original data.

emailAddressstring

Email address of the place's operator where you can get accessibility relevant information.

ids Object with one or more of these keys:

string

Values must be of type string.

IDs in other data sources that are linked to this equipment, indexed by schema/context.

infoPageUrlstring

URL of the original data source’s website describing this place.

nameLocalizedString

The official name of this place.

originalDataany

Original source data for this equipment (for easier debugging)

originalIdstring

ID of this place of interest in the original data source. To simplify communication with the data provider, it’s a good idea to use the provider's internal ID here.

originalParentPlaceInfoIdstring

The parent's place ID in the original dataset from the data provider.

parentPlaceInfoIdstring

ID of the parent place that this place belongs to.

parentPlaceSourceIdstring

Source ID of the parent place that this place belongs to. This is usually the same ID as sourceId, but the parent place can be from another data provider.

phoneNumberstring

Phone number to call a representant of the place's operator.

placeWebsiteUrlstring

URL of the place’s own website.

sameAsstring[]

URLs of this equipment in external data sources, for example in GTFS, IMDF or other sources.

sourceIdstring

ID of the data source that provided the place (accessibility.cloud ID)

sourceImportIdstring

ID of the import that created this place (accessibility.cloud ID)

PointGeometry

GeoJSON Point object.

coordinates and type properties are required.

NameType
coordinates*tuple with 2 number elements
type*"Point"

Quantity

Describes a quantity of a unit type.

NameType
accuracynumber

± in given units, uniform error.

maxnumber

maximal value (inclusive)

minnumber

minimal value (inclusive)

operatorOne of the following strings:

!= < <= = == > >= ~ ~=

the operator, indicating the value is not an absolute value

precisionnumber

± in given units, uniform error

rawValuestring

raw, imported value, eg. '90 .. 120cm' - only required when importing

unitstring

one of the length units in js-quantities

valuenumber

the value in the specified unit

QueueSystem

Describes a system that encourages or forces people to queue up.

NameType
canSkipQueueWithDisabilityboolean

true if you can skip the queue with a disability, false if not.

grabBarsGrabBars

Grab bars inside the queueing system, if applicable.

interactions Object with one or more of these keys:

arrive checkIn checkOut enqueue getOnesTurn getTicket leaveQueue skipQueue wait

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

needsTicketsboolean

true if the queueing uses tickets (usually numbered), false if not.

numberOfQueueServerPointsnumber

Number of queue server points.

numberOfSeatsnumber

Number of seats that can be used by people while waiting in the queue.

usesCattleBarsboolean

true if the queueing uses rails / cattle bars, false if not.

Restroom

Describes a Room that contains one or more Toilets or Showers.

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

Defines who this restroom is for. See https://wiki.openstreetmap.org/wiki/Key:access for more information.

addressStructuredAddress
descriptionLocalizedString
entranceEntrance

Object describing the entrance to this restroom.

hasBathTubboolean

true if there is a bath tub in this room, false if not, undefined if condition is unknown.

hasCeilingHoistboolean

true if the restroom has a ceiling hoist, false if not.

hasChangingTableForAdultsboolean

true if the restroom has a changing table for adults, false if not.

hasChangingTableForBabiesboolean

true if the restroom has a changing table for babies, false if not.

hasEmergencyPullstringboolean

true if the restroom has an emergency pull string, false if not.

hasMirrorboolean

true if the restroom has a mirror, false if not.

hasShowerboolean

true if the restroom has a shower, false if not.

hasSupportRailsboolean

true if there support rails on the walls

heightOfDrierLength

At which height from the floor is the drier or towel?

heightOfSoapLength

At which height from the floor is the soap?

interactions Object with one or more of these keys:

closeWindow enter exit lookAround openWindow play see sit sleep stand storeThings wait

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isAccessibleWithWheelchairboolean

true if the room's relevant facilities are completely accessible while using a wheelchair, false if not, undefined if the condition is unknown or difficult to assess.

mirrorMirror

Describes a mirror, if existing.

sameAsstring[]
showerShower

Object describing a shower inside this restroom, if existing.

signIconsArray of one or more of these strings:

allGender baby changingTable family female male personInWheelchair toiletBowl urinal washBasin

Visible icons on the restroom’s sign

toiletToilet

Object describing a toilet inside the restroom, if existing.

turningSpaceInsideLength

How wide is the space inside that is usable for turning?

usageFeeCurrencyValue[]

Defines how much you have to pay to use this restroom. There might be multiple fee amounts, e.g. for different access types or usage times.

washBasinWashBasin

Object describing a wash basin belonging to this restroom. It can be outside of the restroom.

Room

Describes a room inside a structure.

NameType
addressStructuredAddress
descriptionLocalizedString
interactions Object with one or more of these keys:

closeWindow enter exit lookAround openWindow play see sit sleep stand storeThings wait

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isAccessibleWithWheelchairboolean

true if the room's relevant facilities are completely accessible while using a wheelchair, false if not, undefined if the condition is unknown or difficult to assess.

sameAsstring[]

Seat

Describes one or multiple seats / chairs / benches / stools / couches / sofas / armchairs / ...

NameType
adjustmentAxesArray of one or more of these strings:

axial coronal sagittal

The seat can be adjusted in the following axes.

adjustmentDirectionsArray of one or more of these strings:

backward clockwise counterclockwise down forward left right up

The seat can be adjusted in the following directions.

columnsnumber[]

The seat column numbers. This is only for seats in a fixed seating arrangement.

descriptionLocalizedString

Name of the entrance (helpful if there are multiple entrances).

fixedHeightLength

How high is the desk? For variable-height desks, use minimalHeight and maximalHeight instead.

This can be used to determine if a wheelchair user can sit at the desk.

hasHeadRestboolean

The seat has a headrest.

hasSeatbeltboolean

The seat has a seatbelt.

interactions Object with one or more of these keys:

adjust adjustArmRests adjustBackRest adjustFootRest adjustHeadRest adjustHeight adjustLegRest adjustSeatBelt adjustSeatBeltAngle adjustSeatBeltHeight adjustSeatBeltLength adjustSeatBeltLock adjustSeatBeltPosition adjustSeatBeltTension adjustSeatingAngle adjustSeatingSurface connectSeatbelt fold move sit unfold

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

intercomundefined | Intercom

Information about an intercom at this seat, if applicable.

null indicates there is no intercom.

isCenterColumnboolean

The seat is located at the center of the seating arrangement, laterally.

isFixedboolean

The seat is fixed.

isFoldableboolean

The seat can be folded.

isFrontRowboolean

The seat is located at the front row of the seating arrangement.

isLastRowboolean

The seat is located at the last row of the seating arrangement.

isMobileboolean

The seat is mobile.

isWheelchairAccessibleboolean

The seat is wheelchair accessible.

maximalHeightLength

How high is the desk maximally? This is only for variable-height desks. Use fixedHeight for fixed-height desks. This can be used to determine if a wheelchair user can sit at the desk.

minimalHeightLength

How high is the desk minimally? This is only for variable-height desks. Use fixedHeight for fixed-height desks. This can be used to determine if a wheelchair user can sit at the desk.

nameLocalizedString

Name of the entrance (helpful if there are multiple entrances).

paymentundefined | Payment

Information about payment at this seat or the cost of using this seat.

null indicates there is no payment possible/required.

reservedForPersonsWithPersonalProfile

The seat is reserved for persons with the given profile.

rowsnumber[]

The seat row numbers. This is only for seats in a fixed seating arrangement.

seatbeltPointsnumber

The number of seatbelt points.

turningSpaceInFrontLength

How much space is there in front of the desk? This can be used to determine if a wheelchair user can sit at the desk.

Shower

Describes a shower.

NameType
doorDoor
grabBarsGrabBars

Ergonomic handles inside the shower.

hasShowerSeatboolean

true if the shower has a seat, false if not..

hasSupportRailsboolean

true if the shower has support rails, false if not.

interactions Object with one or more of these keys:

transfer useConditioner useShampoo useShowerCurtain useShowerGel useShowerHead useSoap useSupport wash

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

seatSeat

Describes the shower seat, if existing.

stairsStairs

Signage

Describes a signage / physical navigation system belonging to a location.

NameType
descriptionLocalizedString

A description of the signage.

fontHeightLength

The height of the font used on the signage. Most likely in millimeters, using a range.

hasAudioboolean

true if the signage has audio, false if not.

hasBrailleboolean

true if the signage has braille, false if not.

hasNumbersboolean

true if the signage uses a numbering scheme, false if not, undefined if condition is unknown.

hasPictogramsboolean

true if the signage has pictograms, false if not.

hasRaisedLettersboolean

true if the signage has raised letters, false if not.

hasSearchboolean

true if the signage has a search function, false if not, undefined if condition is unknown.

hasTactileGuideStripsboolean

true if the signage has tactile guide strips, false if not, undefined if condition is nknown.

hasTactileHandRailsboolean

true if the signage has tactile hand rails, false if not, undefined if condition is unknown.

hasTactileMapboolean

true if the signage has a tactile map, false if not.

hasTactileNorthMarkersboolean

true if the signage has tactile north markers, false if not, undefined if condition is unknown.

https://twitter.com/saizai/status/1210352258950598656

hasTactilePavingboolean

true if the signage has tactile paving, false if not.

hasTactileRoomNamesboolean

true if the signage has tactile room names, false if not, undefined if condition is unknown.

hasTextboolean

true if the signage has text features, false if not.

hasVideoboolean

true if the signage has video, false if not.

hasVirtualMapboolean

true if the signage has a virtual map, false if not.

highLegibilityboolean

true if the signage has high legibility, false if not.

interactions Object with one or more of these keys:

findYourDestination locateYourself useSitemap

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isHighContrastboolean

true if the signage has high contrast, false if not.

Staff

Describes the presence of staff and their qualifications and/or provided services.

NameType
canSeeVisitorsFromInsideboolean

true if the staff has means to see visitors from the inside at all times when the place is open (for example a window or CCTV system), false if not.

hasFreeAssistantForVisitorsboolean

true if there is an assistant for the duration of the visit that is free of charge, false if not.

spokenLanguagesstring[]

Languages that the staff speaks, including sign language variants.

Uses IETF language codes.

Stairs

The Stairs interface describes one or more walkable stairs.

NameType
alternativeMobileEquipmentIdsstring[]

You SHOULD reference alternative equipment IDs with this field, for example elevators, escalators, or hoists.

countnumber

Number of steps.

floorsstring[]

Floor numbers that are accessible via these stairs.

grabBarsGrabBars

Grab bars belonging to the stairs.

hasAntiSlipNosingboolean

true if all relevant steps are made with anti-slip material.

hasBrailleSignageboolean

true if there is braille navigation in this staircase, false if not.

hasHandRailboolean

true if there is a handrail covering all relevant steps, false if not.

hasHighContrastNosingboolean

true if all relevant steps have a high contrast nosing.

hasMetalGratingboolean

Do the stairs have metal grating? This is difficult to navigate for people with assistance dogs.

hasTactileSafetyStripsboolean

true if all relevant steps have tactile safety surfaces, used as warnings, implying textures detectable with the touch of a foot or sweep of a cane.

hasTactileSignageboolean

true if there is tactile navigation in this staircase, false if not.

isSpiralboolean

true if the stairs are spiral, false if not.

isWellLitboolean

Are the stairs and podests well lit?

nameLocalizedString

If there are multiple staircase, you SHOULD indicate a name for this staircase here.

stepHeightLength

Indicates how high the steps if these stairs are (can be a range).

StructuredAddress

The address of a places as Address as a series of structured attributes.

NameType
areasLocalizedString[]

An array of named areas below the district and above street. In some regions such areas might also contain street names, when individual street segments have names separate from the name of the whole road.

buildingLocalizedString

Building name

cityLocalizedString

The name of the primary locality of the place.

countryCodestring

A three-letter country code in ISO 3166-1 alpha-3, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

countyLocalizedString

A division of a state; typically a secondary-level administrative division of a country or equivalent.

districtLocalizedString

A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood.

houseLocalizedString

House or street number.

levelIndexnumber

Relative in relation to other levels. 0 for ground level must have index 0, 1 for first level, etc. You can use half numbers for levels like 1.5.

levelNameLocalizedString

Name of the level. Example: { en: "Floor 1" }, { en: "Ground level" }.

postalCodeLocalizedString

An alphanumeric string included in a postal address to facilitate mail sorting (a.k.a. post code, postcode, or ZIP code).

regionsLocalizedString[]

For address conventions where more than to levels of named areas above the city level are in use, the regions attribute provides an array with all additional area names, ordered by decreasing size (starting with the highest subdivision below state)

roomLocalizedString

Room name. Example: { en: "Meeting room ‘Rome’" }.

roomNumberLocalizedString

Room number. Example: { en: "B-101" }.

stateLocalizedString

A division of a country; typically a first-level administrative division of a country and/or a geographical region.

stateCodestring

A code/abbreviation for the state division of a country.

streetLocalizedString

Street name (in practice may also contain street number).

textLocalizedString

A displayable, formatted address as rich text.

Surface

Describes the surface of a ground or path.

NameType
lateralSlopeSlope
longitudinalSlopeSlope
smoothnessOne of the following strings:

bad excellent good horrible impassable intermediate very_bad very_good very_horrible

According to https://wiki.openstreetmap.org/wiki/Key:smoothness

turningSpaceLength

Turning space that this ground provides to people.

typesArray of one or more of these strings:

acrylic aluminium anti-slip artificial artificial_grass artificial_turf asfalto ash asphalt astroturf bamboo bare_rock bark barkchips bedrock bitumen bituminous block boardwalk boulders brick brick_weave bricks bushes carpet cement chalk chipseal cinder clay cobblestone compacted compacted_gravel composite con concrete concrete_slab concrete_slabs construction coral coral_sand crushed_limestone crushed_shells debris decoturf dirt earth enrobé fine_gravel fine_sand flagstone footway glass goudron granite grass grass_paver grass_scrub grassland grating gravel green grit ground hardcore ice ice_road interlock iron laterite lawn leaves limerock limestone linoleum loose_gravel marble marble_plate meadow metal metal_grid mixed moss mud mulch native natural none oil overgrown path paved pavement paving paving_stone paving_stones peat pebbles pebblestone plank plastic plates rasin residential rock rocks rocky roman_paving rubber rubbercrumb rubble salt sand sandstone sawdust scree scrub sealed sett shell shells shingle slabs snow soil spur steel stepping_stones stone stones synthetic tactile_paving tar tared tarmac tartan terra terre tile tiles timber track trail trees tuff turf undefined unhewn_cobblestone unpaved unpaved2 unpaved33 unpaved_minor unsealed water wood wood_chips woodchips zebra

According to https://wiki.openstreetmap.org/wiki/Key:surface

TechCombination

Describes a combination of technologies that are used together to achieve a specific goal.

The uris property is required.

NameType
descriptionLocalizedString

Localizable description of the combination. Can describe in which mode or for what goal the tech is used.

nameLocalizedString

Localizable name/title of the combination. Can describe in which mode or for what goal the tech is used.

uris*string[]

URIs of technologies that are combined together to form this tech combination. Use RDF if possible.

Supported prefix examples:

Toilet

Describes a single toilet that can be inside a restroom or cabin.

NameType
flushMechanismDistanceFromToiletLength

Indicates how far the flush mechanism(s) from the toilet, from the perspective of a the floor plan. If the flush mechanism is right behind the toilet, this is a 0 length.

grabBarsGrabBars

Object describing the grab bars.

hasAutomaticFlushboolean

true if the toilet is automatically flushing after use.

heightOfBaseLength

Indicates the height of the toilet’s base.

interactions Object with one or more of these keys:

flush secondaryFlush spray use

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isLatrineboolean

Indicates whether the toilet is a latrine.

isSquatToiletboolean

Indicates whether the toilet is a squat toilet.

isUrinalboolean

Indicates whether the toilet is a urinal.

spaceInFrontLength

How much space is in front of the toilet?

spaceOnUsersLeftSideLength

How much space is on the left side of the toilet? (from the perspective of somebody using the toilet)

spaceOnUsersRightSideLength

How much space is on the right side of the toilet? (from the perspective of somebody using the toilet)

WashBasin

Describes a wash basin.

NameType
accessibleWithWheelchairboolean

true if the wash basin is accessible with wheelchairs, false if not.

heightLength

Defines at which height is the wash basin's top

interactions Object with one or more of these keys:

changeTemperature changeWaterPressure getCarbonizedWater getColdWater getHotWater getPaperTowel getTowel sanitizeHands useAirDryer useSoap useWater useWaterJet useWaterSpray

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isLocatedInsideRestroomboolean

true if the restroom's wash basin is inside the cabin, false if not.

spaceBelowDepthLength

How deep is the space below the wash basin?

spaceBelowHeightLength

How high is the space below the wash basin?

WheelchairParking

Describes one or more wheelchair parking lots.

NameType
countnumber

Defines many wheelchair accessible parking lots are provided

distanceToEntranceLength

How far away is the parking from the main entrance? If there is a separate wheelchair entrance, the distance to this entrance MUST be used.

hasDedicatedSignageboolean

true if there is dedicated signage at all relevant turning points from the street to the parking, false if not, undefined if this is unknown.

interactions Object with one or more of these keys:

arrive enterVehicle exitVehicle park

Values must be of type InteractionMode.

An object that indicates how the object can be interacted with.

The keys of this object are the interaction types, and the values are InteractionMode objects.

isLocatedInsideboolean

true if the parking is inside a building or under a roof, false if not, undefined if unknown.

lengthLength

Length constraint of the parking lots.

locationLocalizedString

Describes where the parking is located.

maxVehicleHeightLength

Maximal allowed vehicle height for users of this parking.

neededParkingPermitsLocalizedString[]

List of permit names that allow using this parking.

widthLength

Width constraint of the parking lots.

WheelchairPlaces

The WheelchairPlaces interface describes the presence of reserved spots for wheelchairs.

The count property is required.

NameType
count*number

The number of designated places for wheelchairs, for example, in a cinema or theater.

hasSpaceForAssistantboolean

Is there additional space for an assistant?

wheelchairUserCapacitynumber

The number of people using a wheelchair that can be accomodated at the same time. Use this when there is no designated space for wheelchair users, but the number is known.

WifiAccessibility

Describes the presence of staff and their qualifications and/or provided services.

NameType
accessArray of one or more of these strings:

customers delivery designated disabled emergency employees no permissive permit private public residents yes

Describes who can access the wifi.

descriptionWhereToGetLoginDataLocalizedString

Describes where you get the login data / guest pass.

hasCaptivePortalboolean

true if the wifi has a captive portal website.

hasFixedPasswordboolean

true if the wifi has a fixed password. Knowing this password must be enough to enter and use the wifi.

isCaptivePortalAccessibleboolean

true if the wifi captive portal is accessible (WAI/ARIA).

isOpenToEveryoneboolean

true if the wifi is open to everyone, false if it is explicitly not.

isOpenToStaffboolean

true if the wifi is open to explicit place staff, false if explicitly not.

isOpenToVisitorsboolean

true if the wifi is open to explicit place visitors, false if explicitly not.

needsGuestPassboolean

true if you need a personalized guest pass / code / password to use the wifi, false if not.

passwordstring

A string with the Wifi password. Only use this attribute if security allows to publish this info online publicly.

ssidstring

A string with the Wifi name (SSID). Only use this attribute if security allows to publish this info online publicly.

usageFeeCurrencyValue[]

Describes if you need to pay a usage fee to use the wifi, or if no fee is needed.