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. |
AbsenceEvent 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:
- AssociationEvent Request Body
- ContainmentEvent Request Body
- AbsenceEvent Request Body
- MovementEvent Request Body
The following fields exist within a nested AbsenceEvent 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 | mseUdi | string | The unique Cisco MSE ID. | ||
X | X | geoCoordinate | object | An object containing key / value pairs of geographical coordinate data:
| ||
| X | floorRefId | integer | The unique ID for a floor object in the Cisco MSE database. | ||
X | X | absenceDurationInMinutes | integer | The number of minutes since the user's device was last seen by the MSE. | ||
X | X | lastSeen | string | The timestamp at which the MSE last saw the client device. | ||
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 | ||
---|---|---|
| ||
{ "AbsenceEvent": { "subscriptionName": <string>, "entity": <string>, "deviceId": <string>, "locationMapHierarchy": <string>, "locationCoordinate": { "x": <float>, "y": <float>, "unit": <string> }, "absenceDurationInMinutes": <integer>, "geoCoordinate": { "lattitude": <float>, "longitude": <float>, "unit": <string> }, "lastSeen": <string>, "timestamp": <string> } } |
MSE 8 Payload
For version 8 of MSE, construct the following payload:
Code Block | ||
---|---|---|
| ||
{ "AbsenceEvent": { "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>, "absenceDurationInMinutes": <integer>, "lastSeen": <string>, "timestamp": <string> } } |
ON THIS PAGE
Table of Contents |
---|