poi-detail.schema.json

{
  "meta:license": [
    "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/poi-detail",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Point of Interest Details",
  "type": "object",
  "meta:extensible": true,
  "description": "A Point or Place of Interest(POI) Details. Used to capture the techncial and metadata information for a POI.",
  "definitions": {
    "geo-interaction-detail": {
      "properties": {
        "xdm:POIID": {
          "title": "POI Identity",
          "type": "string",
          "description": "The unique identifier of the POI."
        },
        "xdm:name": {
          "title": "POI Name",
          "type": "string",
          "description": "The name given to the POI."
        },
        "xdm:category": {
          "title": "POI Category",
          "type": "string",
          "description": "General category assigned for organizing the POIs by the administrator of POI definitions."
        },
        "xdm:type": {
          "title": "POI Type",
          "type": "string",
          "description": "The general type of the POI using a typing schema selected by the administrator of the POI definitions."
        },
        "xdm:distanceToPOICenter": {
          "title": "Distance to POI Center",
          "type": "number",
          "description": "Estimated distance from the POI Center in meters."
        },
        "xdm:locatingType": {
          "title": "Locating Type",
          "type": "string",
          "description": "Mechanism used to ascertain location.",
          "meta:enum": {
            "beacon": "Hardware beacon",
            "gps": "Device GPS",
            "ip": "IP to geo lookup",
            "ip+wifi": "IP with Wifi lookup",
            "wifi-triangulation": "Wifi triangulation"
          }
        },
        "xdm:beaconInteractionDetails": {
          "title": "Beacon Interaction Details",
          "$ref": "https://ns.adobe.com/xdm/context/beacon-interaction-details",
          "description": "Beacon details active for the POI interaction."
        },
        "xdm:geoInteractionDetails": {
          "title": "Geo Interaction Details",
          "$ref": "https://ns.adobe.com/xdm/context/geo-interaction-details",
          "description": "Geo details active for the POI interaction."
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/geo-interaction-detail"
    }
  ],
  "meta:status": "experimental"
}