Methods in the Web API can change over time, however, despite this, it's important that such a change does not break older implementations. In order to be able to do so, Web API 3 uses query string versioning.

Specifying version

In order to specify a version, you simply have to add another query string parameter, v for example, v=1. By default, the version is number is always 1, so if you want to get the newest version, you have to change it explicitly.

How methods are updated

Web API methods are updated as follows:

  • For small changes that include introduction of new input or output parameters, we keep the version number the same. It's important that you use a JSON parser when consuming the API and avoid any RegEx or similar optimizations.
  • For changes that affect the way the method works, we will increase the version number.