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.

Mapping API v1.1

 

This document describes the specification for the MaaS Mapping API ("API"). This API allows remote clients to manage the various resources associated with mapping, including venues, campuses, buildings, floors, points of interest, segments and routes.

Security

All calls made to the CME must adhere to the guidelines presented in the  MaaS Security Protocol document.

 

Definitions

Below are the object types that need to be created, read, updated and destroyed (CRUD) for geofences, callbacks and associated zone elements. Other terms used with the Mapping service are defined as well. 

Term

Definition

Venue

A location where events take place. Venues consist of one or more campuses.

Campus

A collection of one or more buildings grouped together by a common theme.

Building

A physical structure that contains one or more floors.

Floor

An object associated with a building containing a building ID, floor ID, zoom level and resource URL(s) (e.g. .svg, .pdf).

Resource

The image files associated with a floor. The .svg or .pdf asset URL and the associated metadata are often referred to as a map.

Point

A point of interest (POI), waypoint or portal location associated with a map.

Zoom Level

The zoom scale on the actual map.

  • Zoom Level 1 = 1.0 zoom scale on device
  • Zoom Level 2 = 2.0 zoom scale on device
  • Zoom Level 3 = 4.0 zoom scale on device
  • Zoom Level 4 = 8.0 zoom scale on device
  • Zoom Level 5 = 16.0 zoom scale on device
  • Undefined Zoom Level = -1

MSE

The Cisco Mobility Services Engine (MSE) is a network appliance that provides tools for wireless network monitoring and network asset location tracking.

GUID

A Globally Unique Identifier (GUID) is a unique identifier that typically conforms to the Universally Unique Identifier (UUID) standard as defined by the Open Software Foundation. For reference, see http://en.wikipedia.org/wiki/Globally_unique_identifier and http://en.wikipedia.org/wiki/Universally_unique_identifier.

JSON

Stands for JavaScript Object Notation and is used for the request and response formats due to its portability and simplicity.

RFC 3339

A date format that "provide[s] an unambiguous and well-defined method of representing dates and times."

See http://www.ietf.org/rfc/rfc3339.txt for more details.

ON THIS PAGE

  • No labels