Export (0) Print
Expand All

REST reference

The Live SDK Representational State Transfer (REST) API enables apps with services using Microsoft account to access users' info, contacts, friends, media, and files, that are stored on Microsoft OneDrive.

Supported HTTP verbs

The Live SDK REST API supports these standard HTTP verbs.

  • GET—Returns a representation of a resource.
  • POST—Adds a new resource to a collection.
  • PUT—Updates a resource at the location pointed by the URL or creates a new resource, if it doesn't exist.
  • DELETE—Deletes a resource.
  • MOVE—Moves the location of a resource.
  • COPY—Duplicates a resource.

Request URLs must reference https://apis.live.net/v5.0/, followed by the path for the object you are working with, any parameters, and finally, the access token (represented here as ACCESS_TOKEN).

https://apis.live.net/v5.0/me/albums?access_token=ACCESS_TOKEN

Support for resumable downloads

The Live SDK provides support for resumable downloads by using the HTTP Range header. If a download is interrupted, an app can continue the download at a later time by requesting only the byte range for the remainder of the file. This is particularly useful when downloading larger files, or in situations where network reliability is less than optimal.

Returned status codes

Here are the possible status codes that may be returned by the REST response.

CodeDescription
200The request was successful.
201The resource was created.
204The resource was deleted.
302The response is a redirect to a specific location.
400Bad request. See the response error message for more details.
401The token was invalid, missing, or expired.
403The token was not authorized, or the user has not been granted permissions.
404The resource was not found.
405An invalid method was used.
408The request timed out.
409The request failed, due to an edit conflict.
410The endpoint or scenario is no longer supported.
413The request entity body was too large.
415The request entity body was an invalid media type.
420The request was throttled. Throttling occurs on a per/app and per/user basis.
423The requested resource is locked and can't be updated.
499There is a connection issue with the client.
500The server had an unexpected error.
503The server is unavailable.
507The user doesn't have enough available storage.

 

What's included in the REST API:

Topic Description
Rest objects In the Live SDK, REST objects contain categories of information.
Query parameters Query parameters can be added to the end of the request URL to modify information returned in the response.
Additional URL parameters You can specify additional parameters to instruct the Live SDK APIs, on how to return its results.

 

Related topics

Scopes and permissions

 

 

Show:
© 2014 Microsoft