Additional URL parameters

  • Article

This topic describes the additional parameters available for the Live SDK REST API GET request.

[The return_ssl_resources parameter is deprecated. All resources will be returned with secure HTTPS URLs.]

You can specify additional parameters in the URL of a Live SDK GET request. These additional parameters allow you to indicate how the Live SDK should return its results.

The following table explains these parameters.

Parameter

Description

Valid values

Default value

Examples

pretty

When this value is set to true, the Live SDK returns the response in a more human-readable format. When this value is set to false, white space and new lines are not included, which improves performance but makes the response less readable.

true/false

true

pretty=false

callback

The name of the function that handles the JavaScript Object Notation (JSON) with padding (JSONP) function call. When this parameter is specified, all error responses use the HTTP status code 200 to help ensure proper handling in the web browser.

A string that represents the name of the callback function.

None

callback=onResponse

suppress_response_codes

When this value is set to true, the Live SDK returns the HTTP status code 200 for all error responses. This option is useful with web-browser plug-ins like Microsoft Silverlight or Adobe Flash Player.

true/false

false

suppress_response_code=true

method

The name of the HTTP method that is used for request processing instead of GET.

A string that represents the HTTP request method, such as POST.

None

method=POST

locale

The locale that determines the format in which the Live SDK returns values. In particular:

  • Canonical folder names are translated to the language specified by the locale.

  • Profile data is returned in the format that is appropriate to the locale.

  • Contact data is returned in the format that is appropriate to the locale.

A culture name string from the table in Supported locales.

None

locale=es

return_ssl_resources

By default, the Live SDK uses Secure Hypertext Transfer Protocol (HTTPS) to refer to the resources it returns, such as the source URLs for Microsoft OneDrive items. This helps prevent web-browser warnings when an originating website also uses HTTPS.

Set this parameter to false if you don't want the returned resource to use HTTPS. When set to false, the returned resources will use HTTP.

true/false

true

return_ssl_resources=false

For example, the following URL makes a GET request for the user's contacts list, with the pretty parameter set to false.

https://apis.live.net/v5.0/me/contacts?pretty=false&access_token=ACCESS_TOKEN

See also

REST reference