UserInfo.schema.json 2.45 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
{
      "description": "A type containing user information.",
      "type": "object",
      "required": [
        "address",
        "accessPointId",
        "zoneId",
        "resourceURL"
      ],
      "properties": {
        "address": {
          "description": "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).",
          "type": "string",
          "format": "uri",
          "example": "acr:192.0.2.1"
        },
        "accessPointId": {
          "description": "Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element",
          "type": "string",
          "example": "001010000000000000000000000000001"
        },
        "zoneId": {
          "description": "Identifier of zone",
          "type": "string",
          "example": "zone01"
        },
        "resourceURL": {
          "description": "Self referring URL.",
          "type": "string",
          "format": "uri",
          "example": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123"
        },
        "locationInfo": {
          "description": "A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.",
          "type": "object",
          "required": [
            "latitude",
            "longitude",
            "accuracy"
          ],
          "properties": {
            "latitude": {
              "type": "number",
              "format": "float",
              "example": "80.123"
            },
            "longitude": {
              "type": "number",
              "format": "float",
              "example": "70.123"
            },
            "altitude": {
              "type": "number",
              "format": "float",
              "example": "10.0"
            },
            "accuracy": {
              "type": "integer",
              "format": "int32",
              "example": "10"
            }
          }
        },
        "contextLocationInfo": {
          "description": "Contextual information of a user location (e.g., aisle, floor, room number, etc.)",
          "type": "string",
          "example": "GroundFloor"
        },
        "ancillaryInfo": {
          "description": "Reserved for future use.",
          "type": "string"
        }
      }
    }