Live SDK REST API
The Live SDK Representational State Transfer (REST) API enables apps to access users' info, contacts, friends, media, and files, that are stored on Microsoft OneDrive.
In this article
Supported HTTP verbs
Support for resumable downloads
Returned status codes
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 might be returned by the REST response.
Code |
Description |
---|---|
200 |
The request was successful. |
201 |
The resource was created. |
204 |
The resource was deleted. |
302 |
The response is a redirect to a specific location. |
400 |
Bad request. See the response error message for more details. |
401 |
The token was invalid, missing, or expired. |
403 |
The token was not authorized, or the user has not been granted permissions. |
404 |
The resource was not found. |
405 |
An invalid method was used. |
408 |
The request timed out. |
409 |
The request failed, due to an edit conflict. |
410 |
The endpoint or scenario is no longer supported. |
413 |
The request entity body was too large. |
415 |
The request entity body was an invalid media type. |
420 |
The request was throttled. Throttling occurs on a per/app and per/user basis. |
423 |
The requested resource is locked and can't be updated. |
499 |
There is a connection issue with the client. |
500 |
The server had an unexpected error. |
503 |
The server is unavailable. |
507 |
The user doesn't have enough available storage. |
What's included in the REST API:
Topic |
Description |
---|---|
In the Live SDK, REST objects contain categories of information. |
|
Query parameters can be added to the end of the request URL to modify information returned in the response. |
|
You can specify additional parameters to instruct the Live SDK APIs, on how to return its results. |