Versions Compared

Old Version 11

changes.mady.by.user Christine Steenstrup

Saved on

compared with

New Version 12

changes.mady.by.user Christine Steenstrup

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
usewithoutbodytrue
rootMARS API Methods

 

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 ContainmentEvent 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

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

boundary

string

Defines if the user was "INSIDE" or "OUTSIDE" of a target area during a breach. The MARS API only uses floor breaches, so this always returns "INSIDE".

X

X

areaType

string

The location object a client device was seen on. Accepted values: "CAMPUS", "BUILDING", "FLOOR" and "ZONE". The MARS API only uses floor breaches, so this always returns "FLOOR".

X

X

containerHierarchy

string

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

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
{
    "ContainmentEvent": 
	{
        "subscriptionName": <string>,
        "entity": <string>,
        "deviceId": <string>,
        "locationCoordinate": 
		{
            "x": <float>,
            "y": <float>,
            "unit": <string>
        },
        "geoCoordinate": 
		{
            "lattitude": <float>,
            "longitude": <float>,
            "unit": <string>
        },
        "boundary": <string>,
        "areaType": <string>,
        "containerHierarchy": <string>,
        "timestamp": <string>
    }
}

MSE 8 Payload

For version 8 of MSE, construct the following payload:

Code Block
themeMidnight
{
    "ContainmentEvent": 
	{
        "subscriptionName": <string>,
        "entity": <string>,
        "deviceId": <string>,
        "confidenceFactor": <float>,
        "locationCoordinate": 
		{
            "x": <float>,
            "y": <float>,
            "unit": <string>
        },
        "mseUdi": <string>,
        "floorRefId": <integer>,
        "boundary": <string>,
        "areaType": <string>,
        "geoCoordinate": 
		{
            "latitude": <float>,
            "longitude": <float>,
            "unit": <string>
        },
        "containerHierarchy": <string>,
        "timestamp": <string>
    }
}

ON THIS PAGE

Table of Contents