Cyphi.Enrollments (Cyphi v0.1.0)
Provides API endpoints related to enrollments
Summary
Types
@type course_learner_crud_get_400_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_get_403_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_get_404_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_get_405_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_list_400_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_list_403_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_list_404_json_resp() :: %{message: String.t() | nil}
@type course_learner_crud_list_405_json_resp() :: %{message: String.t() | nil}
Functions
@spec course_learner_crud_get(id :: integer(), opts :: keyword()) :: {:ok, Cyphi.Learner.t()} | {:error, course_learner_crud_get_400_json_resp() | course_learner_crud_get_403_json_resp() | course_learner_crud_get_404_json_resp() | course_learner_crud_get_405_json_resp()}
Get learner
Return a course learner.
Options
$include: Comma separated list of relationships to include in the results, taken from this list: user, course, progress, enrolled_by, unenrolled_by, deactivated_by, reactivated_by, transferred_by, transferred_from, transferred_to, order_item.
@spec course_learner_crud_list(opts :: keyword()) :: {:ok, [Cyphi.Learner.t()]} | {:error, course_learner_crud_list_400_json_resp() | course_learner_crud_list_403_json_resp() | course_learner_crud_list_404_json_resp() | course_learner_crud_list_405_json_resp()}
List learners
Return a list of course learners.
Options
$after: Used for fast paging by setting the value to the last object id. This cannot be used with the $order parameter.$count: If true, just return the number of list items in the form {'count' : number}.$filter: Filter using JSON structure, with attributes taken from this list: user_id, course_id, id, enrolled_at, started, started_at, completed, completed_at, completed_by_id, unenrolled (default: false), unenrolled_at, deactivated, deactivated_at, reactivated_at, transferred, transferred_at, course_archived (default: false), user_archived (default: false), last_visited_at.$include: Comma separated list of relationships to include in the results, taken from this list: user, course, progress, enrolled_by, unenrolled_by, deactivated_by, reactivated_by, transferred_by, transferred_from, transferred_to, order_item.$limit: Limit the number of returned objects. The default is 10, the maximum is 100.$offset: Used for paging through a small dataset, and it can be used with the $order parameter. This cannot be used with the $after parameter.