UserInfo.schema.json 4.52 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
{
Elian Kraja's avatar
Elian Kraja committed
  "type": "object",
  "properties": {
Elian Kraja's avatar
Elian Kraja committed
    "accessPointId": {
      "description": "The identity of the access point the user is currently on, see note 1.",
      "type": "string",
      "x-etsi-mec-cardinality": "1",
      "x-etsi-mec-origin-type": "String"
    },
    "address": {
      "description": "Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.",
      "format": "uri",
      "type": "string",
      "x-etsi-mec-cardinality": "1",
      "x-etsi-mec-origin-type": "AnyURI"
    },
    "ancillaryInfo": {
      "description": "Reserved for future use.",
      "type": "string",
      "x-etsi-mec-cardinality": "0..1",
      "x-etsi-mec-origin-type": "String"
    },
    "contextLocationInfo": {
      "description": "Contextual information of a user location (e.g. aisle, floor, room number, etc.).",
      "type": "string",
      "x-etsi-mec-cardinality": "0..1",
      "x-etsi-mec-origin-type": "String"
    },
    "locationInfo": {
Elian Kraja's avatar
Elian Kraja committed
      "properties": {
Elian Kraja's avatar
Elian Kraja committed
        "accuracy": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "accuracyAltitude": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "accuracySemiMinor": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "altitude": {
          "description": "Location altitude relative to the WGS84 ellipsoid surface.",
          "type": "number",
Elian Kraja's avatar
Elian Kraja committed
          "x-etsi-mec-cardinality": "0..1",
Elian Kraja's avatar
Elian Kraja committed
          "x-etsi-mec-origin-type": "Float"
        },
        "confidence": {
          "type": "number"
        },
        "includedAngle": {
          "type": "number"
        },
        "innerRadius": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "latitude": {
          "description": "Location latitude, expressed in the range -90 to +90. Cardinality greater than one only if \"shape\" equals 7.",
          "items": {
            "type": "number"
Elian Kraja's avatar
Elian Kraja committed
          },
Elian Kraja's avatar
Elian Kraja committed
          "minItems": 1,
          "type": "array",
          "x-etsi-mec-cardinality": "1..N",
          "x-etsi-mec-origin-type": "Float"
        },
        "longitude": {
          "description": "Location longitude, expressed in the range -180 to +180. Cardinality greater than one only if \"shape\" equals 7.",
          "items": {
            "type": "number"
          },
          "minItems": 1,
          "type": "array",
          "x-etsi-mec-cardinality": "1..N",
          "x-etsi-mec-origin-type": "Float"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "offsetAngle": {
          "type": "number"
        },
        "orientationMajorAxis": {
          "type": "number"
        },
        "shape": {
          "description": "Shape information, as detailed in [14], associated with the reported location coordinate:\n1 = Ellipsoid_Arc\n2 = ellipsoid_Point\n3 = ellipsoid_Point_Altitude\n4 = ellipsoid_Point_Altitude_Uncert_Ellipsoid\n5 = ellipsoid_Point_Uncert_Circle\n6 = ellipsoid_Point_Uncert_Ellipse\n7 = polygon",
Elian Kraja's avatar
Elian Kraja committed
          "type": "string",
          "x-etsi-mec-cardinality": "1",
Elian Kraja's avatar
Elian Kraja committed
          "x-etsi-mec-origin-type": "Enum_inlined"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "uncertaintyRadius": {
          "type": "number"
        },
        "velocity": {
          "description": "Structure with attributes relating to the target entitys velocity, as defined in [14].",
Elian Kraja's avatar
Elian Kraja committed
          "type": "object",
Elian Kraja's avatar
Elian Kraja committed
          "x-etsi-mec-cardinality": "0..1",
          "x-etsi-mec-origin-type": "Structure (inlined)"
        }
      },
      "required": [
        "latitude",
        "longitude",
        "shape"
      ],
      "type": "object",
      "x-etsi-ref": "6.5.3"
    },
    "resourceURL": {
      "description": "Self-referring URL, see note 1.",
      "type": "string",
      "x-etsi-mec-cardinality": "1",
      "x-etsi-mec-origin-type": "String"
    },
    "timeStamp": {
      "properties": {
        "nanoSeconds": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        },
Elian Kraja's avatar
Elian Kraja committed
        "seconds": {
          "type": "number"
Elian Kraja's avatar
Elian Kraja committed
        }
      },
      "required": [
Elian Kraja's avatar
Elian Kraja committed
        "seconds",
        "nanoSeconds"
Elian Kraja's avatar
Elian Kraja committed
      ],
Elian Kraja's avatar
Elian Kraja committed
      "type": "object",
      "x-etsi-ref": "6.5.2"
    },
    "zoneId": {
      "description": "The identity of the zone the user is currently within, see note 1.",
      "type": "string",
      "x-etsi-mec-cardinality": "1",
      "x-etsi-mec-origin-type": "String"
Elian Kraja's avatar
Elian Kraja committed
  },
  "required": [
    "address",
    "accessPointId",
    "zoneId",
    "resourceURL",
    "timeStamp"
  ],
  "description": "Represents the information related to a user attached to an access point associated to the MEC host, such access point is in scope of the Location Service instance.\n",
  "x-etsi-notes": ":\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified in [5], clause 5.2.2.5.",
  "x-etsi-ref": "6.2.2"
}