UserInfo.schema.json 2.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
{
  "UserInfo": {
    "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"
      }
    }
  }
}