courses

Documentation

Index

• func AddCourse(jwtToken string, reqBody request.AddCourseReqBody, keyId string) (response.Course, error)
• func AddCourseBasedOnTemplate(jwtToken string, reqBody request.AddCourseReqBody, ...) (response.Course, error)
• func AddCourseTypeToCourse(jwtToken string, assessmentParam AddCourseTypeIdParam) error
• func AddGradingSystemToCourse(jwtToken string, courseParam request.GradingSystemIdParam) error
• func AllowArchivalOfCourse(jwtToken string, reqBody common.AllowArchivalReqBody, ...) (response.Course, error)
• func ArchiveCourse(jwtToken string, courseParam common.ResourceIdParam) error
• func BulkArchiveCourses(jwtToken string, reqBody BulkArchiveCoursesReqBody, keyId string) error
• func CopyCourse(jwtToken string, courseParam request.CopyMoveCourseParam) (response.Course, error)
• func DeleteCourseTypeFromCourse(jwtToken string, courseParam common.ResourceIdParam) error
• func DeleteGradingSystemFromCourse(jwtToken string, courseParam common.ResourceIdParam) error
• func GetArchivedCourses(jwtToken string, coursesParam request.GetCoursesParam) ([]response.Course, error)
• func GetCourse(jwtToken string, courseParam common.ResourceIdParam) (response.Course, error)
• func GetCourses(jwtToken string, courseParam request.GetCoursesParam) ([]response.Course, error)
• func GetCoursesAvailableToBeLinkedToThisKey(jwtToken string, keyId string) ([]response.Course, error)
• func GetCoursesLinkedToAssessment(jwtToken string, courseParam common.ResourceIdParam) ([]response.Course, error)
• func LinkCourseToKey(jwtToken string, courseParam common.ResourceIdParam) error
• func MoveCourse(jwtToken string, courseParam request.CopyMoveCourseParam) error
• func UnarchiveCourse(jwtToken string, courseParam common.ResourceIdParam) error
• func UnlinkCourseFromKey(jwtToken string, courseParam common.ResourceIdParam) error
• func UpdateCourse(jwtToken string, reqBody UpdateCourseReqBody, ...) (response.Course, error)
• func UpdateCourseDescription(jwtToken string, reqBody UpdateCourseDescReqBody, ...) (response.Course, error)
• func UpdateCourseGrade(jwtToken string, reqBody request.UpdateGradeReqBody, ...) (response.UpdateCourseGrade, error)
• type AddCourseTypeIdParam
• type BulkArchiveCoursesReqBody
• type CourseByTemplateParam
• type UpdateCourseDescReqBody
• type UpdateCourseReqBody

Functions

func AddCourse

func AddCourse(jwtToken string, reqBody request.AddCourseReqBody, keyId string) (response.Course, error)

func AddCourseBasedOnTemplate

func AddCourseBasedOnTemplate(
	jwtToken string,
	reqBody request.AddCourseReqBody,
	courseParam CourseByTemplateParam,
) (response.Course, error)

func AddCourseTypeToCourse

func AddCourseTypeToCourse(jwtToken string, assessmentParam AddCourseTypeIdParam) error

func AddGradingSystemToCourse

func AddGradingSystemToCourse(jwtToken string, courseParam request.GradingSystemIdParam) error

func AllowArchivalOfCourse

func AllowArchivalOfCourse(
	jwtToken string,
	reqBody common.AllowArchivalReqBody,
	courseParam common.ResourceIdParam,
) (response.Course, error)

func ArchiveCourse

func ArchiveCourse(jwtToken string, courseParam common.ResourceIdParam) error

func BulkArchiveCourses

func BulkArchiveCourses(jwtToken string, reqBody BulkArchiveCoursesReqBody, keyId string) error

func CopyCourse

func CopyCourse(jwtToken string, courseParam request.CopyMoveCourseParam) (response.Course, error)

func DeleteCourseTypeFromCourse

func DeleteCourseTypeFromCourse(jwtToken string, courseParam common.ResourceIdParam) error

func DeleteGradingSystemFromCourse

func DeleteGradingSystemFromCourse(jwtToken string, courseParam common.ResourceIdParam) error

func GetArchivedCourses

func GetArchivedCourses(jwtToken string, coursesParam request.GetCoursesParam) ([]response.Course, error)

func GetCourse

func GetCourse(jwtToken string, courseParam common.ResourceIdParam) (response.Course, error)

func GetCourses

func GetCourses(jwtToken string, courseParam request.GetCoursesParam) ([]response.Course, error)

func GetCoursesAvailableToBeLinkedToThisKey

func GetCoursesAvailableToBeLinkedToThisKey(jwtToken string, keyId string) ([]response.Course, error)

func GetCoursesLinkedToAssessment

func GetCoursesLinkedToAssessment(jwtToken string, courseParam common.ResourceIdParam) ([]response.Course, error)

func LinkCourseToKey

func LinkCourseToKey(jwtToken string, courseParam common.ResourceIdParam) error

func MoveCourse

func MoveCourse(jwtToken string, courseParam request.CopyMoveCourseParam) error

func UnarchiveCourse

func UnarchiveCourse(jwtToken string, courseParam common.ResourceIdParam) error

func UnlinkCourseFromKey

func UnlinkCourseFromKey(jwtToken string, courseParam common.ResourceIdParam) error

func UpdateCourse

func UpdateCourse(jwtToken string, reqBody UpdateCourseReqBody, courseParam common.ResourceIdParam) (response.Course, error)

func UpdateCourseDescription

func UpdateCourseDescription(
	jwtToken string,
	reqBody UpdateCourseDescReqBody,
	assessmentParam common.ResourceIdParam,
) (response.Course, error)

func UpdateCourseGrade

func UpdateCourseGrade(
	jwtToken string,
	reqBody request.UpdateGradeReqBody,
	courseParam common.ResourceIdParam,
) (response.UpdateCourseGrade, error)

Types

type AddCourseTypeIdParam

type AddCourseTypeIdParam struct {
	KeyId        string
	CourseId     string
	CourseTypeId string
}

type BulkArchiveCoursesReqBody

type BulkArchiveCoursesReqBody struct {
	CourseIds string `json:"courseIds"`
}

type CourseByTemplateParam

type CourseByTemplateParam struct {
	KeyId              string
	TemplateId         string
	ExcludeAssessments bool
	ExcludeTasks       bool
}

type UpdateCourseDescReqBody

type UpdateCourseDescReqBody struct {
	Description   string  `json:"courseDescription"`
	TaggedUserIds *string `json:"taggedUserIds"`
}

type UpdateCourseReqBody

type UpdateCourseReqBody struct {
	Name              *string `json:"courseName"`
	CourseId          *string `json:"courseId"`
	SimpleDescription *string `json:"simpleDescription"`
	DueDate           *string `json:"courseDueDate"`
	StartTime         *string `json:"courseStartTime"`
	EndTime           *string `json:"courseEndTime"`
	Color             *string `json:"courseColor"`
	Tags              *string `json:"courseTags"`
	KanbanMode        *bool   `json:"kanbanMode"`
	Completed         bool    `json:"courseCompleted"`
}