Positioning API Developer's Guide

Parameters

The following topics provide details of the parameters supported by this API

Table 1. Positioning API Parameters
Name in Required Description
Content-Encoding header Indicates the data in the body is gzip encoded. Value must be 'gzip'.
app_code query required A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.
app_id query required A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.
confidence query Confidence level in percent for the accuracy/uncertainty in the location estimate response. If not specified, the default is 68 (this corresponds to a 68% probability that the true position is within the accuracy/uncertainty radius of the location estimate: the higher the number, the greater the confidence level).
desired query Comma-separated list of additional data fields that the service should include in the response if data is available. The query parameter supports the value 'altitude'.
fallback query Acceptable fallback level for cell based positioning. Use the default setting to accept cell tower level location estimates only. If you allow a WGS-84 compliant geocoordinate location estimate based on LAC, RNC, TAC, NID, or RZ areas, use the fallback=area setting. If you use the fallback=any setting, the service uses all available fallback methods and therefore the location estimate in the response may be at the MNC, SID, or MCC level. This parameter has no effect on WLAN based positioning. If the request contains both cell and WLAN measurements, this parameter only has an effect if no WLAN based position is found.
required query Comma-separated list of additional data fields that the service should include in the response. If the data is not available, the response contains an error message. The query parameter supports the value 'altitude'.