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.

Location Based Services APIs

Document Title/LinkSDK/ API TypeDocument DescriptionLast Updated
Mapping API v1.1Mapping

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

1/15/2015
Mapping API ArchitectureMapping

Describes the Mapping API architecture including: Production URL, Request / Response Format, HTTP Method, Date / Time Format, Bracketed IDs ("[id]"s), Ellipses ("…"s), PUT Methods and Partial Updates, URL Definitions, and GET Methods and Query Strings

1/15/2015
Cisco Prime BindingLocation

Provides the POST steps and data to construct venues, campuses, buildings, floors and resources from data provided by Cisco Prime; includes the callback URL in Cisco Prime to which an HTTP POST request is sent.

1/15/2015
Mapping API MethodsMapping

Provides descriptions of the endpoints and methods for creating, updating, and deleting: VENUE, CAMPUS, BUILDING, FLOOR, RESOURCE, POINT, POI TYPE, ROUTE, SEGMENT; additional methods related to the main processes are also

1/15/2015
Mapping API Rich ExampleMappingThis document provides examples that showcase how developers can build an example venue. Upon completion, the venue will appear in the Multiscreen as a Service (MaaS) portal's Map Editor, where credentialed users can then create points of interest (POIs), segments and routes for the newly created venue's map.1/23/2015
Mapping API Response HandlingMappingProvides the HTTP status codes and and error payloads for the mapping API1/12/2015
POI TypesMappingA list of the pre-defined POI Types and their integer values in the database1/12/2015
Location API v1.2LocationThis document describes the specification for the MaaS Location ("API"), which allows remote clients to query for their devices' locations.1/12/2015
Location API ArchitectureLocationDescribes the Location API architecture including: Production URL, Request / Response Format, HTTP Method, Date / Time Format, Bracketed IDs ("[id]"s), Ellipses ("…"s), PUT Methods and Partial Updates, URL Definitions, and GET Methods and Query Strings3/16/2015
Retrieve Location DataLocationThis method is used to return a device's location coordinates and venue map data.1/14/2015
Location API Response HandlingLocationProvides the HTTP status codes and and error payloads for the location API1/14/2015
MARS API v1.1MARSThis document describes the specification for the MaaS MARS API ("API") and the contract between the API and the mobile SDKs. It describes the payload data delivered by the Cisco MSE for processing by the MARS server.1/13/2015
MARS API ArchitectureMARSProvides the request/response format, HTTP method description, date/time format and, ellipses usage1/13/2015
MARS API MethodMARS

Description of the methods in use with Phunware's MARS API including: Register with MARS, Obtain a MAC Address, Deliver the MAC Address to the MARS Server, Register or Update with Cisco MSE, Upload Map Image Data for a Floor, and Delete Full Bind record.

1/13/2015
MARS API Response HandlingMARSDescription of the HTTP status codes and error payloads.1/13/2015
Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/