D2lvalenceElixir.Utils.Service.get_classlist

You're seeing just the function get_classlist, go back to D2lvalenceElixir.Utils.Service module for more information.
Link to this function

get_classlist(user_context, org_unit_id, options \\ [])

View Source

Specs

get_classlist(
  %D2lvalenceElixir.Auth.D2LUserContext{
    anonymous: term(),
    app_id: term(),
    app_key: term(),
    encrypt_requests: term(),
    host: term(),
    scheme: term(),
    server_skew: term(),
    user_id: term(),
    user_key: term()
  },
  integer(),
  serializers: map(),
  ver: String.t(),
  body: list()
) ::
  {:error, String.t()}
  | {:ok,
     [
       %D2lvalenceElixir.Data.ClasslistUser{
         display_name: term(),
         email: term(),
         identifier: term(),
         org_defined_id: term(),
         profile_identifier: term(),
         user_name: term()
       }
     ]}

Get the classlist of an org unit id

Returns

{:error, cause} when an error is caused.

{:ok, list(%D2lvalenceElixir.Data.ClasslistUser{})} The result contains the information of the classlist.

Options

version: version of the component to verify. If not specified, will get the version of the component. serializers: Map of availaber serializers. application/json recommended. body: Options to pass to the body of the request.