Core Data Model¶

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 model.

Accessibility ¶

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

Name	Type
accessibleWith	PersonalProfile
ambientNoiseLevel	Volume	Ambient noise level in dB(A) relative to a reference pressure of 0.00002 Pa. Median over a 10-second period at least.
animalPolicy	AnimalPolicy	Object describing the owner's policy regarding visitors bringing animals with them.
appointmentPolicies	AppointmentPolicy[]	Describes how you can get an appointment for this place, or if you need one.
availableEquipment	`undefined` \| EquipmentProperties[]	Information about the place's equipment. Use this property for equipment that does not need to be locatable in a specific geolocation, but belongs to a place.
desks	`undefined` \| Desk[]	Describes the accessibility of desks in the place. `null` indicates there are no desks, `undefined` or missing property indicates unknown.
entrances	`undefined` \| Entrance[]	Describes the accessibility of entrances to the place.
hasAirConditioning	`boolean`	Determines if there is air conditioning installed and actively used.
hasBackgroundMusic	`boolean`	Determines if there is background music playing.
hasBrailleSignage	`boolean`	`true` if there is braille navigation for/to this place, `false` if not.
hasInductionLoop	`boolean`	`true` if the venue has induction loops installed in its functional units where this is relevant.
hasLowStimulusEnvironment	`boolean`	`true` if the venue has a designated low-stimulus room or environment, `false` if not. Can help with hypersensitivity to sensory input.
hasPatientLifter	`boolean`	`true` if the venue has a patient lifter (MedTech) installed, `false` if not..
hasSoundAbsorption	`boolean`	Determines if there is sound absorption installed.
hasTactileGuideStrips	`boolean`	`true` if the venue has tactile guide strips on the floor or at the walls, `false` if not. `undefined` or missing property indicates unknown.
hasTactileSignage	`boolean`	`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` `getDrinks` `getFood` `getService` `getTreatment` `listen` `main` `order` `orderAnnouncement` `pay` `pickUpOrder` `play` `read` `rent` `roam` `see` `sell` `use` `useLockers` `useService` `visit` `watch` `watchMovies` `watchPlays` `workHere` Values must be of type InteractionMode.	An object that indicates how the object can be interacted with, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isQuiet	`boolean`	Determines if the venue is quiet (subjectively, by the assessor). If possible, use the `ambientNoiseLevel` property instead.
isWellLit	`boolean`	Determines if the venue is well lit (subjectively, by the assessor). Will be replaced by a measurable lumen value in the future.
media	`undefined` \| Media[]	Information about media. `null` indicates there is no media, `undefined` or missing property indicates unknown.
offersActivitiesForPeopleWith	PersonalProfile
offersTreatmentWithoutLeavingWheelchair	`boolean`	`true` for healthcare providers that offer that wheelchair users do not have to leave their wheelchair for treatment, `false` if this is not possible.
parking	`undefined` \| Parking	Information about parking facilities at/around the venue. `null` indicates there is no parking, `undefined` or missing property indicates unknown.
partiallyAccessibleWith	PersonalProfile
pathways	`undefined` \| Pathways	Describes the accessibility of pathways to the place or inside the place’s boundaries (mixed)
pathwaysFromEntrance	`undefined` \| 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.
pathwaysInside	`undefined` \| Pathways	Describes the accessibility of pathways to the place or inside the place’s boundaries (mixed)
payment	`undefined` \| Payment	Information about payment at the place. `null` indicates there is no payment possible/required, `undefined` or missing property indicates unknown.
queueSystem	`undefined` \| QueueSystem	Information about the place's queue system.
restrooms	`undefined` \| Restroom[]	Describes the accessibility of restrooms that belong to the place.
rooms	`undefined` \| Room[]	Describes the accessibility of rooms that belong to the place.
serviceContact	LocalizedString
signageSystems	Signage[]	Describes local signage systems. If multiple different systems are used, describe them all.
smokingPolicy	One of the following strings: `allowedEverywhere` `dedicatedToSmoking` `inIsolatedArea` `inSeparateArea` `onlyOutside` `prohibited`	Object describing the owner's smoking policy.
staff	`undefined` \| Staff	Information about the service staff. `null` indicates there is no staff, `undefined` or missing property indicates unknown.
surface	`undefined` \| Surface	Object describing the place's ground condition. If there are very different ground conditions, you can create multiple places and nest them.
tables	`undefined` \| Desk[]	Information about tables (for example in a restaurant). `null` indicates there are no tables, `undefined` or missing property indicates unknown.
wheelchairAccessibilityGrade	One of the following strings: `fully` `not` `partially`	Describes the general wheelchair accessibility of the place. This is a human-rated value.
wheelchairPlaces	`undefined` \| WheelchairPlaces	Information about wheelchair places. `null` indicates there are no places, `undefined` or missing property indicates unknown.
wifi	WifiAccessibility	Describes the Wifi availability and accessibility at the place.

ActionMode ¶

Describes necessary abilities and modes inputting information.

Name	Type
access	Array 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?
activationForce	Force	Force needed for the described input method.
activationTimeInterval	TimeInterval	Time interval needed for activation/engagement.
apiDocumentationUrl	LocalizedString	The input API documentation URL.
attentionSpan	TimeInterval	Attention time needed for activation/engagement.
bodyHeight	Length	A supported body height.
bodyMass	Mass	A supported body weight.
brailleKeyboard	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to write textual content with a braille keyboard is supported or needed.
brailleText	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to read braille is supported or needed.
burnHazard	`boolean`	There is a burn hazard.
cable	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A cable is supported or needed.
capacitive	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The action uses a capacity sensor, for example a touch sensor.
carryWeight	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to carry a weight is supported or needed.
clap	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Clapping your hands is supported or needed.
click	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to click a button with a finger is supported or needed.
description	LocalizedString	Describes the output as human-readable text.
direction	One of the following strings: `backward` `clockwise` `counterclockwise` `down` `forward` `left` `right` `up`	The direction of the action, relative to the body.
directionAxis	One of the following strings: `axial` `coronal` `sagittal`	The direction axis of the action, relative to the body.
doubleClick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to click a button with a finger is supported or needed.
drag	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to drag an object is supported or needed.
dragAndDropGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to do a virtual drag-and-drop finger/mouse gesture is supported or needed.
educationLevel	Number	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).
eyeTracker	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use an eye tracker is supported or needed.
faceRecognition	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input uses face recognition.
feedback	PerceptionMode	How is feedback given for an input?
fingerprintScan	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input uses a fingerprint scanner.
handwriting	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to write textual content by hand is supported or needed.
haptic	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Haptic input is supported or needed.
headPointer	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a head pointer is supported or needed.
headphone	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Headphones are supported or needed.
highContrast	`boolean`	The input has high contrast elements, for example around buttons.
instructionsUrl	LocalizedString	URL describing how to use the input mechanism.
irisScan	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input uses an iris scanner.
isEasyToFind	`boolean`	`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.
isEasyToUnderstand	`boolean`	`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.
joystick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a joystick is supported or needed.
keyboard	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to write textual content by typing on a keyboard is supported or needed.
keypad	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to write numbers by typing on a keypad is supported or needed.
knob	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The action uses a knob.
knurled	`boolean`	The input has a knurled surface, for example around buttons.
languages	`string`[]	Input languages supported.
leftHanded	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	You can or must give input with your left hand.
lick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to lick an object with your tongue is supported or needed (e.g. a lollipop)
morseCode	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Morse code input is supported or needed.
mouse	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a mouse is supported or needed.
move	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to move an object is supported or needed.
name	LocalizedString	Describes which output is meant. Helpful if there are multiple outputs.
necessaryClimbHeight	Length	Height you need to be able to climb over (for obstacles)
necessaryEyeHeight	Length	How tall do you have to be to perceive the content/output/signal.
necessaryGripHeight	Length	The height you need to grip to perceive the content/output/signal.
optional	`boolean`	`true` if the action is optional, `false` if it is required.
paper	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Handling paper is supported or needed.
pedal	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a pedal is supported or needed.
photo	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input makes a photo.
pinch	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to pinch an object is supported or needed.
pinchFingerGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a pinch finger gesture is supported or needed.
press	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to apply force to an object is supported or needed.
pullSwitch	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a pull switch is supported or needed.
pullstring	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a pullstring is supported or needed.
pushButton	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a push button is supported or needed.
pushSwitch	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a push switch is supported or needed.
qrCode	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A QR code is supported or needed.
raisedText	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	`true` if the controls or signs have raised letters, `false` if not.
required	`boolean`	`false` if the action is optional, `true` if it is required.
rhythm	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use rhythm input is supported or needed.
rightHanded	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	You can or must give input with your right hand.
rotate	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to rotate an object is supported or needed.
rotateTwoFingersGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a two-finger rotation gesture is supported or needed.
scratch	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to scratch is supported or needed.
screen	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A screen is supported or needed.
signLanguage	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use sign language is supported or needed.
singleHanded	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	You can or must give input with one hand.
sipAndPuff	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a sip and puff switch is supported or needed.
smell	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to smell is supported or needed.
soundRecording	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input makes a sound recording.
speak	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to speak is supported or needed.
squeeze	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to squeeze an object is supported or needed.
stateCount	`number`	State count for a button or switch, for example 2 for a toggle button, 3 for a 3-way button.
swipeFingerGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a swipe finger gesture is supported or needed.
swipeThreeFingersGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a three-finger swipe gesture is supported or needed.
swipeTwoFingersGesture	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a three-finger swipe gesture is supported or needed.
tactile	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Tactile input is supported or needed.
tactileGuides	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input has tactile guides, for example around buttons.
tap	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to tap an element with a finger is supported or needed.
tearApart	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to tear something apart is supported or needed.
techSufficient	TechCombination[]	Technology combinations that are sufficient to make use of the output.
techSupported	TechCombination[]	Technologies that are sufficient to make use of the output.
tilt	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to tilt an object is supported or needed.
tongue	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to move an object with your tongue is supported or needed.
touch	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Touch input is supported or needed.
touchscreen	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Touchscreen input is supported or needed.
trackball	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to use a trackball is supported or needed.
tripleClick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to click a button with a finger is supported or needed.
turn	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to turn an object is supported or needed.
turnKnob	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to turn a knob is supported or needed.
twoHanded	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	You can or must give input with both hands.
url	LocalizedString	URL where you can use the input mechanism, e.g. on your phone.
video	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input makes a video.
visualRecognition	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	`true` if the input user interface needs or supports visual input, `false` if not.
voiceActivation	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	`true` if the control is activated by voice, `false` if not.
walk	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Walking is supported or needed.
wave	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Waving your hands is supported or needed.
weight	Mass	A weight you need to be able to lift.
wheel	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input features a wheel.
wireless	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The input is wireless.

AnimalPolicy ¶

Name	Type
allowsAssistanceDogs	`boolean`	`true` if the place allows visitors to bring assistance dogs, `false` if bringing them is explicitly prohibited, `undefined` if the policy is unknown.
allowsDogs	`boolean`	`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.
allowsGuideDogs	`boolean`	`true` if the place allows visitors to bring guide dogs, `false` if bringing them is explicitly prohibited, `undefined` if the policy is unknown.
allowsServiceAnimals	`boolean`	`true` if the place allows bringing any kind of animal, `false` or `undefined` if not or if there are exceptions.
dogsNeedMuzzle	`boolean`	`true` if the place denies entry to visitors bringing a dogs without muzzles, `false` if dogs without muzzles are explicitly allowed.
suppliesWaterForPets	`boolean`	`true` if the place supplies water for accompanying animals, `false` if explicitly not, or `undefined` if unknown.

AppointmentPolicy ¶

Mixin to link InteractionMode objects to your model.

Name	Type
access	Array of one or more of these strings: `customers` `delivery` `designated` `disabled` `emergency` `employees` `no` `permissive` `permit` `private` `public` `residents` `yes`	Who can make this kind of appointment.
allowsWalkIn	`boolean`	`true` if you need no appointment to visit the place.
bookingURL	`string`	The URL to a page where the appointment can be booked.
description	LocalizedString	Describes this policy as text string, e.g. ‘home visits possible if you are over 60’. Use the other fields only if the described place has only one typical policy (like at a hairdresser).
equipmentProperties	EquipmentProperties	If the appointment needs a specific equipment, it is described here.
fees	CurrencyValue[]	The amount of money that is charged for the appointment.
homeVisit	`boolean`	`true` if the appointment can be at the person’s home.
inPersonOnSite	`boolean`	`true` if the appointment can be made in person.
interactions	Object with one or more of these keys: `arrive` `book` `buy` `change` `checkIn` `checkOut` `eat` `explore` `getDrinks` `getFood` `getService` `getTreatment` `listen` `main` `order` `orderAnnouncement` `pay` `pickUpOrder` `play` `read` `rent` `roam` `see` `sell` `use` `useLockers` `useService` `visit` `watch` `watchMovies` `watchPlays` `workHere` Values must be of type InteractionMode.	An object that indicates how the object can be interacted with, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
languages	`string`[]	The languages that are spoken by the person who is responsible for the appointment.
limitationsDescription	LocalizedString	Describes limitations that apply to this policy, e.g. ‘only for people with a disability’.
needsAppointmentForAssistant	`boolean`	`true` if appointments with an assistant are possible, but need to be booked separately.
openingHours	`string`	Opening hours in the format described at https://wiki.openstreetmap.org/wiki/Key:opening_hours.
paymentTypes	Payment[]	The payment method that is used to pay the amount of money. Use `fees` instead, if possible.
phoneCall	`boolean`	`true` if the appointment can be made by video call.
seat	Seat	If a seat is associated with this appointment, it is described here.
seatCount	`number`	How many seats are available for this appointment.
videoCall	`boolean`	`true` if the appointment can be made by video call.

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.

Name	Type
access	Array 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.
currency	`string`	The currency in which the amount is specified, as three-letter acronym. Can be undefined if the amount is zero.
paymentTypes	Payment[]	The payment method that is used to pay the amount of money.
per	Quantity	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.

Name	Type
depthBelow	Length	How much space is there under the desk? This can be used to determine if a wheelchair user can sit at the desk.
fixedHeight	Length	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.
fixedHeightBelow	Length	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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
intercom	`undefined` \| Intercom	Information about an intercom at this desk, if applicable. `null` indicates there is no intercom.
isRollUnder	`boolean`	`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.
maximalHeight	Length	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.
minimalHeight	Length	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.
name	LocalizedString	Name of the entrance (helpful if there are multiple entrances).
payment	`undefined` \| Payment	Information about payment at this desk. `null` indicates there is no payment possible/required.
queueSystem	QueueSystem	Describes an associated queue system.
turningSpaceInFront	Length	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.
widthBelow	Length	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)

Name	Type
access	Array 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.
colors	`string`[]	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.
doorFrameColors	`string`[]	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.
doorOpensToOutside	`boolean`	`true` if the door opens to the outside, `false` if it opens to the inside.
doorbellTopButtonHeight	Length	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.
grabBars	GrabBars	Describes grab bars in front of the door.
hasClearMarkingOnGlassDoor	`boolean`	`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.
hasErgonomicDoorHandle	`boolean`	`true` if the door's handle is easy to use (subjectively by the assessor), `false` if not.
hasIntercom	`boolean`	`true` if the door has an intercom system, `false` if not.
hasProximitySensor	`boolean`	`true` if the door has a proximity sensor that triggers the opening mechanism, `false` if not.
hasSwitch	`boolean`	`true` if the door has a switch that triggers the opening mechanism, `false` if not.
hasVisuallyContrastedFrame	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
intercom	Intercom	Describes the intercom system of the door.
isAlwaysOpen	`boolean`	`true` if the door is there, but always open, `false` if not.
isAutomatic	`boolean`	`true` if the door opens automatically, `false` if not. The mechanism for opening the door is defined in other attributes.
isAutomaticOrAlwaysOpen	`boolean`	`true` if the door is always open or automatic, `false` if it has to be opened manually.
isEasyToHoldOpen	`boolean`	`true` if the door is easy to hold open (subjectively by the assessor), `false` if not.
isGlassDoor	`boolean`	`true` if the door is a glass door, `false` if not.
isRevolving	`boolean`	`true` if the door is revolving (like a carousel), `false` if not.
isSliding	`boolean`	`true` if the door is a sliding door, `false` if not.
isTurnstile	`boolean`	`true` if the door is a turnstile, `false` if not.
isVisuallyContrasted	`boolean`	`true` if the door is visually contrasted to its surrounding wall, `false` if not.
markingColors	`string`[]	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.
nearbyWallColors	`string`[]	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.
needsDoorbell	`boolean`	`true` if you need to ring a doorbell to pass the entrance, `false` if not.
needsEuroKey	`boolean`	`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.
needsIntercom	`boolean`	`true` if you need to use the intercom to pass this door, `false` if not.
needsKeyCard	`boolean`	`true` if you need to use a keycard to pass the entrance, `false` if not.
needsKeyPad	`boolean`	`true` if you need to use a key pad to pass this door, `false` if not.
needsRadarKey	`boolean`	`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.
needsSwitchToOpen	`boolean`	`true` if the door needs pressing a switch to open, `false` if not.
thresholdHeight	Length	Height of the door’s threshold / sill / step inside the door frame.
thresholdIsRounded	`boolean`	`true` if the threshold has rounded edges, `false` if not.
turningSpaceInFront	Length	Turning space in front of the door.
width	Length	Width of the door.

Entrance ¶

Describes an entrance to a PlaceInfo.

Name	Type
geometry	PointGeometry	The physical location of the entrance in WGS84 coordinates. Currently only a GeoJSON `PointGeometry` is supported.
properties	EntranceProperties

EntranceProperties ¶

Describes an entrance to a place.

Name	Type
door	`undefined` \| Door	Object that describes the entrance’s door. `null` if there is no door.
elevatorEquipmentId	`string`	reference to the equipment id if this entrance is an elevator (on accessibility.cloud)
hasFixedRamp	`boolean`	`true` if this entrance has a fixed ramp, `false` if not.
hasHoist	`boolean`	`true` if there is a hoist / wheelchair lift, `false` if not.
hasRemovableRamp	`boolean`	`true` if there is a removable ramp, `false` if not. If there is a fixed ramp, this property MUST be `undefined`.
hasSignage	`boolean`	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?
intercomEquipmentId	`string`	reference to the equipment id of the intercom of this entrance (on accessibility.cloud)
isLevel	`boolean`	`true` if this entrance has no steps and needs no ramp, `false` if there are steps or a ramp.
isMainEntrance	`boolean`	`true` if this is the main entrance, `false` if not.
name	LocalizedString	Name of the entrance (helpful if there are multiple entrances).
needsAppointment	`boolean`	`true` if you need an appointment to enter, `false` if not.
placeInfoId	`string`	reference to the place that this entrance is connected to (on accessibility.cloud)
slopeAngle	Slope	How steep is the ground at the entrance?
stairs	Stairs	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.

Name	Type
geometry	PointGeometry	The physical location of the place in WGS84 coordinates. Currently only a GeoJSON `PointGeometry` is supported.
properties	EquipmentProperties

EquipmentProperties ¶

Mixin to link InteractionMode objects to your model.

Name	Type
accessMode	`string`[]	Access modes supported by this equipment.
accessModeSufficient	`string`[]	Access mode combinations that allow understanding and using the equipment.
accessibilityControl	`string`[]	The accessibility controls that allow controlling this equipment.
accessibilityFeature	`string`[]	Indicates features that allow understanding or using the equipment.
accessibilityHazard	`string`[]	Indicates hazards that may be an obstacle to understanding or using the equipment.
alternativeRouteInstructions	LocalizedString	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.
cabinLength	Length	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.
cabinWidth	Length	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.
category	One of the following strings: `bed` `bodyScanner` `ctScanner` `elevator` `escalator` `flushMechanism` `hoist` `intercom` `luggageScanner` `movingWalkway` `mriScanner` `powerOutlet` `ramp` `sitemap` `stairLift` `switch` `ticketVendingMachine` `treatmentChair` `ultrasoundScanner` `vendingMachine` `wardrobe` `wheelchairLift` `xrayMachine`	Type of the equipment or facility.
description	LocalizedString	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.
disruptionSourceImportId	`string`	Data source ID of a secondary source used for realtime status info on accessibility.cloud
door	Door	Object describing the door to the equipment, or `undefined` if there is no door.
emergencyIntercom	Intercom	Describes the intercom system for emergency calls.
hasAdjustableHeight	`boolean`	`true` if the equipment's height is adjustable, `false` if not.
hasDoorsAtRightAngles	`boolean`	`true` if the equipment has doors at right angles to each other.
hasDoorsInBothDirections	`boolean`	`true` if the equipment has doors in two directions, so wheelchair, rollator, bike or pushchair users do not have to move backwards to exit.
hasExternalFloorSelection	`boolean`	For elevators. `true` if the elevator needs a command to be entered outside the elevator, `false` if not.
hasLandings	`boolean`	`true` if the equipment has a landing platform, `false` if not. Helpful for escalators.
hasMirror	`boolean`	For elevators. `true` if the elevator has a mirror, `false` if not.
hasVisualEmergencyAlarm	`boolean`	`true` if the equipment has a visual emergency alarm, `false` if not (for example, inside elevators).
heightOfControls	Length	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` `getTreatment` `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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isAccessibleWithWheelchair	`boolean`	`true` if the equipment is fully operatable for/by a person in a wheelchair, `false` if not. If you can, please don't use this attribute. Instead, use more specific attributes.
isIndoors	`boolean`	`true` if the equipment is indoors, `false` if it’s fully or partially outdoors.
isSuitableForBicycles	`boolean`	For elevators. `true` if the elevator can carry a bicycle, `false` if not.
isWorking	`boolean`	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.
languages	`string`[]	Languages of the equipment’s visible controls and/or voice output.
longDescription	LocalizedString	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.
manufacturerName	LocalizedString	Official name of the company that manufactured the equipment.
manufacturerSerialNumber	`string`	Manufacturer serial number of the equipment / facility. Intentionally not localizable to allow matching with other data, e.g. from manufacturer's own APIs.
originalData	`string`	Original source data for this equipment (for easier debugging)
originalId	`string`	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.
originalPlaceInfoId	`string`	ID of the place that this equipment belongs to (unique in the original data source)
outOfOrderReason	LocalizedString	Live status update. Reason why the equipment is not in operation. MUST be `undefined` if the equipment is in operation.
placeInfoId	`string`	Place info ID that this equipment belongs to (accessibility.cloud ID)
placeSourceId	`string`	ID of the place data source that this equipment belongs to (accessibility.cloud ID)
plannedCompletionDate	Date	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.
sameAs	`string`[]	URLs of this equipment in external data sources, for example in GTFS, IMDF or other sources.
seat	Seat	Object describing the seat of the equipment, or `undefined` if there is no seat.
servicePhoneNumber	`string`	Phone number where a service operator can be reached for help using this facility.
serviceWebsiteUrl	`string`	URL pointing to a website that describes the equipnent or it's current operational status.
shortDescription	LocalizedString	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’).
sourceId	`string`	Data source ID on accessibility.cloud
sourceImportId	`string`	Data import ID on accessibility.cloud
stateExplanation	LocalizedString	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.)
stateLastUpdate	Date	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.

Name	Type
continuous*	`boolean`	Indicates if the grab bars are continuous or not. Helpful for stair grab rails.
distanceBetweenBars	Length	Indicates how far the bars are apart.
foldable	`boolean`	`true` if the grab bars can be folded, `false` if not..
inFrontOfTheUser	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
onUsersLeftSide	`boolean`	`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
onUsersRightSide	`boolean`	`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
topHeightFromFloor	Length	Indicates how high the grab bars are (top edge, measured from the floor).

Interactable ¶

Mixin to link InteractionMode objects to your model.

Name

Type

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, or how you can engange in the main function of a place or thing.

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

Many people with disabilities face barriers when interacting with places or things. These stem from the physical environment, the design of the object, or the way the interaction with the object or place is designed.

The Interactable model allows to describe how you can interact with a thing or engange in the key purposes of a place, and which abilities you need for this.

Attributes typically contain

barriers
means of interaction
required and optional abilities, experiences, or senses

This allows for UIs that adapt to the user's needs and abilities, or to provide usage descriptions that work for everyone.

Name	Type
action	ActionMode	Action modes that are absolutely necessary to facilitate the interaction, e.g. ‘pushing a button’.
description	LocalizedString	Describes the output as human-readable text.
languages	`string`[]	Input languages supported.
name	LocalizedString	Describes which output is meant. Helpful if there are multiple outputs.
optional	`boolean`	`true` if the interaction is optional, `false` if it is required.
perception	PerceptionMode	Perception modes supported to facilitate the interaction.
required	`boolean`	`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.

Name	Type
ambientNoiseLevel	Volume	The ambient noise level when using the intercom.
audioIsComprehensible	`boolean`	`true` if intercom system’s audio quality is good enough for understanding speech, `false` if not.
description	LocalizedString
hasAudio	`boolean`	`true` if the door has an audio intercom system, `false` if not.
hasVideoCamera	`boolean`	`true` if the door has a video intercom system, `false` if not.
hasVisualFeedbackOnConnection	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
necessaryGripHeight	Length	The height of the top control element of the intercom system.
needsKeyPad	`boolean`	`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.

Name	Type
accessMode	`string`[]	Access modes supported by this equipment.
accessModeSufficient	`string`[]	Access mode combinations that allow understanding and using the equipment.
accessibilityControl	`string`[]	The accessibility controls that allow controlling this equipment.
accessibilityFeature	`string`[]	Indicates the access mode combinations that allow understanding and using the equipment.
accessibilityHazard	`string`[]	Indicates the access mode combinations that allow understanding and using the equipment.
hasAudioDescription	`boolean`	Is the media unit provided with audio description?
hasContrastingBackground	`boolean`	If the media unit is printed or on a screen, does it have high contrast between background and foreground?
hasDedicatedScreenForSubtitles	`boolean`	Relevant for movies, screens and presentations: Is there a dedicated screen where subtitles can be read?
hasPlainLanguageOption	`boolean`	Is the media unit provided in a Plain Language option?
hasRealTimeCaptioning	`boolean`	Does the media unit have real time captioning?
hasSubtitles	`boolean`	Is the media unit provided with subtitles?
interactions	Object with one or more of these keys: `browse` `close` `discover` `feel` `interact` `listen` `open` `read` `recognize` `rent` `watch` Values must be of type InteractionMode.	An object that indicates how the object can be interacted with, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isAudio	`boolean`	Is the media unit consumable as audio-only option?
isBraille	`boolean`	Is the media unit consumable or described for Braille readers?
isLargePrint	`boolean`	If the media unit is printed, is the print large?
isTactile	`boolean`	Is the media tactile?
languages	`string`[]	Specifies which languages (including sign languages) in which the media unit is provided
name	LocalizedString	Name of the media unit (relevant if there are multiple units of the same kind)
sameAs	`string`[]	URLs that contain the media. Use this to link data, for example with RDF.
turningSpaceInFront	Length	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.
type	One of the following strings: `document` `exhibit` `form` `guide` `menu` `movie` `play` `presentation` `screen` `tour` `website`	Type of the media unit

Mirror ¶

Describes a mirror.

heightFromGround and isAccessibleWhileSeated properties are required.

Name	Type
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, or how you can engange in the main function of a place or thing. 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.
isLocatedInsideRestroom	`boolean`	`true` if the mirror is located inside the restroom, `false` if not.

Parking ¶

Mixin to link InteractionMode objects to your model.

Name Type

count number

forWheelchairUsers undefined | 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, or how you can engange in the main function of a place or thing.

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

Pathways ¶

Describes one or multiple pathways inside a place.

Name	Type
isKerbstoneFree	`boolean`	`true` if the pathway is kerbstone-free, `false` if not.
surface	Surface
width	Length	Width constraints of all pathways inside a place relevant for consumers.
widthAtObstacles	Length	Width constraints of all pathways inside a place relevant for consumers.

Payment ¶

The Payment interface describes the payment options at a location.

Name	Type
acceptsBills	`boolean`
acceptsCoins	`boolean`
acceptsCreditCards	`boolean`
acceptsDebitCards	`boolean`
acceptsPaymentByMobilePhone	`boolean`
customPaymentMetaInfo	LocalizedString[]
hasPortablePaymentSystem	`boolean`

PerceptionMode ¶

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

Name	Type
acceleration	Acceleration	Feedback force applied to the user.
activationSignal	`boolean`	The output is an activation/engagement signal.
ambientNoiseLevel	Volume	Ambient noise level in dB(A) relative to a reference pressure of 0.00002 Pa. Median over a 10-second period at least.
ambientTemperature	Temperature	The ambient temperature around the output.
animation	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is animated.
apiDocumentationUrl	`string`	The input API documentation URL.
attentionSpan	TimeInterval	Attention time span needed to understand the output.
audibleClick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has an acoustic click feedback.
audioDescription	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has audio description.
audioIsComprehensible	`boolean`	`true` if the system’s audio quality is good enough for understanding speech, `false` if it is difficult.
backgroundColors	`string`[]	Background output HTML colors (for example, the background behind a text or icon).
backgroundMusic	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	There is background music playing.
beep	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses one or more beeps as signal.
bing	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses one or more bing-like signals.
blackAndWhite	`boolean`	The output uses black and white colors.
braille	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to read braille is supported or needed.
breathing	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The light looks like it is breathing.
brightness	Brightness	The output's brightness.
buzzer	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is using a buzzer / paging device.
byod	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	`true` if you can or have to perceive the content with a device that you own.
cable	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A cable is supported or needed.
chart	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses one or more charts.
colorCode	`boolean`	The output uses a discrete color code.
colorGradient	`boolean`	The output uses a color gradient.
contentWarning	LocalizedString	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.
dedicatedScreenForSubtitles	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has a dedicated screen for subtitles.
description	LocalizedString	Describes the content/output/signal as human-readable text.
duration	TimeInterval	Time interval in which the output is active.
educationLevel	Number	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).
flash	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is a flashing light.
flashingHazard	`boolean`	`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.
fontSize	Length	Font size used in the output.
force	Force	Feedback force applied to the user.
forceFeedback	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The content/output/signal has active force feedback.
foregroundColors	`string`[]	Foreground output HTML colors (for example, the text or icon color).
framerate	Hertz	The framerate of animations.
frequency	Hertz	The frequency of the output, for tones or flashes.
fullBody	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The content/output/signal affects your full body.
handwritten	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The content is handwritten.
haptic	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is haptic.
hapticClick	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has a haptic click feedback.
headphone	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Headphones are supported or needed.
heat	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Heat perception is supported or needed.
highContrast	`boolean`	The output is displayed in high contrast.
instructionsUrl	LocalizedString	URL describing how to make use of the content/output/signal.
isEasyToFind	`boolean`	`true` if the input is easy to find.
isEasyToUnderstand	`boolean`	`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.
languages	`string`[]	Content languages supported.
led	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is an LED.
light	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is a light.
morse	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses morse code.
music	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses music.
name	LocalizedString	Describes which output is meant. Helpful if there are multiple signals/outputs/content lements.
necessaryEyeHeight	Length	How tall do you have to be to perceive the content/output/signal.
necessaryGripHeight	Length	The height you need to grip to perceive the content/output/signal.
needsHighConcentration	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output needs high concentration to understand.
numbers	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses one or more numbers.
optional	`boolean`	`true` if the perception is optional, `false` if it is required.
paper	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is displayed on a paper.
pictograms	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses one or more pictograms.
pitchedTone	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output uses a pitched tone as signal.
plainLanguageOption	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has a plain language option.
printer	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is from a printer.
provisionalHearingAid	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The perceiving person uses a provisional hearing aid, e.g. a stethoscope, a smartphone, or a headset with a microphone that amplifies the sound or speech.
qrCode	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A QR code is supported or needed.
radio	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	A radio connection is supported or needed (e.g. WiFi, Bluetooth, NFC, etc.)
read	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to read is supported or needed.
realTimeCaptioning	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has realtime captioning.
required	`boolean`	`false` if the perception is required to make use of the main function of the described object, `true` if it is required.
rhythmic	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is rhythmic.
screen	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is displayed on a screen.
signLanguage	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to understand sign language is supported or needed.
smell	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to smell is supported or needed.
sound	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is acoustic.
soundVolume	Volume	The content/output/signal has active vibration feedback.
speech	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The ability to understand speech is supported or needed.
static	`boolean`	`true` if the output is usually static and does not change over time, `false` if it is dynamic and changes over time.
stethoscope	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The perceiving person uses a stethoscope. This is method for patient communication that is used by doctors to speak to patients with hearing impairments: British doctors recommend using the stethoscope as a hearing aid for patients in such situations (BMJ 2010; 341: c4672). If the patient has the buttons in his ear and the physician speaks softly and clearly into the diaphragm as into a microphone, then sufficient communication is often possible despite hearing problems. The intimacy of the conversation can be preserved by this simple means. Sources: Ärztezeitung BMJ 2010;341:c4672
subtitles	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has subtitles.
tactile	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output is tactile.
tactileGuides	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The output has tactile guides, for example around buttons.
taste	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	Tasting something is supported or needed.
techSufficient	TechCombination[]	Technology combinations that are sufficient to make use of the content/output/signal.
techSupported	TechCombination[]	Technologies that are sufficient to make use of the content/output/signal.
temperature	Temperature	The temperature of the output.
urgency	One of the following strings: `alarm` `alert` `announcement` `debug` `info` `warning`	Urgency of the content when perceived.
url	LocalizedString	URL where you can see or make use of the content/output/signal, e.g. on your phone.
vibration	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	The content/output/signal has active vibration feedback.
visual	One of the following strings: `always` `discouraged` `forbidden` `impossible` `notApplicable` `notAvailable` `notNecessary` `optional` `possible` `recommended` `required` `sometimes` `unknown` `usually`	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.

Name	Type
blindness	`boolean`	`true` for a person that is blind.
guideDog	`boolean`	`true` for a person that has a guide dog.
hearingImpairment	`boolean`	`true` for a person that has a hearing impairment.
learningImpairment	`boolean`	`true` for a person that has a learning impairment.
mobilityImpairment	`boolean`	`true` for a person that has a mobility impairment.
muteness	`boolean`	`true` for a person that is inable to speak.
visualImpairment	`boolean`	`true` for a person that has a visual impairment.
wheelchair	`boolean`	`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.

Name	Type
formatVersion	`string`	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.

Name	Type
access	Array 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.
accessibility	`undefined` \| Accessibility	The accessibility of this place. `null` indicates that this place has no data, `undefined` or missing property indicates unknown.
address	`undefined` \| 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
description	LocalizedString	Text description containing helpful information for people with disabilities.
editPageUrl	`string`	URL of the original data source’s website on a subpage that allows to edit the original data.
emailAddress	`string`	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.
infoPageUrl	`string`	URL of the original data source’s website describing this place.
name	LocalizedString	The official name of this place.
originalData	`any`	Original source data for this equipment (for easier debugging)
originalId	`string`	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.
originalParentPlaceInfoId	`string`	The parent's place ID in the original dataset from the data provider.
parentPlaceInfoId	`string`	ID of the parent place that this place belongs to.
parentPlaceSourceId	`string`	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.
phoneNumber	`string`	Phone number to call a representant of the place's operator.
placeWebsiteUrl	`string`	URL of the place’s own website.
sameAs	`string`[]	URLs of this equipment in external data sources, for example in GTFS, IMDF or other sources.
sourceId	`string`	ID of the data source that provided the place (accessibility.cloud ID)
sourceImportId	`string`	ID of the import that created this place (accessibility.cloud ID)
tags	Object with one or more of these keys: `string` Values must be of type `string`.	Tags that are not part of the schema, but are still useful for the data consumer. If a OSM place is described, the tags are the OSM tags. If a GTFS place is described, the tags are the GTFS fields. If a IMDF place is described, the tags are the IMDF fields. If a custom place is described, the tags are the custom fields. If a place is described by a combination of multiple sources, the tags are the union of all fields.

PointGeometry ¶

GeoJSON Point object.

coordinates and type properties are required.

Name	Type
coordinates*	tuple with 2 `number` elements
type*	`"Point"`

Quantity ¶

Describes a quantity of a unit type.

Name	Type
accuracy	`number`	± in given units, uniform error.
max	`number`	maximal value (inclusive)
min	`number`	minimal value (inclusive)
operator	One of the following strings: `!=` `<` `<=` `=` `==` `>` `>=` `~` `~=`	the operator, indicating the value is not an absolute value
precision	`number`	± in given units, uniform error
rawValue	`string`	raw, imported value, eg. '90 .. 120cm' - only required when importing
unit	`string`	one of the length units in js-quantities
value	`number`	the value in the specified unit

QueueSystem ¶

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

Name	Type
canSkipQueueWithDisability	`boolean`	`true` if you can skip the queue with a disability, `false` if not.
grabBars	GrabBars	Grab bars inside the queueing system, if applicable.
hasVisualAnnouncements	`boolean`	`true` if the queueing system announces the next person in line visually, `false` if not.
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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
needsTickets	`boolean`	`true` if the queueing uses tickets (usually numbered), `false` if not.
numberOfQueueServerPoints	`number`	Number of queue server points.
numberOfSeats	`number`	Number of seats that can be used by people while waiting in the queue.
usesCattleBars	`boolean`	`true` if the queueing uses rails / cattle bars, `false` if not.

Restroom ¶

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

Name	Type
access	Array of one or more of these strings: `customers` `delivery` `designated` `disabled` `emergency` `employees` `no` `permissive` `permit` `private` `public` `residents` `yes`	Defines who this room is for. See https://wiki.openstreetmap.org/wiki/Key:access for more information.
address	StructuredAddress
description	LocalizedString
entrance	EntranceProperties	Object describing the entrance to this room.
entrances	Entrance[]	Object describing the entrance to this room.
hasBathTub	`boolean`	`true` if there is a bath tub in this room, `false` if not, `undefined` if condition is unknown.
hasCeilingHoist	`boolean`	`true` if the restroom has a ceiling hoist, `false` if not.
hasChangingTableForAdults	`boolean`	`true` if the restroom has a changing table for adults, `false` if not.
hasChangingTableForBabies	`boolean`	`true` if the restroom has a changing table for babies, `false` if not.
hasEmergencyPullstring	`boolean`	`true` if the restroom has an emergency pull string, `false` if not.
hasMirror	`boolean`	`true` if the restroom has a mirror, `false` if not.
hasShower	`boolean`	`true` if the restroom has a shower, `false` if not.
hasSupportRails	`boolean`	`true` if there support rails on the walls
heightOfDrier	Length	At which height from the floor is the drier or towel?
heightOfSoap	Length	At which height from the floor is the soap?
interactions	Object with one or more of these keys: `callEmergency` `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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isAccessibleWithWheelchair	`boolean`	`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.
mirror	Mirror	Describes a mirror, if existing.
sameAs	`string`[]
shower	Shower	Object describing a shower inside this restroom, if existing.
signIcons	Array of one or more of these strings: `allGender` `baby` `changingTable` `family` `female` `male` `personInWheelchair` `toiletBowl` `urinal` `washBasin`	Visible icons on the restroom’s sign
toilet	Toilet	Object describing a toilet inside the restroom, if existing.
turningSpaceInside	Length	How wide is the space inside that you can use for turning?
usageFee	CurrencyValue[]	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.
washBasin	WashBasin	Object describing a wash basin belonging to this restroom. It can be outside of the restroom.

Room ¶

Describes a room inside a structure.

Name	Type
access	Array of one or more of these strings: `customers` `delivery` `designated` `disabled` `emergency` `employees` `no` `permissive` `permit` `private` `public` `residents` `yes`	Defines who this room is for. See https://wiki.openstreetmap.org/wiki/Key:access for more information.
address	StructuredAddress
description	LocalizedString
entrance	EntranceProperties	Object describing the entrance to this room.
entrances	Entrance[]	Object describing the entrance to this room.
hasSupportRails	`boolean`	`true` if there support rails on the walls
interactions	Object with one or more of these keys: `callEmergency` `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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isAccessibleWithWheelchair	`boolean`	`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.
sameAs	`string`[]
turningSpaceInside	Length	How wide is the space inside that you can use for turning?

Seat ¶

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

Name	Type
adjustmentAxes	Array of one or more of these strings: `axial` `coronal` `sagittal`	The seat can be adjusted in the following axes.
adjustmentDirections	Array of one or more of these strings: `backward` `clockwise` `counterclockwise` `down` `forward` `left` `right` `up`	The seat can be adjusted in the following directions.
columns	`number`[]	The seat column numbers. This is only for seats in a fixed seating arrangement.
description	LocalizedString	Name of the entrance (helpful if there are multiple entrances).
fixedHeight	Length	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.
hasAdjustableHeight	`boolean`	The seat has an adjustable seating surface.
hasHeadRest	`boolean`	The seat has a headrest.
hasRemovableArmRests	`boolean`	The seat has removable armrests.
hasSeatbelt	`boolean`	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` `removeArmrests` `sit` `unfold` Values must be of type InteractionMode.	An object that indicates how the object can be interacted with, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
intercom	`undefined` \| Intercom	Information about an intercom at this seat, if applicable. `null` indicates there is no intercom.
isCenterColumn	`boolean`	The seat is located at the center of the seating arrangement, laterally.
isFixed	`boolean`	The seat is fixed.
isFoldable	`boolean`	The seat can be folded.
isFrontRow	`boolean`	The seat is located at the front row of the seating arrangement.
isLastRow	`boolean`	The seat is located at the last row of the seating arrangement.
isMobile	`boolean`	The seat is mobile.
isWheelchairAccessible	`boolean`	The seat is wheelchair accessible.
maximalHeight	Length	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.
minimalHeight	Length	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.
name	LocalizedString	Name of the entrance (helpful if there are multiple entrances).
payment	`undefined` \| Payment	Information about payment at this seat or the cost of using this seat. `null` indicates there is no payment possible/required.
reservedForPersonsWith	PersonalProfile	The seat is reserved for persons with the given profile.
rows	`number`[]	The seat row numbers. This is only for seats in a fixed seating arrangement.
seatbeltPoints	`number`	The number of seatbelt points.
turningSpaceInFront	Length	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.

Name	Type
door	Door
grabBars	GrabBars	Ergonomic handles inside the shower.
hasShowerSeat	`boolean`	`true` if the shower has a seat, `false` if not..
hasSupportRails	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
seat	Seat	Describes the shower seat, if existing.
stairs	Stairs

Signage ¶

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

Name	Type
description	LocalizedString	A description of the signage.
fontHeight	Length	The height of the font used on the signage. Most likely in millimeters, using a range.
hasAudio	`boolean`	`true` if the signage has audio, `false` if not.
hasBraille	`boolean`	`true` if the signage has braille, `false` if not.
hasNumbers	`boolean`	`true` if the signage uses a numbering scheme, `false` if not, `undefined` if condition is unknown.
hasPictograms	`boolean`	`true` if the signage has pictograms, `false` if not.
hasRaisedLetters	`boolean`	`true` if the signage has raised letters, `false` if not.
hasSearch	`boolean`	`true` if the signage has a search function, `false` if not, `undefined` if condition is unknown.
hasTactileGuideStrips	`boolean`	`true` if the signage has tactile guide strips, `false` if not, `undefined` if condition is nknown.
hasTactileHandRails	`boolean`	`true` if the signage has tactile hand rails, `false` if not, `undefined` if condition is unknown.
hasTactileMap	`boolean`	`true` if the signage has a tactile map, `false` if not.
hasTactileNorthMarkers	`boolean`	`true` if the signage has tactile north markers, `false` if not, `undefined` if condition is unknown. https://twitter.com/saizai/status/1210352258950598656
hasTactilePaving	`boolean`	`true` if the signage has tactile paving, `false` if not.
hasTactileRoomNames	`boolean`	`true` if the signage has tactile room names, `false` if not, `undefined` if condition is unknown.
hasText	`boolean`	`true` if the signage has text features, `false` if not.
hasVideo	`boolean`	`true` if the signage has video, `false` if not.
hasVirtualMap	`boolean`	`true` if the signage has a virtual map, `false` if not.
highLegibility	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isHighContrast	`boolean`	`true` if the signage has high contrast, `false` if not.

Staff ¶

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

Name	Type
canSeeVisitorsFromInside	`boolean`	`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.
hasFreeAssistantForVisitors	`boolean`	`true` if there is an assistant for the duration of the visit that is free of charge, `false` if not.
languages	`string`[]	Languages that the staff speaks, including sign language variants. Uses IETF language codes.
spokenLanguages	`string`[]

Stairs ¶

The Stairs interface describes one or more walkable stairs.

Name	Type
alternativeMobileEquipmentIds	`string`[]	You SHOULD reference alternative equipment IDs with this field, for example elevators, escalators, or hoists.
count	`number`	Number of steps.
floors	`string`[]	Floor numbers that are accessible via these stairs.
grabBars	GrabBars	Grab bars belonging to the stairs.
hasAntiSlipNosing	`boolean`	`true` if all relevant steps are made with anti-slip material.
hasBrailleSignage	`boolean`	`true` if there is braille navigation in this staircase, `false` if not.
hasHandRail	`boolean`	`true` if there is a handrail covering all relevant steps, `false` if not.
hasHighContrastNosing	`boolean`	`true` if all relevant steps have a high contrast nosing.
hasMetalGrating	`boolean`	Do the stairs have metal grating? This is difficult to navigate for people with assistance dogs.
hasTactileSafetyStrips	`boolean`	`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.
hasTactileSignage	`boolean`	`true` if there is tactile navigation in this staircase, `false` if not.
isSpiral	`boolean`	`true` if the stairs are spiral, `false` if not.
isWellLit	`boolean`	Are the stairs and podests well lit?
name	LocalizedString	If there are multiple staircase, you SHOULD indicate a name for this staircase here.
stepHeight	Length	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.

Name	Type
areas	LocalizedString[]	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.
building	LocalizedString	Building name
city	LocalizedString	The name of the primary locality of the place.
countryCode	`string`	A three-letter country code in ISO 3166-1 alpha-3, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
county	LocalizedString	A division of a state; typically a secondary-level administrative division of a country or equivalent.
district	LocalizedString	A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood.
house	LocalizedString	House or street number.
levelIndex	`number`	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`.
levelName	LocalizedString	Name of the level. Example: `{ en: "Floor 1" }`, `{ en: "Ground level" }`.
postalCode	LocalizedString	An alphanumeric string included in a postal address to facilitate mail sorting (a.k.a. post code, postcode, or ZIP code).
regions	LocalizedString[]	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)
room	LocalizedString	Room name. Example: `{ en: "Meeting room ‘Rome’" }`.
roomNumber	LocalizedString	Room number. Example: `{ en: "B-101" }`.
state	LocalizedString	A division of a country; typically a first-level administrative division of a country and/or a geographical region.
stateCode	`string`	A code/abbreviation for the state division of a country.
street	LocalizedString	Street name (in practice may also contain street number).
text	LocalizedString	A displayable, formatted address as rich text.

Surface ¶

Describes the surface of a ground or path.

Name	Type
lateralSlope	Slope
longitudinalSlope	Slope
smoothness	One 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
turningSpace	Length	Turning space that this ground provides to people.
types	Array 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.

Name Type

description

LocalizedString

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

name

LocalizedString

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:

wikidata:Q117266 for a banana connector (https://www.wikidata.org/wiki/Q117266)
openstreetmap:way/123 for tying the tech to a specific location on the planet
wikipedia:Banana connector for a banana connector (https://en.wikipedia.org/wiki/Banana_connector)

Toilet ¶

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

Name	Type
flushMechanismDistanceFromToilet	Length	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.
grabBars	GrabBars	Object describing the grab bars.
hasAutomaticFlush	`boolean`	`true` if the toilet is automatically flushing after use.
heightOfBase	Length	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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isLatrine	`boolean`	Indicates whether the toilet is a latrine.
isSquatToilet	`boolean`	Indicates whether the toilet is a squat toilet.
isUrinal	`boolean`	Indicates whether the toilet is a urinal.
spaceInFront	Length	How much space is in front of the toilet?
spaceOnUsersLeftSide	Length	How much space is on the left side of the toilet? (from the perspective of somebody using the toilet)
spaceOnUsersRightSide	Length	How much space is on the right side of the toilet? (from the perspective of somebody using the toilet)

WashBasin ¶

Describes a wash basin.

Name	Type
accessibleWithWheelchair	`boolean`	`true` if the wash basin is accessible with wheelchairs, `false` if not.
height	Length	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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isLocatedInsideRestroom	`boolean`	`true` if the restroom's wash basin is inside the cabin, `false` if not.
spaceBelowDepth	Length	How deep is the space below the wash basin?
spaceBelowHeight	Length	How high is the space below the wash basin?

WheelchairParking ¶

Describes one or more wheelchair parking lots.

Name	Type
count	`number`	Defines many wheelchair accessible parking lots are provided
distanceToEntrance	Length	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.
hasDedicatedSignage	`boolean`	`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, or how you can engange in the main function of a place or thing. The keys of this object are the interaction types, and the values are InteractionMode objects.
isLocatedInside	`boolean`	`true` if the parking is inside a building or under a roof, `false` if not, `undefined` if unknown.
length	Length	Length constraint of the parking lots.
location	LocalizedString	Describes where the parking is located.
maxVehicleHeight	Length	Maximal allowed vehicle height for users of this parking.
neededParkingPermits	LocalizedString[]	List of permit names that allow using this parking.
width	Length	Width constraint of the parking lots.

WheelchairPlaces ¶

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

Name	Type
count	`number`	The number of designated places for wheelchairs, for example, in a cinema or theater.
hasSpaceForAssistant	`boolean`	Is there additional space for an assistant?
wheelchairUserCapacity	`number`	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.

Name	Type
access	Array 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.
descriptionWhereToGetLoginData	LocalizedString	Describes where you get the login data / guest pass.
hasCaptivePortal	`boolean`	`true` if the wifi has a captive portal website.
hasFixedPassword	`boolean`	`true` if the wifi has a fixed password. Knowing this password must be enough to enter and use the wifi.
isCaptivePortalAccessible	`boolean`	`true` if the wifi captive portal is accessible (WAI/ARIA).
isOpenToEveryone	`boolean`	`true` if the wifi is open to everyone, `false` if it is explicitly not.
isOpenToStaff	`boolean`	`true` if the wifi is open to explicit place staff, `false` if explicitly not.
isOpenToVisitors	`boolean`	`true` if the wifi is open to explicit place visitors, `false` if explicitly not.
needsGuestPass	`boolean`	`true` if you need a personalized guest pass / code / password to use the wifi, `false` if not.
password	`string`	A string with the Wifi password. Only use this attribute if security allows to publish this info online publicly.
ssid	`string`	A string with the Wifi name (SSID). Only use this attribute if security allows to publish this info online publicly.
usageFee	CurrencyValue[]	Describes if you need to pay a usage fee to use the wifi, or if no fee is needed.