2.2.3.1 Request Message Parameters

  • Article

The client can request specific information from the server through the HTTP GET method by appending one or more of the following parameters as a query string to the URL:

  • cid: The asset identifier of the category to browse or query. This parameter MUST only be specified for queries in which details about a category or file are sought.

  • lc: Specifies the locale in which the search is to be made. The value MUST be valid culture name as specified in [RFC4646]. Typically, the value is a combination of an ISO 639 two-letter lowercase culture code associated with a language (as specified in [ISO-639]) and an ISO 3166 two-letter uppercase subculture code associated with a country or region (as specified in [ISO-3166]).

  • tl: Integer specifying the provider category of the files to be returned. Possible values are described in the following table.

    Value

    Description

    1

    Only files that are provided by Microsoft Corporation.

    2

    Files that are provided by Microsoft Corporation and files provided by trusted community users.

    3

    Files that are provided by Microsoft Corporation, files provided by trusted community users and files provided by new community users that have not become trusted yet.

  • type: Integer specifying the type of the query. The value passed for this parameter MUST be one of those described in the following table.

    Value

    Description

    1

    Queries only the sub-categories in a given category.

    2

    Queries only the files (leaf nodes) in a given category.

    3

    Queries both the sub-categories and the files (leaf nodes) in a given category.

    5

    Queries only the root category.

  • max: Integer specifying the maximum number of files to be returned. The value MAY be specified to limit the number of files returned. The server MUST default to returning a maximum of 250 files if the value is not specified.

The same parameter MUST NOT be repeated in the client request. The server MUST treat all the parameters in the client request in a case-insensitive manner. That is, parameters differing only by case MUST be treated as identical.