\CourseAssignmentsAPIAPI

All URIs are relative to https://octopus.codio.com

Method	HTTP request	Description
AssignmentStudentsInfo	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/students	Get assignment students info
AssignmentVersionPublish	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/versions	Publish new assignment version
AssignmentVersionPublishesStatus	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/publishes/{taskId}	Get assignment publish status
CreateProjectBasedAssignment	Post /api/v1/courses/{courseId}/assignments	Create Project Based Assignment
FetchAssignmentSettings	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/settings	Fetch Assignment Settings
UpdateAssignmentSettings	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/settings	Update Assignment Settings
UpdateStudentTimeExtensions	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/students/{studentId}	Update Student Time Extensions

AssignmentStudentsInfo

[]StudentInformation AssignmentStudentsInfo(ctx, courseId, assignmentId).Execute()

Get assignment students info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.AssignmentStudentsInfo(context.Background(), courseId, assignmentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.AssignmentStudentsInfo``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AssignmentStudentsInfo`: []StudentInformation
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.AssignmentStudentsInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id

Other Parameters

Other parameters are passed through a pointer to a apiAssignmentStudentsInfoRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]StudentInformation

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AssignmentVersionPublish

TaskProgress AssignmentVersionPublish(ctx, courseId, assignmentId).File(file).Changelog(changelog).StackVersionId(stackVersionId).WithStackUpdate(withStackUpdate).Execute()

Publish new assignment version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id
	file := os.NewFile(1234, "some_file") // *os.File | File archive data to be published (optional)
	changelog := "changelog_example" // string | Publish changelog (optional)
	stackVersionId := "stackVersionId_example" // string | Stack version identification (optional)
	withStackUpdate := true // bool | Propagate stack update (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.AssignmentVersionPublish(context.Background(), courseId, assignmentId).File(file).Changelog(changelog).StackVersionId(stackVersionId).WithStackUpdate(withStackUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.AssignmentVersionPublish``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AssignmentVersionPublish`: TaskProgress
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.AssignmentVersionPublish`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id

Other Parameters

Other parameters are passed through a pointer to a apiAssignmentVersionPublishRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TaskProgress

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AssignmentVersionPublishesStatus

TaskStatus AssignmentVersionPublishesStatus(ctx, courseId, assignmentId, taskId).Execute()

Get assignment publish status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id
	taskId := "taskId_example" // string | Task id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.AssignmentVersionPublishesStatus(context.Background(), courseId, assignmentId, taskId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.AssignmentVersionPublishesStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AssignmentVersionPublishesStatus`: TaskStatus
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.AssignmentVersionPublishesStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id
taskId	string	Task id

Other Parameters

Other parameters are passed through a pointer to a apiAssignmentVersionPublishesStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TaskStatus

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateProjectBasedAssignment

CreateAssignmentAnswer CreateProjectBasedAssignment(ctx, courseId).CreateAssignment(createAssignment).Execute()

Create Project Based Assignment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	createAssignment := *openapiclient.NewCreateAssignment() // CreateAssignment |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.CreateProjectBasedAssignment(context.Background(), courseId).CreateAssignment(createAssignment).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.CreateProjectBasedAssignment``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateProjectBasedAssignment`: CreateAssignmentAnswer
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.CreateProjectBasedAssignment`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id

Other Parameters

Other parameters are passed through a pointer to a apiCreateProjectBasedAssignmentRequest struct via the builder pattern

Name	Type	Description	Notes

createAssignment | CreateAssignment | |

Return type

CreateAssignmentAnswer

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchAssignmentSettings

AssignmentSettingsResult FetchAssignmentSettings(ctx, courseId, assignmentId).Execute()

Fetch Assignment Settings

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.FetchAssignmentSettings(context.Background(), courseId, assignmentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.FetchAssignmentSettings``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `FetchAssignmentSettings`: AssignmentSettingsResult
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.FetchAssignmentSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id

Other Parameters

Other parameters are passed through a pointer to a apiFetchAssignmentSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AssignmentSettingsResult

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAssignmentSettings

AssignmentSettingsResult UpdateAssignmentSettings(ctx, courseId, assignmentId).AssignmentSettings(assignmentSettings).Execute()

Update Assignment Settings

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id
	assignmentSettings := *openapiclient.NewAssignmentSettings() // AssignmentSettings |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.UpdateAssignmentSettings(context.Background(), courseId, assignmentId).AssignmentSettings(assignmentSettings).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.UpdateAssignmentSettings``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateAssignmentSettings`: AssignmentSettingsResult
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.UpdateAssignmentSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAssignmentSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

assignmentSettings | AssignmentSettings | |

Return type

AssignmentSettingsResult

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateStudentTimeExtensions

string UpdateStudentTimeExtensions(ctx, courseId, assignmentId, studentId).StudentTimeExtension(studentTimeExtension).Execute()

Update Student Time Extensions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/codio/codio-api-go"
)

func main() {
	courseId := "courseId_example" // string | Course id
	assignmentId := "assignmentId_example" // string | Assignment id
	studentId := "studentId_example" // string | Student id
	studentTimeExtension := *openapiclient.NewStudentTimeExtension() // StudentTimeExtension |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CourseAssignmentsAPIAPI.UpdateStudentTimeExtensions(context.Background(), courseId, assignmentId, studentId).StudentTimeExtension(studentTimeExtension).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CourseAssignmentsAPIAPI.UpdateStudentTimeExtensions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateStudentTimeExtensions`: string
	fmt.Fprintf(os.Stdout, "Response from `CourseAssignmentsAPIAPI.UpdateStudentTimeExtensions`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
courseId	string	Course id
assignmentId	string	Assignment id
studentId	string	Student id

Other Parameters

Other parameters are passed through a pointer to a apiUpdateStudentTimeExtensionsRequest struct via the builder pattern

Name	Type	Description	Notes

studentTimeExtension | StudentTimeExtension | |

Return type

string

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

CourseAssignmentsAPIAPI.md

Latest commit

History

CourseAssignmentsAPIAPI.md

File metadata and controls

\CourseAssignmentsAPIAPI

AssignmentStudentsInfo

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AssignmentVersionPublish

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AssignmentVersionPublishesStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateProjectBasedAssignment

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

FetchAssignmentSettings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAssignmentSettings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateStudentTimeExtensions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers