Get the whole space
const url = 'https://example.com/v1/example/data';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/example/data \ --header 'Authorization: Bearer <token>'The whole space document. It’s written through its parts: its name, subtitle and type here, its settings at /data/settings, and each collection at its own path.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The project ID of the space
Responses
Section titled “Responses”The space
A space: a building or site that visitors can find their way around.
object
The space’s name, shown to visitors as its heading.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A second line shown under the name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
What kind of space it is. Decides which built-in landmark categories are suggested to editors.
The space’s postal address.
object
The street address, without any unit or suite.
The unit or suite, if any.
The town or city.
The state, province or region, as an ISO 3166-2 code. Should be given wherever the country has them.
The country, as an ISO 3166-1 alpha-2 code.
The postal code.
Where the space is in the world. Needed to export the space in other formats, such as IMDF.
object
The WGS 84 latitude, in degrees, of the space’s origin [0, 0, 0].
The WGS 84 longitude, in degrees, of the space’s origin [0, 0, 0].
The compass bearing that the space’s -z axis points along, in degrees clockwise from true north. At 0, -z points north and +x points east.
The height of the space’s origin above the WGS 84 ellipsoid, in metres.
Everything placed in the space, keyed by entity id.
object
A way through a wall that would otherwise divide the walkable area, such as a doorway. Routes can pass through it in either direction, between points 1m in front of and 1m behind its pose, which is placed on the wall facing out of it. Applied when routes are worked out, so it doesn’t need the navigation mesh to be regenerated.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
Reserved for limiting the door to certain roles. Not used yet.
object
An area that routes can’t pass through, such as furniture the scan doesn’t capture. It’s built into the navigation mesh, so the mesh must be regenerated after an obstacle is added, changed or removed.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
Reserved for limiting the obstacle to certain roles. Not used yet.
object
Reserved for switching the obstacle off. Not used yet - the obstacle applies whatever its value.
Points on the floor around the area to block, each [x, y, z] in metres. The blocked area is the convex hull of the points, so their order doesn’t matter and a concave outline is filled in. It extends 3m up from each point.
A line on the floor that shows visitors a message when the route they’re following crosses it, within the next 3m - e.g. “Show your pass at the gate”. It doesn’t change routes.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The two ends of the line on the floor, each [x, y, z] in metres.
Reserved. Not used yet.
The guidance shown to visitors as their route crosses the line. A line with no message shows nothing.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Whether the message shows whichever way the line is crossed. Otherwise it only shows when crossing with points[0] on the visitor’s left and points[1] on their right.
A link between two walkable points that the navigation mesh doesn’t otherwise connect, such as stairs, an escalator or a ramp. Applied when routes are worked out, so it doesn’t need the navigation mesh to be regenerated.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The two ends of the connection, each [x, y, z] in metres on walkable floor.
Whether the connection can only be used from points[0] to points[1]. Otherwise it can be used either way.
Whether to leave the connection out of step-free routes, e.g. for stairs. If there’s no step-free route without it, the visitor is shown the ordinary route instead.
Seconds added each time a route uses the connection, e.g. waiting for an escalator. Defaults to 0.
How fast visitors move along the connection, in metres per second. Defaults to 1.4, a walking pace.
A web experience, such as AR content, that visitors launch when they’re near its pose. While it’s open, it’s sent the visitor’s camera position each frame so it can render in step with their view.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The experience’s name, shown in lists and in the banner that launches it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A second line shown under the title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The address of the published experience. It’s shown full screen in a frame, so the page must allow being framed.
The origin of the camera position sent to the experience: map for the space’s origin, or entity for this frame’s pose.
How close, in metres measured across the floor, a visitor must be for the experience to be offered. Being this close also counts as arriving when navigating to it. Must be greater than 0.
Reserved for the wording of the button that launches the experience. Not used yet.
Whether to list the experience for visitors even when they aren’t nearby.
An elevator’s call panel on one floor, with pose on the wall where the panel is. Panels for the same elevator are paired automatically: those whose positions are within 4m of each other across the floor, on different floors, are joined by an elevator that routes can use either way. Applied when routes are worked out, so it doesn’t need the navigation mesh to be regenerated.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The name of this panel’s floor as the elevator shows it, e.g. “3” or “Lower ground”. Shown to visitors when this is the floor they’re taking the elevator to.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The point on the floor in front of the panel, [x, y, z] in metres, where routes join and leave the elevator.
A landmark in the toilet category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a toilet.
object
Who the toilets are for. Gives the automatic title, e.g. “Toilets (Female)”. With no type, there’s no automatic title.
Whether the whole room is a single accessible toilet. When set, type and facilities are ignored and the automatic title is “Accessible toilet”.
The facilities it has, with true for each one. They’re listed in the automatic subtitle.
object
A landmark in the entrance-exit category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of an entrance or exit.
object
primary_access for a main way in and out, or side_access for a secondary one.
Whether it needs a keycard or code to open. Not shown to visitors yet.
A landmark in the meeting-room category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a meeting room.
object
The room’s own name, e.g. “The Cedar Suite”. When set, it’s used as the landmark’s automatic title, and “Meeting room” becomes its subtitle.
The equipment in the room, with true for each item it has.
object
The address of a page where the room can be booked. Not shown to visitors yet.
How many people it’s for. Shown as “Up to N people”. 0 means not set.
A landmark in the breakout-area category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a breakout area.
object
How many people it’s for. Shown as “Up to N people”. 0 means not set.
A landmark in the recycling-garbage category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a set of bins.
object
The kinds of bin there, with true for each one. They give the automatic title (“Bins”, “Recycling” or “Bins / Recycling”) and are listed in the subtitle.
object
A landmark in the kitchen category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a kitchen.
object
The appliances in the kitchen, with true for each one.
object
A landmark in the cafe-restaurant category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a café or restaurant.
object
The dietary options it caters for, with true for each one.
object
What it serves, with true for each one.
object
Whether there’s somewhere to sit.
A landmark in the reception category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a reception.
object
Whether visitors have to sign in here.
Whether deliveries can be left here.
A landmark in the waiting-area category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a waiting area.
object
The amenities it has, with true for each one.
object
A landmark in the personal-office category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a personal office.
object
Whose office it is, e.g. “Dr John Smith”. When set, it’s used as the landmark’s automatic title, and “Personal office” becomes its subtitle.
A landmark in the locker category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a bank of lockers.
object
Whether the lockers need a key or code to open.
A landmark in the storage category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of storage.
object
How big the storage is. Gives the automatic title, e.g. “Large storage”.
Whether it needs a key or code to open.
A landmark in the retail-store category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a shop.
object
What kind of shop it is. Gives the automatic title, e.g. “Vending machine”. With no type, there’s no automatic title.
A landmark in the phone-booth category.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
Details of a phone booth.
object
Whether there’s a power socket in the booth.
A landmark in any category that doesn’t have details of its own, or in no category. Any primaryCategory other than those with their own type: breakout-area, cafe-restaurant, entrance-exit, kitchen, locker, meeting-room, personal-office, phone-booth, reception, recycling-garbage, retail-store, storage, toilet, waiting-area.
object
Identifies the entity. Equal to its key in the space’s entities. Treat it as opaque - new ones are usually UUIDs.
Leaves a landmark out of what visitors are shown. It doesn’t stop any entity from affecting routes.
Where the entity is, and which way it faces. Entities placed by their points don’t use it.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Accessible QR codes linked to the entity. Currently only used for landmarks.
A physical Accessible QR code (AQR) placed in the space and linked to an entity. Visitors can scan it for more information when settings.scanForAQRs is on.
object
The URL encoded in the code, which identifies that individual code and the information it links to.
The code’s numeric category. It can be read from further away than the URL, so it’s used to match a code before its URL has been read.
How the entity relates to IMDF.
object
The IMDF category to export the entity with, in place of the one worked out from its type and category - e.g. atm.
Whether the entity was created by an IMDF import.
The landmark’s name. Leave it out to use the automatic title for its category and attributes, e.g. “Toilets (Female)” - a landmark in a category without one should always have a title.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Text that can be translated: a value in one language, plus optional translations into others.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A description shown on the landmark’s page, as HTML. It’s sanitised before it’s shown, and links open in a new tab.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Further blocks of content shown on the landmark’s page after its description, keyed by block id and shown in order of each block’s order.
object
A heading or a block of rich text.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
heading is a plain-text section heading. description is a block of rich text, as HTML.
The text. HTML for a description, which is sanitised before it’s shown. A block with no text isn’t shown.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
A carousel of images.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The images in the block, shown as a carousel, keyed by image id. Each one is ordered by its order in the same way as blocks are.
object
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The image’s path, a key into the space’s file store - not a URL.
Alternative text describing the image, for people who can’t see it.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
An embedded YouTube or Vimeo video.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The address of a YouTube or Vimeo video, as you’d share it - e.g. https://youtu.be/<id> or https://vimeo.com/<id>. Videos from anywhere else aren’t shown.
An audio clip with a player.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The name of the file it was uploaded from. Only shown to editors.
The audio file’s path, a key into the space’s file store - not a URL.
A web page shown in a frame.
object
Identifies the block. Equal to its key in the map that holds it.
Where the block sits among its siblings. Blocks are sorted by comparing these as plain strings, ascending, with ties broken by id. They’re fractional-index keys, so a block can be moved by giving it a key between its new neighbours.
The http(s) address of a web page to show in a frame. Embed codes - HTML snippets copied from a provider - aren’t accepted.
The path of the image shown at the top of the landmark’s page, a key into the space’s file store - not a URL.
Reserved for limiting the landmark to certain roles. Not used yet.
object
The categories the landmark is listed under, as tag id → true. Ids are either built-in categories or the space’s own tags. Usually includes primaryCategory. Leave out a tag rather than setting it to false.
object
Files attached to the landmark, keyed by attachment id. Reserved: not shown to visitors yet.
object
A file attached to a landmark. Reserved: attachments aren’t shown to visitors yet.
object
Identifies the attachment. Equal to its key in the landmark’s files.
The attachment’s display name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The file’s path, a key into the space’s file store.
What kind of file it is.
Where routes to the landmark lead, [x, y, z] in metres, if that’s different from where it’s shown (pose) - e.g. the door of a room whose marker is in its middle.
The landmark’s main category: the id of a built-in category without details of its own (e.g. baby-changing), or of one of the space’s tags. It has no automatic title, so the landmark should have a title.
Not used for these landmarks.
not matching
Reserved for groups of visitors. Not used yet.
object
Reserved for a group of visitors, such as staff, that entities could be limited to. Not used yet.
object
Identifies the role. Equal to its key in the space’s roles.
The role’s name.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The icon shown with the role.
Whether visitors must be logged in to have the role.
The space’s own landmark categories, keyed by tag id, alongside the built-in ones.
object
A category that landmarks can be listed under, e.g. for searching. Only categories with at least one landmark are shown to visitors.
object
Identifies the category. Equal to its key in the space’s tags. Using the id of a built-in category replaces that category for this space.
The category’s name, shown to visitors and used when searching.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
Other words visitors might search for to find the category, separated by commas in each language.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The icon shown with the category.
Whether to suggest the category to visitors before they’ve searched, with the distance to the nearest landmark in it.
The scanned maps of the space, used to show where visitors are, keyed by map id.
object
A map made with Immersal.
object
Identifies the map. Equal to its key in the space’s maps.
The map’s name, shown to editors.
Where the map sits in the space’s coordinate frame.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
The map’s 3D meshes, keyed by file path in the space’s file store, each with where it sits relative to the map.
object
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Where to follow the import that produced the map’s meshes.
The Immersal developer token used to access the map.
The Immersal API to use, if not the default.
The Immersal map.
A map made with MultiSet.
object
Identifies the map. Equal to its key in the space’s maps.
The map’s name, shown to editors.
Where the map sits in the space’s coordinate frame.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
The map’s 3D meshes, keyed by file path in the space’s file store, each with where it sits relative to the map.
object
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
Where to follow the import that produced the map’s meshes.
The MultiSet client id used to access the map.
The MultiSet client secret used to access the map.
The MultiSet API to use, if not the default.
The MultiSet map or map set.
Sets of 360° panoramas of the space, keyed by set id.
object
A set of 360° panoramas of the space, imported from another service.
object
Identifies the set. Equal to its key in the space’s panos.
Where the set sits in the space’s coordinate frame.
object
A point [x, y, z] in metres, in the space’s coordinate frame. The frame is shared by every floor and map, with +y up.
A rotation as a unit quaternion [x, y, z, w]. [0, 0, 0, 1] is no rotation.
The service the panoramas were imported from.
The set’s name, shown to editors.
Where to follow the import of the panoramas, and find them once it’s done.
For multiset, the map in maps the panoramas were imported for.
Whether the import has finished, successfully or not.
The space’s floors, keyed by floor id. Worked out from the scan each time the navigation mesh is generated.
object
A floor of the space. Floors are worked out from the scan each time the navigation mesh is generated. A floor found at about the same height as before keeps its id, title and ordinal; any others are removed or added.
object
Identifies the floor. Equal to its key in the space’s floors.
The floor’s number, counting up from 0 for the lowest. Visitors see “Floor title.
The floor’s name as visitors see it, e.g. “Ground floor”, in place of its number.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.
Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.
object
The height of the floor’s walkable surface, in metres. A point belongs to the highest floor whose y is no more than 0.5m above it.
The floor’s level relative to the floor with ground-level access, which is 0: 1 is the floor above it, -1 the one below. Defaults to the floor’s position counting up from the lowest, which is right unless the space has floors below ground level.
How far the floor extends above y, in metres - up to just below the next floor. Used to decide what’s shown when viewing one floor at a time.
Settings for how the space behaves for visitors and editors.
object
Not used. Whether a space is public is set separately from its document.
Whether people nearby can find the space from their location. Only public spaces with a georeference are found.
The language editors write in by default, as a BCP 47 tag, e.g. en or en-GB. It isn’t used to choose which translation visitors see.
How distances are shown to visitors who haven’t chosen for themselves. Defaults to metres.
Landmark fields that editors must fill in before saving a landmark, as field name → true. Only enforced in the editor. The fields that can be required are subtitle, description, pose, tags, banner and content.
object
Whether to stop the space’s walls and floors hiding routes and markers that are behind them in AR.
Whether routes can go through places with only 0.5m of headroom, rather than the usual 1.5m. The navigation mesh must be regenerated after it’s changed.
Whether choosing a landmark that has nothing more than a title and subtitle starts navigating straight away, rather than first showing its page.
The image behind the screens visitors see when they first open the space. Defaults to default.
The path of the image to use when onboardingImageType is custom, a key into the space’s file store - not a URL.
Whether editors get extra tools for placing and moving landmarks precisely. Only affects the editor.
A phone number visitors can call for help, offered while they’re navigating. Best given in international format.
Whether searching for landmarks only finds titles that contain exactly what was typed. Otherwise search also allows near matches, and looks at subtitles and categories too.
How far, in metres, routes keep from walls and obstacles, so gaps narrower than twice this aren’t walkable. Defaults to 0.2. The navigation mesh must be regenerated after it’s changed.
Whether every attempt to work out where a visitor is uses several camera images, rather than one. Can be more accurate, but takes longer.
Whether visitors can scan the Accessible QR codes placed in the space for more information.
Where to find the navigation mesh, which describes the areas visitors can walk, worked out from the maps, obstacles and settings. If meshHash isn’t the current mapMeshHash, the maps have changed since it was generated.
object
The mapMeshHash the navigation mesh was generated from.
The path of the navigation mesh’s file, a key into the space’s file store - not a URL.
The version of the format the navigation mesh files are in.
The path of the file of the navigation mesh used for step-free routes, a key into the space’s file store - not a URL.
Identifies the current version of the maps’ meshes.
A regeneration of the navigation mesh started through the API, while it’s running or if it failed.
object
Identifies the job.
When the job started, in milliseconds since the Unix epoch.
running until the job finishes - when it succeeds, generatedNavMesh is updated and this is removed. failed if it didn’t.
Why the job failed.
Whether the space’s set-up has been completed in the editor.
Example
{ "name": "Reception", "subtitle": "Reception", "type": "residential", "address": { "address": "1 Example Street", "unit": "Suite 400", "locality": "London", "province": "GB-ENG", "country": "GB", "postalCode": "SW1A 1AA" }, "georeference": { "latitude": 51.5072, "longitude": -0.1276, "heading": 90 }, "entities": { "additionalProperty": { "pose": { "position": [ 1.5, 0, -3.2 ], "quaternion": [ 0, 0, 0, 1 ] }, "type": "door" } }, "roles": { "additionalProperty": { "name": "Reception", "icon": "123" } }, "tags": { "additionalProperty": { "name": "Reception", "keywords": "Reception", "icon": "123" } }, "maps": { "additionalProperty": { "type": "immersal", "offset": { "position": [ 1.5, 0, -3.2 ], "quaternion": [ 0, 0, 0, 1 ] }, "gltfs": { "additionalProperty": { "position": [ 1.5, 0, -3.2 ], "quaternion": [ 0, 0, 0, 1 ] } } } }, "panos": { "additionalProperty": { "pose": { "position": [ 1.5, 0, -3.2 ], "quaternion": [ 0, 0, 0, 1 ] }, "type": "matterport" } }, "floors": { "additionalProperty": { "name": "0", "title": "Reception", "ordinal": 0 } }, "settings": { "defaultDistanceUnit": "meters", "mandatoryLandmarkFields": { "banner": true, "tags": true }, "onboardingImageType": "default", "assistanceTelephone": "+44 20 7946 0000" }, "generatedNavMesh": { "navMesh": "navmesh/3f8a5d1e-1111-4222-8333-444455556666.json" }, "navMeshJob": { "status": "running" }}The token is missing or invalid.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The token has no access to this space.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Too many requests. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream failed.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The space is moving between servers. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream timed out.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}