@spec course_template_assessment_crud_get(
  id :: integer(),
  assessment_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Assessment.t()}
  | {:error,
     course_template_assessment_crud_get_400_json_resp()
     | course_template_assessment_crud_get_403_json_resp()
     | course_template_assessment_crud_get_404_json_resp()
     | course_template_assessment_crud_get_405_json_resp()}

Get course template assessment

Return the assessment with the specified ID.

@spec course_template_assessment_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Assessment.t()]}
  | {:error,
     course_template_assessment_crud_list_400_json_resp()
     | course_template_assessment_crud_list_403_json_resp()
     | course_template_assessment_crud_list_404_json_resp()
     | course_template_assessment_crud_list_405_json_resp()}

List course template assessments

Return a list of the course template'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_template_child_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_template_child_crud_create_batch_202_json_resp()}
  | {:error,
     course_template_child_crud_create_batch_400_json_resp()
     | course_template_child_crud_create_batch_403_json_resp()
     | course_template_child_crud_create_batch_404_json_resp()
     | course_template_child_crud_create_batch_405_json_resp()}

Add course template children

Create one or more course template children.

Options

• $options: Valid options are: deep_copy

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_child_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Course.t()]}
  | {:error,
     course_template_child_crud_list_400_json_resp()
     | course_template_child_crud_list_403_json_resp()
     | course_template_child_crud_list_404_json_resp()
     | course_template_child_crud_list_405_json_resp()}

List course template children

Return a list of course template children.

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_template_copy(id :: integer(), body :: [map()], opts :: keyword()) ::
  {:ok, course_template_copy_202_json_resp()}
  | {:error,
     course_template_copy_400_json_resp()
     | course_template_copy_403_json_resp()
     | course_template_copy_404_json_resp()
     | course_template_copy_405_json_resp()}

Copy course template

Create one or more copies of the specified course template.

Because this operation copies a course, which can take a while, it always operates in batch mode, and will return a batch ID that can be used to monitor the progress and get the final result of the operation.

Options

• $options: Valid options are: deep_copy

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_crud_create(body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.CourseTemplate.t()}
  | {:error,
     course_template_crud_create_400_json_resp()
     | course_template_crud_create_403_json_resp()
     | course_template_crud_create_404_json_resp()
     | course_template_crud_create_405_json_resp()}

Create course template

Create a course template.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_crud_create_batch(body :: [map()], opts :: keyword()) ::
  {:ok, course_template_crud_create_batch_202_json_resp()}
  | {:error,
     course_template_crud_create_batch_400_json_resp()
     | course_template_crud_create_batch_403_json_resp()
     | course_template_crud_create_batch_404_json_resp()
     | course_template_crud_create_batch_405_json_resp()}

Create course templates

Create up to 100 course templates using a batch job.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_crud_delete(id :: integer(), opts :: keyword()) ::
  :ok
  | {:error,
     course_template_crud_delete_400_json_resp()
     | course_template_crud_delete_403_json_resp()
     | course_template_crud_delete_404_json_resp()
     | course_template_crud_delete_405_json_resp()}

Delete course template

Delete the course template with the specified ID. This places the course template 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_template_crud_get(id :: integer(), opts :: keyword()) ::
  {:ok, Cyphi.CourseTemplate.t()}
  | {:error,
     course_template_crud_get_400_json_resp()
     | course_template_crud_get_403_json_resp()
     | course_template_crud_get_404_json_resp()
     | course_template_crud_get_405_json_resp()}

Get course template

Return the course template with the specified ID.

Options

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

@spec course_template_crud_list(opts :: keyword()) ::
  {:ok, [Cyphi.CourseTemplate.t()]}
  | {:error,
     course_template_crud_list_400_json_resp()
     | course_template_crud_list_403_json_resp()
     | course_template_crud_list_404_json_resp()
     | course_template_crud_list_405_json_resp()}

List course templates

Return a list of course templates.

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: 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: 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_template_crud_update(id :: integer(), body :: map(), opts :: keyword()) ::
  {:ok, Cyphi.CourseTemplate.t()}
  | {:error,
     course_template_crud_update_400_json_resp()
     | course_template_crud_update_403_json_resp()
     | course_template_crud_update_404_json_resp()
     | course_template_crud_update_405_json_resp()}

Update course template

Update the course template with the specified ID.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_crud_update_batch(body :: [map()], opts :: keyword()) ::
  {:ok, course_template_crud_update_batch_202_json_resp()}
  | {:error,
     course_template_crud_update_batch_400_json_resp()
     | course_template_crud_update_batch_403_json_resp()
     | course_template_crud_update_batch_404_json_resp()
     | course_template_crud_update_batch_405_json_resp()}

Update course templates

Update up to 100 course templates using a batch job.

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_group_crud_get(
  id :: integer(),
  group_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Group.t()}
  | {:error,
     course_template_group_crud_get_400_json_resp()
     | course_template_group_crud_get_403_json_resp()
     | course_template_group_crud_get_404_json_resp()
     | course_template_group_crud_get_405_json_resp()}

Get course template's group

Return a course template's group.

@spec course_template_group_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Group.t()]}
  | {:error,
     course_template_group_crud_list_400_json_resp()
     | course_template_group_crud_list_403_json_resp()
     | course_template_group_crud_list_404_json_resp()
     | course_template_group_crud_list_405_json_resp()}

List course template groups

Return a list of course template 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_template_instructor_crud_create(
  id :: integer(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Instructor.t()}
  | {:error,
     course_template_instructor_crud_create_400_json_resp()
     | course_template_instructor_crud_create_403_json_resp()
     | course_template_instructor_crud_create_404_json_resp()
     | course_template_instructor_crud_create_405_json_resp()}

Add course template instructor

Add a course instructor.

Options

• $options: Valid options are: send_notification

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_instructor_crud_create_batch(
  id :: integer(),
  body :: [map()],
  opts :: keyword()
) ::
  {:ok, course_template_instructor_crud_create_batch_202_json_resp()}
  | {:error,
     course_template_instructor_crud_create_batch_400_json_resp()
     | course_template_instructor_crud_create_batch_403_json_resp()
     | course_template_instructor_crud_create_batch_404_json_resp()
     | course_template_instructor_crud_create_batch_405_json_resp()}

Add course template instructors

Add up to 100 course instructors using a batch job.

Options

• $options: Valid options are: send_notification

Request Body

Content Types: application/json

Here is the format of a request.

@spec course_template_instructor_crud_delete(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     course_template_instructor_crud_delete_400_json_resp()
     | course_template_instructor_crud_delete_403_json_resp()
     | course_template_instructor_crud_delete_404_json_resp()
     | course_template_instructor_crud_delete_405_json_resp()}

Remove course template instructor

Remove the specified course instructor.

@spec course_template_instructor_crud_get(
  id :: integer(),
  user_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Instructor.t()}
  | {:error,
     course_template_instructor_crud_get_400_json_resp()
     | course_template_instructor_crud_get_403_json_resp()
     | course_template_instructor_crud_get_404_json_resp()
     | course_template_instructor_crud_get_405_json_resp()}

Get course template 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_template_instructor_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Instructor.t()]}
  | {:error,
     course_template_instructor_crud_list_400_json_resp()
     | course_template_instructor_crud_list_403_json_resp()
     | course_template_instructor_crud_list_404_json_resp()
     | course_template_instructor_crud_list_405_json_resp()}

List course template instructors

List the instructors in the course template. 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. It never returns instructor records 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_template_module_crud_get(
  id :: integer(),
  module_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Module.t()}
  | {:error,
     course_template_module_crud_get_400_json_resp()
     | course_template_module_crud_get_403_json_resp()
     | course_template_module_crud_get_404_json_resp()
     | course_template_module_crud_get_405_json_resp()}

Get course template's module

Return a course template's module.

Options

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

@spec course_template_module_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Module.t()]}
  | {:error,
     course_template_module_crud_list_400_json_resp()
     | course_template_module_crud_list_403_json_resp()
     | course_template_module_crud_list_404_json_resp()
     | course_template_module_crud_list_405_json_resp()}

List course template modules

Return a list of course template 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_template_section_crud_get(
  id :: integer(),
  section_id :: integer(),
  opts :: keyword()
) ::
  {:ok, Cyphi.Section.t()}
  | {:error,
     course_template_section_crud_get_400_json_resp()
     | course_template_section_crud_get_403_json_resp()
     | course_template_section_crud_get_404_json_resp()
     | course_template_section_crud_get_405_json_resp()}

Get a course template's section

Return a course template's section.

Options

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

@spec course_template_section_crud_list(id :: integer(), opts :: keyword()) ::
  {:ok, [Cyphi.Section.t()]}
  | {:error,
     course_template_section_crud_list_400_json_resp()
     | course_template_section_crud_list_403_json_resp()
     | course_template_section_crud_list_404_json_resp()
     | course_template_section_crud_list_405_json_resp()}

List course template sections

Return a list of course template 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.

@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.