@spec assessment_grade_crud_create(
  id :: integer(),
  assessment_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Grade.t()}
  | {:error,
     assessment_grade_crud_create_400_json_resp()
     | assessment_grade_crud_create_403_json_resp()
     | assessment_grade_crud_create_404_json_resp()
     | assessment_grade_crud_create_405_json_resp()}

Create assessment grade

Create a grade for the provided user for this assessment. You must provide exactly one of percent, score, or grade.

Request Body

Content Types: application/json

Here is the format of a request.

@spec assessment_grade_crud_create_batch(
  id :: integer(),
  assessment_id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, assessment_grade_crud_create_batch_202_json_resp()}
  | {:error,
     assessment_grade_crud_create_batch_400_json_resp()
     | assessment_grade_crud_create_batch_403_json_resp()
     | assessment_grade_crud_create_batch_404_json_resp()
     | assessment_grade_crud_create_batch_405_json_resp()}

Create assessment grades

Create grades for the provided users for this assessment. For each entry, you must provide exactly one of percent, score, or grade.

Request Body

Content Types: application/json

Here is the format of a request.

@spec assessment_grade_crud_delete(
  id :: integer(),
  assessment_id :: integer(),
  grade_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     assessment_grade_crud_delete_400_json_resp()
     | assessment_grade_crud_delete_403_json_resp()
     | assessment_grade_crud_delete_404_json_resp()
     | assessment_grade_crud_delete_405_json_resp()}

Delete an assessment's grade

Delete a assessment's grade.

@spec assessment_grade_crud_get(
  id :: integer(),
  assessment_id :: integer(),
  grade_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Grade.t()}
  | {:error,
     assessment_grade_crud_get_400_json_resp()
     | assessment_grade_crud_get_403_json_resp()
     | assessment_grade_crud_get_404_json_resp()
     | assessment_grade_crud_get_405_json_resp()}

Get an assessment's grade

Get an assessment's grade

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: user, grader, assessment, course.

@spec assessment_grade_crud_list(
  id :: integer(),
  assessment_id :: integer(),
  opts :: keyword()
) ::
  {:ok, [Cyphi.Grade.t()]}
  | {:error,
     assessment_grade_crud_list_400_json_resp()
     | assessment_grade_crud_list_403_json_resp()
     | assessment_grade_crud_list_404_json_resp()
     | assessment_grade_crud_list_405_json_resp()}

List an assessment's grades

List all the grades for the assessment. All of the grades are now displayed.

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, id, assessment_id, course_id.
• $include: Comma separated list of relationships to include in the results, taken from this list: user, grader, assessment, course.
• $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.

@spec assessment_grade_crud_update(
  id :: integer(),
  assessment_id :: integer(),
  grade_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Grade.t()}
  | {:error,
     assessment_grade_crud_update_400_json_resp()
     | assessment_grade_crud_update_403_json_resp()
     | assessment_grade_crud_update_404_json_resp()
     | assessment_grade_crud_update_405_json_resp()}

Update an assessment's grade

Update the grade with the provided ID. If provided, you must provide exactly one of percent, score, or grade.

Request Body

Content Types: application/json

Here is the format of a request.

@spec assessment_grade_crud_update_batch(
  id :: integer(),
  assessment_id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, assessment_grade_crud_update_batch_202_json_resp()}
  | {:error,
     assessment_grade_crud_update_batch_400_json_resp()
     | assessment_grade_crud_update_batch_403_json_resp()
     | assessment_grade_crud_update_batch_404_json_resp()
     | assessment_grade_crud_update_batch_405_json_resp()}

Update assessment grades

Update grades with the provided IDs. If provided, you must provide exactly one of percent, score, or grade for each entry.

Request Body

Content Types: application/json

Here is the format of a request.

@spec assessment_result_crud_get(
  id :: integer(),
  assessment_id :: integer(),
  id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Answer.t()}
  | {:error,
     assessment_result_crud_get_400_json_resp()
     | assessment_result_crud_get_403_json_resp()
     | assessment_result_crud_get_404_json_resp()
     | assessment_result_crud_get_405_json_resp()}

Get a assessment's result

Return a assessment's result.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: grade, question, user.

@spec assessment_result_crud_list(
  id :: integer(),
  assessment_id :: integer(),
  opts :: keyword()
) ::
  {:ok, [Cyphi.Answer.t()]}
  | {:error,
     assessment_result_crud_list_400_json_resp()
     | assessment_result_crud_list_403_json_resp()
     | assessment_result_crud_list_404_json_resp()
     | assessment_result_crud_list_405_json_resp()}

List assessment results

Return a list of assessment results.

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: id, user_id, position.
• $include: Comma separated list of relationships to include in the results, taken from this list: grade, question, user.
• $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.

@spec assessment_scorm_result_crud_get(
  id :: integer(),
  assessment_id :: integer(),
  id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.ScormAnswer.t()}
  | {:error,
     assessment_scorm_result_crud_get_400_json_resp()
     | assessment_scorm_result_crud_get_403_json_resp()
     | assessment_scorm_result_crud_get_404_json_resp()
     | assessment_scorm_result_crud_get_405_json_resp()}

Get a assessment's scorm result

Return a assessment's scorm result.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: grade, user.

@spec assessment_scorm_result_crud_list(
  id :: integer(),
  assessment_id :: integer(),
  opts :: keyword()
) ::
  {:ok, [Cyphi.ScormAnswer.t()]}
  | {:error,
     assessment_scorm_result_crud_list_400_json_resp()
     | assessment_scorm_result_crud_list_403_json_resp()
     | assessment_scorm_result_crud_list_404_json_resp()
     | assessment_scorm_result_crud_list_405_json_resp()}

List assessment scorm results

Return a list of assessment scorm results.

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: id, user_id, position.
• $include: Comma separated list of relationships to include in the results, taken from this list: grade, user.
• $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.

@spec attendance_session_user_attendance_crud_create(
  id :: integer(),
  attendance_session_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.UserAttendance.t()}
  | {:error,
     attendance_session_user_attendance_crud_create_400_json_resp()
     | attendance_session_user_attendance_crud_create_403_json_resp()
     | attendance_session_user_attendance_crud_create_404_json_resp()
     | attendance_session_user_attendance_crud_create_405_json_resp()}

Create attendance record

Create one attendance entry.

Request Body

Content Types: application/json

Here is the format of a request.

@spec attendance_session_user_attendance_crud_create_batch(
  id :: integer(),
  attendance_session_id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, attendance_session_user_attendance_crud_create_batch_202_json_resp()}
  | {:error,
     attendance_session_user_attendance_crud_create_batch_400_json_resp()
     | attendance_session_user_attendance_crud_create_batch_403_json_resp()
     | attendance_session_user_attendance_crud_create_batch_404_json_resp()
     | attendance_session_user_attendance_crud_create_batch_405_json_resp()}

Create attendance records

Create one or more attendance entries.

Request Body

Content Types: application/json

Here is the format of a request.

@spec attendance_session_user_attendance_crud_delete(
  id :: integer(),
  attendance_session_id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     attendance_session_user_attendance_crud_delete_400_json_resp()
     | attendance_session_user_attendance_crud_delete_403_json_resp()
     | attendance_session_user_attendance_crud_delete_404_json_resp()
     | attendance_session_user_attendance_crud_delete_405_json_resp()}

Delete attendance record

Delete one attendance entry.

@spec attendance_session_user_attendance_crud_get(
  id :: integer(),
  attendance_session_id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.UserAttendance.t()}
  | {:error,
     attendance_session_user_attendance_crud_get_400_json_resp()
     | attendance_session_user_attendance_crud_get_403_json_resp()
     | attendance_session_user_attendance_crud_get_404_json_resp()
     | attendance_session_user_attendance_crud_get_405_json_resp()}

Get attendance record

Get attendance entry for one user.

@spec attendance_session_user_attendance_crud_list(
  id :: integer(),
  attendance_session_id :: integer(),
  opts :: keyword()
) ::
  {:ok, [Cyphi.UserAttendance.t()]}
  | {:error,
     attendance_session_user_attendance_crud_list_400_json_resp()
     | attendance_session_user_attendance_crud_list_403_json_resp()
     | attendance_session_user_attendance_crud_list_404_json_resp()
     | attendance_session_user_attendance_crud_list_405_json_resp()}

List attendance records

List all attendance for one session.

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: id, user_id.
• $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.

@spec attendance_session_user_attendance_crud_update(
  id :: integer(),
  attendance_session_id :: integer(),
  user_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.UserAttendance.t()}
  | {:error,
     attendance_session_user_attendance_crud_update_400_json_resp()
     | attendance_session_user_attendance_crud_update_403_json_resp()
     | attendance_session_user_attendance_crud_update_404_json_resp()
     | attendance_session_user_attendance_crud_update_405_json_resp()}

Update attendance record

Update one attendance entry.

Request Body

Content Types: application/json

Here is the format of a request.

@spec attendance_session_user_attendance_crud_update_batch(
  id :: integer(),
  attendance_session_id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, attendance_session_user_attendance_crud_update_batch_202_json_resp()}
  | {:error,
     attendance_session_user_attendance_crud_update_batch_400_json_resp()
     | attendance_session_user_attendance_crud_update_batch_403_json_resp()
     | attendance_session_user_attendance_crud_update_batch_404_json_resp()
     | attendance_session_user_attendance_crud_update_batch_405_json_resp()}

Update attendance records

Update one or more attendance entries.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_assessment_crud_get(
  id :: integer(),
  assessment_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Assessment.t()}
  | {:error,
     course_assessment_crud_get_400_json_resp()
     | course_assessment_crud_get_403_json_resp()
     | course_assessment_crud_get_404_json_resp()
     | course_assessment_crud_get_405_json_resp()}

Get course assessment

Return the assessment with the specified ID.

@spec course_assessment_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Assessment.t()]}
  | {:error,
     course_assessment_crud_list_400_json_resp()
     | course_assessment_crud_list_403_json_resp()
     | course_assessment_crud_list_404_json_resp()
     | course_assessment_crud_list_405_json_resp()}

List course assessments

Return a list of the course's assessments.

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: id, course_id, given, grading.
• $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.

@spec course_assistant_crud_create(id :: integer(), body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.Assistant.t()}
  | {:error,
     course_assistant_crud_create_400_json_resp()
     | course_assistant_crud_create_403_json_resp()
     | course_assistant_crud_create_404_json_resp()
     | course_assistant_crud_create_405_json_resp()}

Add course assistant

Add a course assistant.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_assistant_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_assistant_crud_create_batch_202_json_resp()}
  | {:error,
     course_assistant_crud_create_batch_400_json_resp()
     | course_assistant_crud_create_batch_403_json_resp()
     | course_assistant_crud_create_batch_404_json_resp()
     | course_assistant_crud_create_batch_405_json_resp()}

Add course assistants

Add up to 100 course assistants using a batch job.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_assistant_crud_delete(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     course_assistant_crud_delete_400_json_resp()
     | course_assistant_crud_delete_403_json_resp()
     | course_assistant_crud_delete_404_json_resp()
     | course_assistant_crud_delete_405_json_resp()}

Remove course assistant

Remove the specified assistant from the course.

@spec course_assistant_crud_get(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Assistant.t()}
  | {:error,
     course_assistant_crud_get_400_json_resp()
     | course_assistant_crud_get_403_json_resp()
     | course_assistant_crud_get_404_json_resp()
     | course_assistant_crud_get_405_json_resp()}

Get course assistant

Return the assistant record for the specified user. Note that this does not return the user object, although you can use $include=user if you want to get the user object as well

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: user, course.

@spec course_assistant_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Assistant.t()]}
  | {:error,
     course_assistant_crud_list_400_json_resp()
     | course_assistant_crud_list_403_json_resp()
     | course_assistant_crud_list_404_json_resp()
     | course_assistant_crud_list_405_json_resp()}

List course assistants

Return a list of the course assistants. Note that this does not return user objects, it returns assistant records that include the user_id. You can use $include=user if you want to get the user object as well. Assistant records are not returned for users that are archived.

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.
• $include: Comma separated list of relationships to include in the results, taken from this list: user, course.
• $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.

@spec course_attendance_session_crud_create(
  id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.AttendanceSession.t()}
  | {:error,
     course_attendance_session_crud_create_400_json_resp()
     | course_attendance_session_crud_create_403_json_resp()
     | course_attendance_session_crud_create_404_json_resp()
     | course_attendance_session_crud_create_405_json_resp()}

Create attendance session

Create and attendance session in this course.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_attendance_session_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_attendance_session_crud_create_batch_202_json_resp()}
  | {:error,
     course_attendance_session_crud_create_batch_400_json_resp()
     | course_attendance_session_crud_create_batch_403_json_resp()
     | course_attendance_session_crud_create_batch_404_json_resp()
     | course_attendance_session_crud_create_batch_405_json_resp()}

Create attendance sessions

Create one or more attendance sessions in this course in batch.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_attendance_session_crud_delete(
  id :: integer(),
  attendance_session_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     course_attendance_session_crud_delete_400_json_resp()
     | course_attendance_session_crud_delete_403_json_resp()
     | course_attendance_session_crud_delete_404_json_resp()
     | course_attendance_session_crud_delete_405_json_resp()}

Delete attendance session

Delete an attendance session in this course.

@spec course_attendance_session_crud_get(
  id :: integer(),
  attendance_session_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.AttendanceSession.t()}
  | {:error,
     course_attendance_session_crud_get_400_json_resp()
     | course_attendance_session_crud_get_403_json_resp()
     | course_attendance_session_crud_get_404_json_resp()
     | course_attendance_session_crud_get_405_json_resp()}

Get attendance session

Get an attendance session from this course.

@spec course_attendance_session_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.AttendanceSession.t()]}
  | {:error,
     course_attendance_session_crud_list_400_json_resp()
     | course_attendance_session_crud_list_403_json_resp()
     | course_attendance_session_crud_list_404_json_resp()
     | course_attendance_session_crud_list_405_json_resp()}

List attendance sessions

Return a list of course attendance sessions.

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: id, started_at, finished_at.
• $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.
• $order: Comma separated attribute names to sort by, taken from this list: id. Add :desc to the end of an attribute name for descending order. This cannot be used with the $after parameter.

@spec course_attendance_session_crud_update(
  id :: integer(),
  attendance_session_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.AttendanceSession.t()}
  | {:error,
     course_attendance_session_crud_update_400_json_resp()
     | course_attendance_session_crud_update_403_json_resp()
     | course_attendance_session_crud_update_404_json_resp()
     | course_attendance_session_crud_update_405_json_resp()}

Update attendance session

Update and attendance session in this course.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_attendance_session_crud_update_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_attendance_session_crud_update_batch_202_json_resp()}
  | {:error,
     course_attendance_session_crud_update_batch_400_json_resp()
     | course_attendance_session_crud_update_batch_403_json_resp()
     | course_attendance_session_crud_update_batch_404_json_resp()
     | course_attendance_session_crud_update_batch_405_json_resp()}

Update attendance sessions

Update one or more attendance sessions in this course in batch.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_child_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_child_crud_create_batch_202_json_resp()}
  | {:error,
     course_child_crud_create_batch_400_json_resp()
     | course_child_crud_create_batch_403_json_resp()
     | course_child_crud_create_batch_404_json_resp()
     | course_child_crud_create_batch_405_json_resp()}

Create course children

Create up to 50 children of the specified course using a batch job.

Options

• $options: Valid options are: deep_copy

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_child_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Course.t()]}
  | {:error,
     course_child_crud_list_400_json_resp()
     | course_child_crud_list_403_json_resp()
     | course_child_crud_list_404_json_resp()
     | course_child_crud_list_405_json_resp()}

List course children

Return a list of the children of the course with the specified ID .

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: archived (default: false), organization_id, id, name, course_code, sis_id, sis_pid, path, tags, metadata.creator_id, metadata.created_at, metadata.language.
• $include: Comma separated list of relationships to include in the results, taken from this list: parent, current_module, organization.
• $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.
• $order: Comma separated attribute names to sort by, taken from this list: id, name. Add :desc to the end of an attribute name for descending order. This cannot be used with the $after parameter.

@spec course_copy(id :: integer(), body :: [map()], opts :: keyword()) ::
  {:ok, course_copy_202_json_resp()}
  | {:error,
     course_copy_400_json_resp()
     | course_copy_403_json_resp()
     | course_copy_404_json_resp()
     | course_copy_405_json_resp()}

Copy course

Create one or more copies of the specified course using a batch job.

Options

• $options: Valid options are: deep_copy

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_crud_create(body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.Course.t()}
  | {:error,
     course_crud_create_400_json_resp()
     | course_crud_create_403_json_resp()
     | course_crud_create_404_json_resp()
     | course_crud_create_405_json_resp()}

Create course

Create a course.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_crud_create_batch(body :: [map()], opts :: keyword()) ::
  {:ok, course_crud_create_batch_202_json_resp()}
  | {:error,
     course_crud_create_batch_400_json_resp()
     | course_crud_create_batch_403_json_resp()
     | course_crud_create_batch_404_json_resp()
     | course_crud_create_batch_405_json_resp()}

Create courses

Create up to 50 courses using a batch job.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_crud_delete(id :: integer(), opts :: keyword()) ::
  :ok
  | {:error,
     course_crud_delete_400_json_resp()
     | course_crud_delete_403_json_resp()
     | course_crud_delete_404_json_resp()
     | course_crud_delete_405_json_resp()}

Delete course

Delete the course with the specified ID. This places the course into your trash can where it will be permanently deleted after 30 days. You can restore it from the trash at anytime before the 30 days are up.

@spec course_crud_get(id :: integer(), opts :: keyword()) ::
  {:ok, Cyphi.Course.t()}
  | {:error,
     course_crud_get_400_json_resp()
     | course_crud_get_403_json_resp()
     | course_crud_get_404_json_resp()
     | course_crud_get_405_json_resp()}

Get course

Return the course with the specified ID.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: parent, current_module, organization.

@spec course_crud_list(opts :: keyword()) ::
  {:ok, [Cyphi.Course.t()]}
  | {:error,
     course_crud_list_400_json_resp()
     | course_crud_list_403_json_resp()
     | course_crud_list_404_json_resp()
     | course_crud_list_405_json_resp()}

List courses

Return a list of courses. By default, archived courses are not returned, and you can use the filter archived=true if you want to get a list of archived courses.

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: archived (default: false), organization_id, id, name, course_code, sis_id, sis_pid, path, tags, metadata.creator_id, metadata.created_at, metadata.language.
• $include: Comma separated list of relationships to include in the results, taken from this list: parent, current_module, organization.
• $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.
• $order: Comma separated attribute names to sort by, taken from this list: id, name. Add :desc to the end of an attribute name for descending order. This cannot be used with the $after parameter.

@spec course_crud_update(id :: integer(), body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.Course.t()}
  | {:error,
     course_crud_update_400_json_resp()
     | course_crud_update_403_json_resp()
     | course_crud_update_404_json_resp()
     | course_crud_update_405_json_resp()}

Update course

Update the course with the specified ID. Note that to archive/unarchive a course, you can simply update its archived attribute.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_crud_update_batch(body :: [map()], opts :: keyword()) ::
  {:ok, course_crud_update_batch_202_json_resp()}
  | {:error,
     course_crud_update_batch_400_json_resp()
     | course_crud_update_batch_403_json_resp()
     | course_crud_update_batch_404_json_resp()
     | course_crud_update_batch_405_json_resp()}

Update courses

Update up to 50 courses using a batch job. Note that to archive/unarchive a course, you can simply update its archived attribute.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_group_crud_get(id :: integer(), group_id :: integer(), opts :: keyword()) ::
  {:ok, Cyphi.Group.t()}
  | {:error,
     course_group_crud_get_400_json_resp()
     | course_group_crud_get_403_json_resp()
     | course_group_crud_get_404_json_resp()
     | course_group_crud_get_405_json_resp()}

Get course group

Return a course's group.

@spec course_group_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Group.t()]}
  | {:error,
     course_group_crud_list_400_json_resp()
     | course_group_crud_list_403_json_resp()
     | course_group_crud_list_404_json_resp()
     | course_group_crud_list_405_json_resp()}

List course groups

Return a list of course groups.

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: id, name, visibility, tags, container_type, metadata.creator_id, metadata.created_at, metadata.language.
• $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.
• $order: Comma separated attribute names to sort by, taken from this list: id, name. Add :desc to the end of an attribute name for descending order. This cannot be used with the $after parameter.

@spec course_instructor_crud_create(id :: integer(), body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.Instructor.t()}
  | {:error,
     course_instructor_crud_create_400_json_resp()
     | course_instructor_crud_create_403_json_resp()
     | course_instructor_crud_create_404_json_resp()
     | course_instructor_crud_create_405_json_resp()}

Add course instructor

Add a course instructor.

By default, a user is not notified that they have been added as an instructor to the course. If you want them to receive a notification, set the optional send_notification parameter to true. For example: POST /courses/27/instructors?send_notification=true {user_id: 46688}

Options

• $options: Valid options are: send_notification

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_instructor_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_instructor_crud_create_batch_202_json_resp()}
  | {:error,
     course_instructor_crud_create_batch_400_json_resp()
     | course_instructor_crud_create_batch_403_json_resp()
     | course_instructor_crud_create_batch_404_json_resp()
     | course_instructor_crud_create_batch_405_json_resp()}

Add course instructors

Add up to 100 course instructors using a batch job.

By default, a user is not notified that they have been added as an instructor to the course. If you want them to receive a notification, set the optional send_notification parameter to true. For example: POST /courses/27/instructors?send_notification=true {user_id: 46688}

Options

• $options: Valid options are: send_notification

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_instructor_crud_delete(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     course_instructor_crud_delete_400_json_resp()
     | course_instructor_crud_delete_403_json_resp()
     | course_instructor_crud_delete_404_json_resp()
     | course_instructor_crud_delete_405_json_resp()}

Remove course instructor

Remove the specified instructor from the course.

@spec course_instructor_crud_get(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Instructor.t()}
  | {:error,
     course_instructor_crud_get_400_json_resp()
     | course_instructor_crud_get_403_json_resp()
     | course_instructor_crud_get_404_json_resp()
     | course_instructor_crud_get_405_json_resp()}

Get course instructor

Return the instructor record for the specified user. Note that this does not return the user object, although you can use $include=user if you want to get the user object as well

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: user, course.

@spec course_instructor_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Instructor.t()]}
  | {:error,
     course_instructor_crud_list_400_json_resp()
     | course_instructor_crud_list_403_json_resp()
     | course_instructor_crud_list_404_json_resp()
     | course_instructor_crud_list_405_json_resp()}

List course instructors

Return a list of the course instructors. Note that this does not return user objects, it returns instructor records that include the user_id. You can use $include=user if you want to get the user object as well. Instructor records are not returned for users that are archived.

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, coinstructor.
• $include: Comma separated list of relationships to include in the results, taken from this list: user, course.
• $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.

@spec course_learner_crud_create(id :: integer(), body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.Learner.t()}
  | {:error,
     course_learner_crud_create_400_json_resp()
     | course_learner_crud_create_403_json_resp()
     | course_learner_crud_create_404_json_resp()
     | course_learner_crud_create_405_json_resp()}

Add course learner

Add a course learner.

By default, a user is not notified that they have been added as a learner to the course and you are not allowed to re-enroll existing students. If you want them to receive a notification, set the optional send_notification parameter to true.

The default behavior can be changed by passing these options:

• send_notification (boolean): notify the user that they have been enrolled
• reenroll (string):
  • never: default value, re-enrolling is not allowed
  • only_completed: allow re-enrolling students who have completed the course
  • always: allow re-enrolling of any student
• increment_seats (boolean): if true and no seats are remaining in the course, an additional seat is added to the course before enrolling the student. If seats are available, no change is made to the maximum number of seats.

Add the options as a JSON object to the $options parameter.

For example: POST /courses/27/learners?$options={“send_notification”:true,”reenroll”:”only_completed”,"increment_seats":true}

Options

• $options: Valid options are: send_notification, reenroll, increment_seats

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_learner_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_learner_crud_create_batch_202_json_resp()}
  | {:error,
     course_learner_crud_create_batch_400_json_resp()
     | course_learner_crud_create_batch_403_json_resp()
     | course_learner_crud_create_batch_404_json_resp()
     | course_learner_crud_create_batch_405_json_resp()}

Add course learners

Add up to 100 learners to the course using a batch job.

By default, a user is not notified that they have been added as a learner to the course and you are not allowed to re-enroll existing students. If you want them to receive a notification, set the optional send_notification parameter to true.

The default behavior can be changed by passing these options:

• send_notification (boolean): notify the user that they have been enrolled
• reenroll (string):
  • never: default value, re-enrolling is not allowed
  • only_completed: allow re-enrolling students who have completed the course
  • always: allow re-enrolling of any student
• increment_seats (boolean): if true and no seats are remaining in the course, an additional seat is added to the course before enrolling the student. If seats are available, no change is made to the maximum number of seats.

Add the options as a JSON object to the $options parameter.

For example: POST /courses/27/learners?$options={“send_notification”:true,”reenroll”:”only_completed”,"increment_seats":true}

Options

• $options: Valid options are: send_notification, reenroll, increment_seats

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_learner_crud_delete(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     course_learner_crud_delete_400_json_resp()
     | course_learner_crud_delete_403_json_resp()
     | course_learner_crud_delete_404_json_resp()
     | course_learner_crud_delete_405_json_resp()}

Remove course learner

Remove the specified learner from the course.

@spec course_learner_crud_get(
  id :: integer(),
  user_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 course learner

Return the learner record for the specified user. Note that this does not return the user object, although you can use $include=user if you want to get the user object as well

Learner records are lightweight and include only information about the learner's enrollment status. If you want additional progress information such as the learner's current score percent, grade, percent progress, mastery percent and mastery classification, you can use $include=progress to include the Learner progress record.

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(id :: integer(), 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 course learners

Return a list of the course learners. Note that this does not return user objects, it returns their learner records that include the user_id. You can use $include=user if you want to get the user object as well. Learner records are not returned for users that are archived.

By default, this operation returns learners that are active, completed, or deactivated. It does not return learners that were unenrolled. You can use filters to return a specific set of learners based on their status. For example, /courses/ID/learners?$filter={"completed": true} will only return learners that have completed the course.

Learner records are lightweight and include only information about the learner's enrollment status. If you want additional progress information such as the learner's current score percent, grade, percent progress, mastery percent and mastery classification, you can use $include=progress to include the Learner progress record with each list item.

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.

@spec course_learner_crud_update(
  id :: integer(),
  user_id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Learner.t()}
  | {:error,
     course_learner_crud_update_400_json_resp()
     | course_learner_crud_update_403_json_resp()
     | course_learner_crud_update_404_json_resp()
     | course_learner_crud_update_405_json_resp()}

Update course learner

Update the course learner.

Note that to complete/deactivate/unenroll a learner, you can simply update the corresponding attribute. When one of these special attributes is changed, it starts a background job to perform the actual action, so it maybe be a minute or so before the change is reflected in the learner's status.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_learner_crud_update_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_learner_crud_update_batch_202_json_resp()}
  | {:error,
     course_learner_crud_update_batch_400_json_resp()
     | course_learner_crud_update_batch_403_json_resp()
     | course_learner_crud_update_batch_404_json_resp()
     | course_learner_crud_update_batch_405_json_resp()}

Update course learners

Update up to 100 course learners. Note that to complete/deactivate/unenroll a learner, you can simply update the corresponding attribute. When one of these special attributes is changed, it starts a background job to perform the actual action, so it maybe be a minute or so before the change is reflected in the learner's status.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_module_crud_get(
  id :: integer(),
  module_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Module.t()}
  | {:error,
     course_module_crud_get_400_json_resp()
     | course_module_crud_get_403_json_resp()
     | course_module_crud_get_404_json_resp()
     | course_module_crud_get_405_json_resp()}

Get module

Return a course's module.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: course.

@spec course_module_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Module.t()]}
  | {:error,
     course_module_crud_list_400_json_resp()
     | course_module_crud_list_403_json_resp()
     | course_module_crud_list_404_json_resp()
     | course_module_crud_list_405_json_resp()}

List modules

Return a list of course modules.

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: id, start_at, begin_at, end_at, course_id, tags.
• $include: Comma separated list of relationships to include in the results, taken from this list: course.
• $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.

@spec course_referencing_section_crud_get(
  id :: integer(),
  section_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Section.t()}
  | {:error,
     course_referencing_section_crud_get_400_json_resp()
     | course_referencing_section_crud_get_403_json_resp()
     | course_referencing_section_crud_get_404_json_resp()
     | course_referencing_section_crud_get_405_json_resp()}

Get course reference section

Get a course reference section by id.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.

@spec course_referencing_section_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Section.t()]}
  | {:error,
     course_referencing_section_crud_list_400_json_resp()
     | course_referencing_section_crud_list_403_json_resp()
     | course_referencing_section_crud_list_404_json_resp()
     | course_referencing_section_crud_list_405_json_resp()}

List course reference sections

List sections that reference this course inside paths.

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: id, type, module_id, referenced_course_id.
• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.
• $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.

@spec course_section_crud_get(
  id :: integer(),
  section_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Section.t()}
  | {:error,
     course_section_crud_get_400_json_resp()
     | course_section_crud_get_403_json_resp()
     | course_section_crud_get_404_json_resp()
     | course_section_crud_get_405_json_resp()}

Get course section

Get a course section by id.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.

@spec course_section_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Section.t()]}
  | {:error,
     course_section_crud_list_400_json_resp()
     | course_section_crud_list_403_json_resp()
     | course_section_crud_list_404_json_resp()
     | course_section_crud_list_405_json_resp()}

List course sections

All sections in a course. Can be filtered by type, for example you can only fetch ClassSection items.

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: id, type, module_id, referenced_course_id.
• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.
• $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.

@spec module_section_crud_get(
  id :: integer(),
  module_id :: integer(),
  section_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Section.t()}
  | {:error,
     module_section_crud_get_400_json_resp()
     | module_section_crud_get_403_json_resp()
     | module_section_crud_get_404_json_resp()
     | module_section_crud_get_405_json_resp()}

Get a module's section

Return a module's section.

Options

• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.

@spec module_section_crud_list(
  id :: integer(),
  module_id :: integer(),
  opts :: keyword()
) ::
  {:ok, [Cyphi.Section.t()]}
  | {:error,
     module_section_crud_list_400_json_resp()
     | module_section_crud_list_403_json_resp()
     | module_section_crud_list_404_json_resp()
     | module_section_crud_list_405_json_resp()}

List module sections

Return a list of module sections.

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: id, type, module_id, referenced_course_id.
• $include: Comma separated list of relationships to include in the results, taken from this list: module, referenced_course.
• $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.