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/Link||SDK/ API Type||Document Description||Last Updated|
|Mapping API v1.1||Mapping|
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.
|Mapping API Architecture||Mapping|
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
|Cisco Prime Binding||Location|
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.
|Mapping API Methods||Mapping|
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
|Mapping API Rich Example||Mapping||This 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 Handling||Mapping||Provides the HTTP status codes and and error payloads for the mapping API||1/12/2015|
|POI Types||Mapping||A list of the pre-defined POI Types and their integer values in the database||1/12/2015|
|Location API v1.2||Location||This document describes the specification for the MaaS Location ("API"), which allows remote clients to query for their devices' locations.||1/12/2015|
|Location API Architecture||Location||Describes 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 Strings||3/16/2015|
|Retrieve Location Data||Location||This method is used to return a device's location coordinates and venue map data.||1/14/2015|
|Location API Response Handling||Location||Provides the HTTP status codes and and error payloads for the location API||1/14/2015|
|MARS API v1.1||MARS||This 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 Architecture||MARS||Provides the request/response format, HTTP method description, date/time format and, ellipses usage||1/13/2015|
|MARS API Method||MARS|
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.
|MARS API Response Handling||MARS||Description 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/|