Developer Platform (May 2017)

Settings for user accounts

«  Users (user data, whoami)   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Demographics (data types, fields, users and org units)  »

Contents

The settings actions let an organization manage the account settings available to users. We’ve divided this functionality into two, general groups:

Attributes

Settings.UpdateLocale

When updating a user’s account setting for preferred locale, pass a structure that looks like this one:

{
    "LocaleId": <number:D2LID>
}
LocaleId
System identifier for a particular Locale.

Actions

GET /d2l/api/lp/(version)/accountSettings/mySettings/locale/

Retrieve the current user’s locale account settings.

Parameters:
Status Codes:
  • 200 OK – Action succeeded.
  • 403 Forbidden – No permission to see current user’s preferred locale.
API Versions:
  • unstable – Route first appears with LMS v10.4.7.

Return. This action returns a Locale JSON block, containing information about the current user’s currently set locale.

GET /d2l/api/lp/(version)/accountSettings/(userId)/locale/

Retrieve the locale account settings for a particular user.

Parameters:
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 user’s currently set locale.

PUT /d2l/api/lp/(version)/accountSettings/mySettings/locale/

Update the current user’s locale account settings.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 OK – Action succeeded.
  • 403 Forbidden – No permission to set current user’s preferred locale.
API Versions:
  • unstable – Route first appears with LMS v10.4.7.
PUT /d2l/api/lp/(version)/accountSettings/(userId)/locale/

Update the locale account settings for a particular user.

Parameters:
JSON Parameters:
 
Status Codes:
API Versions:
  • unstable – Route first appears with LMS v10.4.7.

«  Users (user data, whoami)   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Demographics (data types, fields, users and org units)  »