Skip to content

API Versioning

Ryan Newington edited this page Sep 14, 2016 · 4 revisions

The web service currently supports two API versions. The original v1, and a newer v2 API.

The v2 API aligns the API to a set of REST API guidelines published by Microsoft.

The v2 API includes the following enhancements

  • The search resources function exposes a paged search function, rather that returning an entire result set in a single response
  • The create resource now returns the URI of the newly created resource, as well as the JSON representation of the resource in the response body (optional)
  • Errors return a new error object to adhere to the guidelines specified above.

API calls other than those listed above are identical between the v1 and v2, with the exception that error responses will be represented differently.

Clone this wiki locally