Developer Platform (May 2017)

Locales

«  Configuration variables   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Permissions  »

Contents

The Locales actions let an organization manage the collection of locale properties available to users.

Attributes

Locales.Locale
{
    "LocaleId": <number:D2LID>,
    "LocaleName": <string>,
    "IsDefault": <boolean>,
    "CultureCode": <string>
}

Actions

GET /d2l/api/lp/(version)/locales/

Retrieve the collection of all known locales.

Parameters:
Query Parameters:
 
  • bookmark (string) – Optional. Bookmark to use for fetching the next data set segment.
Status Codes:
API Versions:
  • unstable – Route first appears with LMS v10.4.7.

Input. You can use a bookmark query parameter as a paging offset, to indicate that the service should return the segment of results immediately following your bookmark.

Return. This action returns a paged result set containing the resulting Locale data blocks for the segment following your bookmark parameter (or the first segment, if the parameter is empty or missing).

GET /d2l/api/lp/(version)/locales/(localeId)

Retrieve the properties for a particular locale.

Parameters:
  • version (D2LVERSION) – API version.
  • localeId – Locale ID.
Status Codes:
API Versions:
  • unstable – Route first appears with LMS v10.4.7.

Return. This action returns a Locale JSON block, containing information about the provided locale.

«  Configuration variables   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Permissions  »