Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

AssociationEvent Request Body

Tip

This page is a continuation of the Request Bodies section of the Deliver the MAC Address to the MARS Server method.

Request body payloads will depend upon the Cisco MSE message type being created:

The following fields exist within a nested AssociationEvent object. Required fields are underlined.

v.7

v.8

Parameter

Value

Description

X

X

subscriptionName

string

The name of the events subscription.

X

X

entity

string

The source agent of the events.

X

X

deviceId

string

The device's MAC address.

 

X

confidenceFactor

float

A numeric value from 0-100 indicating the percent accuracy of the location coordinate returned.

X

X

locationMapHierarchy

string

A concatenation of the campus name, building name and floor name separated by the '>' character. Used to identify the floor uniquely (e.g. "Phunware_Austin>South>1st_Floor").

X

X

locationCoordinate

object

An object containing key / value pairs of location coordinate data:

  • x (float): The x-coordinate of the location.
  • y (float): The y-coordinate of the location.
  • unit (string): The unit of measurement (e.g. "FEET").

 

X

mseUdi

string

The unique Cisco MSE ID.

X

X

geoCoordinate

object

An object containing key / value pairs of geographical coordinate data:

Note

MSE 7 accepts "lattitude" [sic] while MSE 8 accepts "latitude".

  • lat[t]itude (float): The latitude coordinate of the location, in decimal degrees.
  • longitude (float): The longitude coordinate of the location, in decimal degrees.
  • unit (string): The unit of measurement (e.g. "DEGREES").

 

X

floorRefId

integer

The unique ID for a floor object in the Cisco MSE database.

X

X

association

Boolean

Indicates whether the mobile device is associated with the access point.

X

X

ipAddress

array

An array of device IP addresses, as strings.

X

X

apMacAddress

string

The AP MAC Address of the Wi-Fi access point. If neither the AP MAC address nor IP address is provided, then service will do a device ID lookup for a given MAC address.

 

X

status

integer

A numeric value indicating the client's association status. Accepted values: 3 (for Associated) and 7 (for Probing)

 

X

username

string

Username of client in username-based service set identifiers (SSIDs) or a Wi-Fi network name.

 

X

ssid

string

The name of the SSID the client device is connected to (e.g. "Guest Wi-Fi").

 

X

band

string

The GHz band at which the access point received a client probe. It is usually 2.4 or 5 GHz.

 

X

dot11Status

string

A string indicating the client's association status. Accepted values: "ASSOCIATED", "PROBING", "DELETED"

 

X

guestUser

Boolean

Indicates whether the connected device is a guest user.

X

X

timestamp

string

The date and time in RFC 3339.

MSE 7 Payload

For version 7 of MSE, construct the following payload:

Code Block
themeMidnight
{
    "AssociationEvent": 
	{
        "subscriptionName": <string>,
        "entity": <string>,
        "deviceId": <string>,
        "locationMapHierarchy": <string>,
        "locationCoordinate": 
		{
            "x": <float>,
            "y": <float>,
            "unit": <string>
        },
        "geoCoordinate": 
		{
            "lattitude": <float>,
            "longitude": <float>,
            "unit": <string>
        },
        "timestamp": <string>,
        "association": <Boolean>,
        "apMacAddress": <string>,
        "ipAddress": 
		[
            <string>,
            <string>
        ]
    }
}

MSE 8 Payload

For version 8 of MSE, construct the following payload:

Code Block
themeMidnight
{
    "AssociationEvent": 
	{
        "subscriptionName": <string>,
        "entity": <string>,
        "deviceId": <string>,
        "confidenceFactor": <float>,
        "locationMapHierarchy": <string>,
        "locationCoordinate": 
		{
            "x": <float>,
            "y": <float>,
            "unit": <string>
        },
        "mseUdi": <string>,
        "geoCoordinate": 
		{
            "latitude": <float>,
            "longitude": <float>,
            "unit": <string>
        },
        "floorRefId": <integer>,
        "association": <Boolean>,
        "ipAddress": 
		[
            <string>,
            <string>
        ],
        "apMacAddress": <string>,
        "status": <integer>,
        "username": <string>,
        "ssid": <string>,
        "band": <string>,
        "dot11Status": <string>,
        "guestUser": <Boolean>,
        "timestamp": <string>
    }
}

ON THIS PAGE

Table of Contents