Skip to end of metadata
Go to start of metadata

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.

Register or Update with Cisco MSE

 

This method is used to register or update a Cisco MSE. Given the list of floors, and associated information, this will populate the identified venue's campuses, buildings and floors. The response will then contain API URLs for each map resource that needs to be uploaded.

Method

POST

URL

http://mars-api.phunware.com/v1.1/mse/[guid]/register

Request Body

Required parameters are underlined.

Parameter

Value

Description

floors

array

An array of floor objects containing key-value pairs. Required keys are underlined:

  • name (string): The unique name of the floor.
  • level (integer): The floor level within the building.
  • isOutdoor (Boolean): Indicates whether the floor is outdoor.
  • length (integer): The length of this floor.
  • height (integer): The height of this floor.
  • offsetX (integer): The X offset of the floor within the map image.
  • offsetY (integer): The Y offset of the floor within the map image.
  • textHierarchy (array): An array containing the campus, building and floor name (in that order).
  • imageExists (Boolean): Indicates whether an image exists for this floor. If true, the response will contain an item referencing an API URL where the actual resource data should be posted.
  • imageName (string): The name of the image, if it exists. This is only used to send back in the response.
  • imageType (string): The MIME type of the image, if it exists. This is only used to send back in the response.
{
    "floors": 
	[
        {
            "name": <string>,
            "level": <integer>,
            "isOutdoor": <Boolean>,
            "length": <integer>,
            "height": <integer>,
            "offsetX": <integer>,
            "offsetY": <integer>,
            "textHierarchy": 
			[
                <string>,
                <string>,
                <string>
            ],
            "imageName": <string>,
            "imageType": <string>,
            "imageExists": <Boolean>
        }
    ]
}

Example Request

POST the following request body to: http://mars-api.phunware.com/v1.1/mse/f0685279-7497-4d90-882e-12201e476b0e/register/

{
    "floors": 
	[
        {
            "name": "WNBU",
            "level": 4,
            "isOutdoor": false,
            "length": 185,
            "height": 10,
            "offsetX": 5,
            "offsetY": 0,
            "textHierarchy": 
			[
                "Cisco Site 4",
                "SJ-14",
                "WNBU"
            ],
            "imageName": "domain_0_1349311055718.png",
            "imageType": "image/png",
            "imageExists": true
        }
    ]
} 

Response

A success response will return a 200 status code with no data in the body of the response. See MARS API Response Handling for error payloads.

ON THIS PAGE

 

 

 

  • No labels