API Changes

The sections below list APIs that were added, changed, or removed.

API version 2.3.5

Changed

• The X-Correlation-ID request header has been removed from the list of request parameters in /v2/health and /v2/version paths as not supposed to be supplied by clients.

Deprecated

• The format of X-Correlation-ID response header being of UUID is deprecated and may be changed in future. Clients should not rely on this specific format.

API version 2.3.4

There were no APIs added, changed, or removed in this release.

API version 2.3.3

There were no APIs added, changed, or removed in this release.

API version 2.3.2

Added

• Added optional platformVersion property in body.client object (ClientInfo schema). This new property accompanies existing platform property and is recommended to be used to pass platform version information in <major>.<minor> or <major>.<minor>.<build> format.

Changed

• Updated RSRP value range for LTE measurements according to 3GPP TS 36.133 specification. The new range accepted by the API is [-156; -44] dBm.
• Updated RSRQ value range for LTE measurements according to 3GPP TS 36.133 specification. The new range accepted by the API is [-34; +3] dB. Note that TS 36.133 defines the upper limit as +2.5dB, however some devices represent this parameter using integer type, thus this range is extended to simplify client implementations.

API version 2.3.1

Changed

• Added value pattern for ClientInfo.version property for clarity. This addition does not change the validation behaviour. Note that property description imposes stricter rules for this property value, which are enforced by the API server.
• Added maxLength parameter for WlanLocate.mac property as fail-early approach and for the sake of increased security. This addition does not change the validation behaviour, because currently defined pattern also does not allow input longer than set by the new parameter.

API version 2.3.0

There were no APIs added, changed, or removed in this release.

API version 2.2.4

There were no APIs added, changed, or removed in this release.

API version 2.2.0

There were no APIs added, changed, or removed in this release.

API version 2.1.1

Changed

• Improved MAC-48 address validation regular expression to exclude incorrect strings. New value is ^((([0-9a-fA-F]{2}:){5})|(([0-9a-fA-F]{2}-){5}))[0-9a-fA-F]{2}$.
• Increased maximum number of items in neighbor cell measurements (nmr) array for GSM and LTE technologies.

API version 2.1.0

Changed

• Updated the range of earfcn field in LTE measurements according to the latest standard (see 3GPP TS 36.104), the new maximum is set to 262143 (used to be 65535).

API version 2.0.0

Changed

• End-point for positioning requests changed to /v2/locate.
• JSON keys altaccuracy, baselat, baselng, cellparams,pilotpower, pnoffset, powrx, rxlevelhave been deprecated and replaced with altAccuracy, baseLat, baseLng, cellParams,pilotPower, pnOffset, rss, rxLevelrespectively.
• Dependent parameters combined as a subobject.
  • GSM local ID: bsic and bcch for serving cell moved under localId property.
  • GSM neighbor global ID: lac and cid for neighbor cell moved under globalIdentity property.
  • WCDMA local ID: uarfcn and psc for serving cell moved under localId property.
  • TD-SCDMA local ID: uarfcn and cellParams for serving cell moved under localId property.
  • LTE local ID: earfcn and pci for serving cell moved under localId property.
  • CDMA local ID: pnOffset and channel for serving cell moved under localId property.