• 1.0 About Veriplace
• 2.0 Getting Started
• 3.0 Using the User Discovery API
• 4.0 Using the Get Location API
• 5.0 Using the Past Location API
• 6.0 Using the Verify Permission API
• 7.0 Using the Permission Delete API
• 8.0 Using the Get Permissions API
• 9.0 Using the Invitation API
• 10.0 Using the Polling API
• 11.0 Using the Verify Locatability API
• 12.0 Previous API versions
• Veriplace XML Schema
• Disclaimer
• OAuth Core 1.0 Rev A

Previous API versions

12.0 Previous API Versions

When new APIs are added to the Veriplace platform, or their parameters or return values are changed, the new versions will use new URLs (/api/<version>/...) and the old versions will continue to be supported, with their old behavior, at the old URLs.

The previous chapters of the Developer Guide describe the current API version, 1.2. Here is a summary of the differences from previous API versions.

12.1 API 1.1

12.1.1 Extended callback parameters not supported

For the Get Location and Invitation APIs, the callbackContentType and callbackFormParamName parameters are not supported prior to API 1.2.

12.1.2 Retrieving asynchronous results

In API 1.1, polling for the result of an asynchronous request with /api/1.1/requests/<nonce> does not return a <getLocationResult> or <invitationResult> object as in API 1.2. Instead, for successfully completed requests, it returns a <location> or a <user> respectively; for failed requests, it does not return any XML or JSON content but simply an HTTP error code (which, as of API 1.2, is now contained in an <apiError> element) with no other information.

12.1.3 Cannot suppress cached position in error results

The noCachedPosition parameter is not supported prior to API 1.2; cached position is always included in error results, if available.

12.2 API 1.0

12.2.1 XML namespace

All XML responses from /api/1.0 URLs use the XML namespace "http://veriplace.com/xml/1.0".

12.2.2 JSON encoding not supported for most APIs

In version 1.0, the only APIs that can return a JSON-encoded response are the Polling API and the Invitation API. If you send a request with the header "Accept: application/json" to any other /api/1.0 URL, you will get an HTTP 406 error.

12.2.3 User discovery with multiple results

For requests to /api/1.0/users that return multiple results, the XML encoding is slightly different than in version 1.1. The 1.0 encoding is as follows:

<?xml version="1.0" encoding="UTF-8"?> 
<users xmlns="http://veriplace.com/xml/1.0">
  <user id="1378603015410979905" key="1115551212" keyType="mobile" />
  <user id="7799817486972445687" key="1115551213" keyType="mobile" />
</users>

12.2.4 Location Responses

In API 1.0, the XML encoding of the <location> element returned by the Get Location API is different from version 1.1 as follows:

• The <uncertainty> element is instead called <accuracy>. (This field was renamed because a higher value indicates a less accurate result.)
• The geographic address fields such as <street> and <city> are not enclosed in an <address> element.
• The geographic address elements are always present, even if they have no values.
• The <nearPointOfInterest> element does not exist. To request POI data, you must use API 1.1.

Here is an example of an API 1.0 location response:

<?xml version="1.0" encoding="UTF-8"?> 
    <location xmlns="http://veriplace.com/xml/1.0" id="1234"> 
        <created>1970-01-14T23:06:39Z</created> 
        <expires>1970-01-14T23:06:39Z</expires> 
        <position> 
            <longitude>-122.123456</longitude> 
            <latitude>37.123456</latitude> 
            <accuracy>100.0</accuracy> 
            <street>5858 Horton St</street> 
            <neighborhood/> 
            <city>Emeryville</city> 
            <state>CA</state> 
            <postal>94608</postal> 
            <countryCode>USA</countryCode> 
        </position> 
    </location>

12.2.5 Alternate URL for Verify Permission API

The Verify Permission API can be accessed at /api/1.0/verify as well as /api/1.0/permission.