request

Documentation

Index

• type AddAssessmentReqBody
• type AddAssessmentTypeIdParam
• type AddCourseReqBody
• type AddKeyReqBody
• type AddTaskReqBody
• type AssessmentByTemplateParam
• type AssessmentToAssessmentRelationParam
• type AssessmentTypeReqBody
• type AssignTaskReqBody
• type AttachmentParam
• type AttachmentReqBody
• type AttachmentsReqBody
• type BulkArchiveAssessmentsReqBody
• type ChecklistIdParam
• type ChecklistItemReqBody
• type ChecklistReqBody
• type ClassroomIdParam
• type CommentIdParam
• type CommentReqBody
• type CopyMoveAssessmentParam
• type CopyMoveCourseParam
• type CourseAclReqBody
• type CourseToAssessmentRelationParam
• type CourseToCourseRelationParam
• type CourseTypeReqBody
• type EventDateParam
• type GetAssessmentsParam
• type GetCoursesParam
• type GradingSystemIdParam
• type GradingSystemReqBody
• type KeyToAssessmentRelationParam
• type KeyToCourseRelationParam
• type KeyToKeyRelationParam
• type NoteIdParam
• type NoteReqBody
• type PublishGradesReqBody
• type ReorderChecklistItemsReqBody
• type ReorderChecklistsReqBody
• type ReorderTasksReqBody
• type ResetPasswordReqBody
• type ResourceAttributeReqBody
• type SignInReqBody
• type SignupReqBody
• type StandaloneEventReqBody
• type TaskIdParam
• type UpdateAssessmentDescReqBody
• type UpdateAssessmentReqBody
• type UpdateAssessmentStatusReqBody
• type UpdateGradeReqBody
• type UpdateTaskReqBody

Types

type AddAssessmentReqBody

type AddAssessmentReqBody struct {
	Name string `json:"assessmentName"`
}

type AddAssessmentTypeIdParam

type AddAssessmentTypeIdParam struct {
	AssessmentId     string
	AssessmentTypeId string
	KeyId            string
	CourseId         *string
}

type AddCourseReqBody

type AddCourseReqBody struct {
	Name string `json:"courseName"`
}

type AddKeyReqBody

type AddKeyReqBody struct {
	Type string `json:"keyType"`
	Name string `json:"keyName"`
}

type AddTaskReqBody

type AddTaskReqBody struct {
	Name string `json:"taskName"`
}

type AssessmentByTemplateParam

type AssessmentByTemplateParam struct {
	KeyId        string
	CourseId     *string
	TemplateId   string
	ExcludeTasks bool
}

type AssessmentToAssessmentRelationParam

type AssessmentToAssessmentRelationParam struct {
	AssessmentId   string
	SourceKeyId    string
	SourceCourseId string

	TargetAssessmentId string
	TargetKeyId        string
	TargetCourseId     string
}

type AssessmentTypeReqBody

type AssessmentTypeReqBody struct {
	Name string `json:"assessmentTypeName"`
}

type AssignTaskReqBody

type AssignTaskReqBody struct {
	UserIds string `json:"userIds"`
}

type AttachmentParam

type AttachmentParam struct {
	AttachmentId *string
	KeyId        string
	CourseId     *string
	AssessmentId *string
}

type AttachmentReqBody

type AttachmentReqBody struct {
	FileName string  `json:"fileName"`
	FileUrl  *string `json:"fileUrl"`
}

type AttachmentsReqBody

type AttachmentsReqBody struct {
	Attachments []AttachmentReqBody `json:"files"`
}

type BulkArchiveAssessmentsReqBody

type BulkArchiveAssessmentsReqBody struct {
	AssessmentIds string `json:"assessmentIds"`
}

type ChecklistIdParam

type ChecklistIdParam struct {
	KeyId           string
	CourseId        *string
	AssessmentId    *string
	ChecklistId     *string
	ChecklistItemId *string
}

type ChecklistItemReqBody

type ChecklistItemReqBody struct {
	Title         string  `json:"title"`
	Completed     *bool   `json:"completed"`
	TaggedUserIds *string `json:"taggedUserIds"`
}

type ChecklistReqBody

type ChecklistReqBody struct {
	Title string `json:"title"`
}

type ClassroomIdParam

type ClassroomIdParam struct {
	StudentId   string
	ResourceIds common.ResourceIdParam
}

type CommentIdParam

type CommentIdParam struct {
	KeyId        string
	CourseId     *string
	AssessmentId *string
	CommentId    *string
}

type CommentReqBody

type CommentReqBody struct {
	CommentText   string  `json:"commentText"`
	TaggedUserIds *string `json:"taggedUserIds"`
}

type CopyMoveAssessmentParam

type CopyMoveAssessmentParam struct {
	AssessmentId string
	KeyId        string
	TargetKeyId  string

	CourseId       string
	TargetCourseId string

	AllTasks      bool
	AllChecklists bool
}

type CopyMoveCourseParam

type CopyMoveCourseParam struct {
	CourseId    string
	KeyId       string
	TargetKeyId string

	AssessmentIds  []string
	AllAssessments bool
	AllTasks       bool
	AllChecklists  bool
}

type CourseAclReqBody

type CourseAclReqBody struct {
	Acl string `json:"courseAcl"`
}

type CourseToAssessmentRelationParam

type CourseToAssessmentRelationParam struct {
	CourseId string

	TargetAssessmentId string
	TargetKeyId        string
	TargetCourseId     string
}

type CourseToCourseRelationParam

type CourseToCourseRelationParam struct {
	CourseId       string
	TargetCourseId string
}

type CourseTypeReqBody

type CourseTypeReqBody struct {
	Name string `json:"courseTypeName"`
}

type EventDateParam

type EventDateParam struct {
	StartDate string
	EndDate   *string
}

type GetAssessmentsParam

type GetAssessmentsParam struct {
	KeyId      string
	CourseId   *string
	BatchIndex int
}

type GetCoursesParam

type GetCoursesParam struct {
	KeyId            string
	BatchIndex       int
	WriteOrHigherAcl bool
	Filter           string
}

type GradingSystemIdParam

type GradingSystemIdParam struct {
	GradingSystemId string
	KeyId           string
	CourseId        *string
	AssessmentId    *string
}

type GradingSystemReqBody

type GradingSystemReqBody struct {
	Name   string   `json:"gradingSystemName"`
	Type   string   `json:"gradingSystemType"`
	Grades []string `json:"grades"`
}

type KeyToAssessmentRelationParam

type KeyToAssessmentRelationParam struct {
	KeyId string

	TargetAssessmentId string
	TargetKeyId        string
	TargetCourseId     string
}

type KeyToCourseRelationParam

type KeyToCourseRelationParam struct {
	KeyId          string
	TargetCourseId string
}

type KeyToKeyRelationParam

type KeyToKeyRelationParam struct {
	KeyId       string
	TargetKeyId string
}

type NoteIdParam

type NoteIdParam struct {
	KeyId        string
	CourseId     *string
	AssessmentId *string
	NoteId       *string
}

type NoteReqBody

type NoteReqBody struct {
	NoteText string `json:"noteText"`
}

type PublishGradesReqBody

type PublishGradesReqBody struct {
	StudentUserIds string `json:"studentUserIds"`
}

type ReorderChecklistItemsReqBody

type ReorderChecklistItemsReqBody struct {
	ChecklistItemIds string `json:"checklistItemIds"`
}

type ReorderChecklistsReqBody

type ReorderChecklistsReqBody struct {
	ChecklistIds string `json:"checklistIds"`
}

type ReorderTasksReqBody

type ReorderTasksReqBody struct {
	TaskIds string `json:"taskIds"`
}

type ResetPasswordReqBody

type ResetPasswordReqBody struct {
	Password        string `json:"password"`
	ConfirmPassword string `json:"confirmPassword"`
}

type ResourceAttributeReqBody

type ResourceAttributeReqBody struct {
	AttributeNames string `json:"attributeNames"`
	ShowAttribute  bool   `json:"showAttribute"`
}

type SignInReqBody

type SignInReqBody struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type SignupReqBody

type SignupReqBody struct {
	Email           string `json:"email"`
	Password        string `json:"password"`
	ConfirmPassword string `json:"confirmPassword"`
}

type StandaloneEventReqBody

type StandaloneEventReqBody struct {
	Description *string `json:"description"`
	StartTime   *string `json:"eventStartTime"`
	EndTime     *string `json:"eventEndTime"`
}

type TaskIdParam

type TaskIdParam struct {
	KeyId        string
	CourseId     *string
	AssessmentId *string
	TaskId       *string
}

type UpdateAssessmentDescReqBody

type UpdateAssessmentDescReqBody struct {
	Description   string  `json:"assessmentDescription"`
	TaggedUserIds *string `json:"taggedUserIds"`
}

type UpdateAssessmentReqBody

type UpdateAssessmentReqBody struct {
	Name              *string `json:"assessmentName"`
	SimpleDescription *string `json:"simpleDescription"`
	DueDate           *string `json:"assessmentDueDate"`
	Color             *string `json:"assessmentColor"`
	Tags              *string `json:"assessmentTags"`
	KanbanMode        *bool   `json:"kanbanMode"`
}

type UpdateAssessmentStatusReqBody

type UpdateAssessmentStatusReqBody struct {
	Completed bool `json:"assessmentCompleted"`
}

type UpdateGradeReqBody

type UpdateGradeReqBody struct {
	Grade string `json:"grade"`
}

type UpdateTaskReqBody

type UpdateTaskReqBody struct {
	Name      *string `json:"taskName"`
	DueDate   *string `json:"dueDate"`
	Completed *bool   `json:"isCompleted"`
}