Gradebook APIs (v1)

Download OpenAPI specification:Download

Support: team@hischool.world URL: https://github.com/hischoolmn Terms of Service

Introduction

Hischool Gradebook eliminates uncertainty about course progress and final grades. Instead of waiting, track your grades and manage your studies in real-time.

Quick Links:

Endpoints

Gradebook APIs Endpoints.

Server Health

Server Health for Gradebook APIs

Check Health

Authorizations:

Scopes

Responses

Response samples

Content type

application/json

{"server_name": "Gradebook APIs",
"server_version": "v1",
"server_status": "Active",
"server_description": "API Server for Hischool Gradebook"
}

Server Settings

Server Settings for Gradebook APIs

Get Server Settings

Get a server settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"default_locale": "en_US",
"default_timezone": "America/Los_Angeles",
"grading": {"default_grade_status": "draft",
"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"allow_custom_scheme": true
},
"gpa": {"enable_gpa": true,
"gpa_precision": 2
},
"audit_log": {"enable_audit_log": true,
"audit_log_retention_days": 365
},
"webhook": {"enable_webhooks": true,
"webhook_delivery_timeout": 30,
"webhook_delivery_retry_limit": 3,
"webhook_delivery_retry_interval": 60,
"webhook_delivery_max_payload_size": 1048576
}
}

Update Server Settings

Update a server settings. Updates all fields in a settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

default_locale	string (locale) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Supported Locales
default_timezone	string (timezone) Enum: "America/Los_Angeles" "Europe/Paris" Time zone. For example, Europe/Paris or America/Los_Angeles.
	object Grading Settings
	object GPA Settings
	object Audit Log Settings
	object Webhook Settings

Responses

Request samples

Payload

Content type

application/json

{"default_locale": "en_US",
"default_timezone": "America/Los_Angeles",
"grading": {"default_grade_status": "draft",
"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"allow_custom_scheme": true
},
"gpa": {"enable_gpa": true,
"gpa_precision": 2
},
"audit_log": {"enable_audit_log": true,
"audit_log_retention_days": 365
},
"webhook": {"enable_webhooks": true,
"webhook_delivery_timeout": 30,
"webhook_delivery_retry_limit": 3,
"webhook_delivery_retry_interval": 60,
"webhook_delivery_max_payload_size": 1048576
}
}

Response samples

Content type

application/json

{"default_locale": "en_US",
"default_timezone": "America/Los_Angeles",
"grading": {"default_grade_status": "draft",
"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"allow_custom_scheme": true
},
"gpa": {"enable_gpa": true,
"gpa_precision": 2
},
"audit_log": {"enable_audit_log": true,
"audit_log_retention_days": 365
},
"webhook": {"enable_webhooks": true,
"webhook_delivery_timeout": 30,
"webhook_delivery_retry_limit": 3,
"webhook_delivery_retry_interval": 60,
"webhook_delivery_max_payload_size": 1048576
}
}

Patch Server Settings

Patch a server settings. Updates one or more fields in a settings. The operation updates passed fields only.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

default_locale	string (locale) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Supported Locales
default_timezone	string (timezone) Enum: "America/Los_Angeles" "Europe/Paris" Time zone. For example, Europe/Paris or America/Los_Angeles.
	object Grading Settings
	object GPA Settings
	object Audit Log Settings
	object Webhook Settings

Responses

Request samples

Payload

Content type

application/json

{"default_locale": "en_US",
"default_timezone": "America/Los_Angeles",
"grading": {"default_grade_status": "draft",
"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"allow_custom_scheme": true
},
"gpa": {"enable_gpa": true,
"gpa_precision": 2
},
"audit_log": {"enable_audit_log": true,
"audit_log_retention_days": 365
},
"webhook": {"enable_webhooks": true,
"webhook_delivery_timeout": 30,
"webhook_delivery_retry_limit": 3,
"webhook_delivery_retry_interval": 60,
"webhook_delivery_max_payload_size": 1048576
}
}

Response samples

Content type

application/json

{"default_locale": "en_US",
"default_timezone": "America/Los_Angeles",
"grading": {"default_grade_status": "draft",
"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"allow_custom_scheme": true
},
"gpa": {"enable_gpa": true,
"gpa_precision": 2
},
"audit_log": {"enable_audit_log": true,
"audit_log_retention_days": 365
},
"webhook": {"enable_webhooks": true,
"webhook_delivery_timeout": 30,
"webhook_delivery_retry_limit": 3,
"webhook_delivery_retry_interval": 60,
"webhook_delivery_max_payload_size": 1048576
}
}

Gradebooks

The Gradebook helps submissions easily input and distribute grades for members. Grades for each task can be calculated as points, percentages, complete or incomplete, pass or fail, GPA scale, and letter grades, and tasks can be organized into groups for weighting as well.

Get Gradebooks

Returns a list of gradebooks that the requesting user is permitted to view, restricted to those that match the request.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"members": 0,
"periods": 0,
"topics": 0,
"categories": 0,
"tasks": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"grades": {"number": 0,
"overall": 0
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"periods": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"topics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"grades": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Gradebook

The user specified in owner_id is the owner of the created gradebook and added as a submission. A non-admin requesting user can only create a gradebook with themselves as the owner.

Admins can create gradebooks owned by any user within their school and branch.

Gradebooks are created with the status draft by default; however, this can be overridden to active using activate operation.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Gradebook

name required	string (Name) Gradebook Name
description	string (Description) Gradebook Description
owner_id	string <uuid> (user_id) User Id
	object (Gradebook Metadata) Gradebook Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"members": 0,
"periods": 0,
"topics": 0,
"categories": 0,
"tasks": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"grades": {"number": 0,
"overall": 0
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"periods": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"topics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"grades": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Gradebook

Returns a single gradebook details such as code, name, metadata, and child resources.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"members": 0,
"periods": 0,
"topics": 0,
"categories": 0,
"tasks": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"grades": {"number": 0,
"overall": 0
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"periods": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"topics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"grades": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Gradebook

You can update fields of a gradebook after the gradebook is created. The following fields can be updated any time after the gradebook is created.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Gradebook

name	string (Name) Gradebook Name
description	string (Description) Gradebook Description
	object (Gradebook Metadata) Gradebook Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Math 1",
"description": "Math 1",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"members": 0,
"periods": 0,
"topics": 0,
"categories": 0,
"tasks": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"grades": {"number": 0,
"overall": 0
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"periods": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"topics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"grades": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Gradebook

Updates one or more fields in a gradebook. The operation updates passed fields only.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Gradebook

name	string (Name) Gradebook Name
description	string (Description) Gradebook Description
	object (Gradebook Metadata) Gradebook Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Math 1",
"description": "Math 1",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"members": 0,
"periods": 0,
"topics": 0,
"categories": 0,
"tasks": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"grades": {"number": 0,
"overall": 0
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"periods": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"topics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"grades": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Gradebook

Delete a gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Change Gradebook Status

Changes status of a gradebook to the status specified in the request body..

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Change Gradebook Status

status

required

string (Status)

Default: "active"

Enum: "draft" "active" "archived"

Gradebook Status. If you want to get the list of values progmatically, use the Lookups endpoints.

Responses

Request samples

Payload

Content type

application/json

{"status": "draft"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Transfer Gradebook

Admins can transfer ownership of gradebooks within their school.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Transfer Gradebook Ownership

user_id

string <uuid> (user_id)

User Id

Responses

Request samples

Payload

Content type

application/json

{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Members

Gradebook members.

Get Members

Returns a list of members of this gradebook that the requester is permitted to view.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Members

Admins can directly add members within their school and branch with this operation.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Members of the Gradebook

user_role	string (Role) Enum: "teacher" "student" User Role
users	Array of strings <uuid> (user_id)

Responses

Request samples

Payload

Content type

application/json

{"user_role": "teacher",
"users": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Remove Members

You can remove one and more members from a gradebook with this operation.

This only removes specified members from the gradebook and does not affect their user profile.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Users

users

Array of strings <uuid> (user_id)

Responses

Request samples

Payload

Content type

application/json

{"users": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Get Member

Retrieve single member details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
user_id required	string <uuid> (user_id) User Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_role": "teacher",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Member

You can remove a single member from a gradebook with this operation.

This only removes the specified member from the gradebook and does not affect their user profile.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
user_id required	string <uuid> (user_id) User Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Periods

Gradebook period is a grading period to group tasks by a period of time, such as terms, semesters, or quarters.

To create a date range grading period, system automatically checks all associated tasks with due dates that occur in the date range.

By default, the Gradebook has no periods. You can create as many grading periods as you want.

Get Periods

Returns a list of periods of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"tasks": 0,
"overall_grade": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Period

Add a period in the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Period

name required	string (Name) Period Name
description	string (Description) Period Description
sequence	integer <int32> (Sequence) Period Sequence
	object (Period Metadata) Period Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "1st Semester",
"description": "1st Semester",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"tasks": 0,
"overall_grade": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Period

Returns a single period details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
period_id required	string <uuid> (Period Id) Period Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"tasks": 0,
"overall_grade": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Period

You can update fields of a period after the period is created. The following fields can be updated any time after the period is created.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
period_id required	string <uuid> (Period Id) Period Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Period

name	string (Name) Period Name
description	string (Description) Period Description
sequence	integer <int32> (Sequence) Period Sequence
	object (Period Metadata) Period Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "1st Semester",
"description": "1st Semester",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"tasks": 0,
"overall_grade": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Period

Updates one or more fields in a period. The operation updates passed fields only.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
period_id required	string <uuid> (Period Id) Period Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Period

name	string (Name) Period Name
description	string (Description) Period Description
sequence	integer <int32> (Sequence) Period Sequence
	object (Period Metadata) Period Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "1st Semester",
"description": "1st Semester",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"tasks": 0,
"overall_grade": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Period

You can remove a single period from a gradebook with this operation.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
period_id required	string <uuid> (Period Id) Period Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Change Period Status

Changes status of a period to the status specified in the request body..

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
period_id required	string <uuid> (Period Id) Period Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Change Period Status

status

required

string (Period Status)

Enum: "opened" "closed"

Period Status. If you want to get the list of values progmatically, use the Lookups endpoints.

Responses

Request samples

Payload

Content type

application/json

{"status": "opened"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Topics

Gradebook topic represents a group of tasks categorized by similarity, such as the week assigned or course subject.

Get Topics

Returns a list of topics of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"parent_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"children": 0,
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Topic

Add a topic in the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Topic

name required	string (Name) Topic Name
description	string (Description) Topic Description
parent_id	string (Parent Id) Parent Topic Id
sequence	integer <int32> (Sequence) Topic Sequence
metadata	object (Topic Metadata) Topic Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"parent_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"children": 0,
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Topic

Returns a single topic details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
topic_id required	string <uuid> (Topic Id) Topic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"parent_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"children": 0,
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Topic

You can update fields of a topic after the topic is created. The following fields can be updated any time after the topic is created.

Available fields to update:

name
description
metadata
app_metadata
parent_id
sequence

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
topic_id required	string <uuid> (Topic Id) Topic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Topic

name	string (Name) Topic Name
description	string (Description) Topic Description
parent_id	string (Parent Id) Parent Topic Id
sequence	integer <int32> (Sequence) Topic Sequence
metadata	object (Topic Metadata) Topic Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"parent_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"children": 0,
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Topic

Updates one or more fields in a topic. The operation updates passed fields only.

Available fields to update:

name
description
metadata
app_metadata
parent_id
sequence

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
topic_id required	string <uuid> (Topic Id) Topic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Topic

name	string (Name) Topic Name
description	string (Description) Topic Description
parent_id	string (Parent Id) Parent Topic Id
sequence	integer <int32> (Sequence) Topic Sequence
metadata	object (Topic Metadata) Topic Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"parent_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"children": 0,
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Topic

You can remove a single topic from a gradebook with this operation.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
topic_id required	string <uuid> (Topic Id) Topic Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Categories

Gradebook categories are high-level groups of tasks that an submission might track (for example, assignment, homework, extra credit, forms, tests, projects, milestones, finals, and so on)

By default, these seven categories are created in the gradebook:

Assignment
Attendance
Extra Credit
Homework
Form
Project
Test

Get Categories

Returns a list of categories of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Category

Add a category to the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Category

name required	string (Name) Category Name
description	string (Description) Category Description
weight	integer (Weight) Category Weight. The weight of the category average as part of overall average.
	object (Category Metadata) Category Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Category

Returns a single category details.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
category_id required	string <uuid> (Category Id) Category Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Category

You can update fields of a category after the category is added.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
category_id required	string <uuid> (Category Id) Category Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Category

name	string (Name) Category Name
description	string (Description) Category Description
weight	integer (Weight) Category Weight. The weight of the category average as part of overall average.
	object (Category Metadata) Category Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Category

Updates one or more fields in a category. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
category_id required	string <uuid> (Category Id) Category Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Category

name	string (Name) Category Name
description	string (Description) Category Description
weight	integer (Weight) Category Weight. The weight of the category average as part of overall average.
	object (Category Metadata) Category Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"tasks": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Category

You can remove a single category from the gradebook with this operation.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
category_id required	string <uuid> (Category Id) Category Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Tasks

A Task resource represents a user who teaches a specific gradebook. Tasks are permitted to view and change the gradebook details, view submissions and periods, and manage additional submissions and periods.

Get Tasks

Returns a list of tasks of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"topic_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"attachments": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"points_avg": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Task

Add a task to the gradebook. Only teachers in a gradebook can create a task. Tasks start in the draft state, which means that members will not see the task until publication.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Task

period_id	string <uuid> (Period Id) Period Id
category_id	string <uuid> (Category Id) Category Id
topic_id	string <uuid> (Topic Id) Topic Id
name required	string (Name) Task Name
description	string (Description) Task Description
	object (Task Metadata) Task Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"topic_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"attachments": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"points_avg": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Task

Returns a single task details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"topic_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"attachments": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"points_avg": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Task

You can update fields of a task. The following fields can be updated any time after the task is created.

Available fields to update:

period_id
category_id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task

period_id	string <uuid> (Period Id) Period Id
category_id	string <uuid> (Category Id) Category Id
topic_id	string <uuid> (Topic Id) Topic Id
name	string (Name) Task Name
description	string (Description) Task Description
	object (Task Metadata) Task Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"topic_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"attachments": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"points_avg": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Task

Updates one or more fields in a task. The operation updates passed fields only.

Available fields to update:

period_id
category_id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task

period_id	string <uuid> (Period Id) Period Id
category_id	string <uuid> (Category Id) Category Id
topic_id	string <uuid> (Topic Id) Topic Id
name	string (Name) Task Name
description	string (Description) Task Description
	object (Task Metadata) Task Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Homework",
"description": "Homework",
"weight": 30,
"metadata": {"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"topic_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "Mathematics",
"description": "Mathematics",
"parent_id": null,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"attachments": 0,
"submissions": {"assigned": 0,
"submitted": 0,
"returned": 0
},
"points_avg": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"submissions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Task

Remove a single task from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Publish Task

Changes status of a task to the status specified in the request body..

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Change Task Status

status

required

string (Task Status)

Enum: "draft" "published" "deleted" "archived"

Task Status. If you want to get the list of values progmatically, use the Lookups endpoints.

Responses

Request samples

Payload

Content type

application/json

{"status": "draft"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Task Attachments

Attachments attached to the task of the gradebook.

Attachment Types:

File - File Attachment
Link - Link Attachment
Note - Note Attachment

Get Attachments

Returns a list of attachments of the task.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Attachment

Add an attachment to the task.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Task Attachment

type required	string (Attachment Type) Enum: "file" "link" "note" Attachment Type. If you want to get the list of values progmatically, use the Lookups endpoints. Attachment Types: File - File Attachment Link - Link Attachment Note - Note Attachment
name required	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Attachment

Returns a single attachment details from the task.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Attachment

You can update fields of an attachment.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task Attachment

name	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Attachment

Updates one or more fields in an attachment. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task Attachment

name	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Attachment

Remove a single attachment from the task.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
task_id required	string <uuid> (Task Id) Task Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Submissions

Individual members that have access to the task. Used only when submission type is individual in the task.

Get Submissions

Returns a list of submissions of this gradebook that the requester is permitted to view.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"attachments": 0,
"attempts": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Submissions

Add Submissions to the task of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Submissions

task_id	string <uuid> (Task Id) Task Id
users	Array of strings <uuid> (Users) Users assign to the task

Responses

Request samples

Payload

Content type

application/json

{"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"users": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Remove Submissions

You can remove one and more submissions from a task with this operation.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Users

users

Array of strings <uuid> (user_id)

Responses

Request samples

Payload

Content type

application/json

{"users": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Get Submission

Retrieve single submission details from the task of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"attachments": 0,
"attempts": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Submission

You can update fields of a submission. The following fields can be updated any time after the submission is created.

Available fields to update:

metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Submission

	object (Submission Metadata) Submission Metadata
status	string (Status) Default: "assigned" Enum: "assigned" "submitted" "returned" Submission Status. If you want to get the list of values progmatically, use the Lookups endpoints. Available Statuses: Assigned - By default, newly created status Submitted - Returned -
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"attachments": 0,
"attempts": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Submission

Updates one or more fields in a submission. The operation updates passed fields only.

Available fields to update:

metadata
app_metadata

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Submission

	object (Submission Metadata) Submission Metadata
status	string (Status) Default: "assigned" Enum: "assigned" "submitted" "returned" Submission Status. If you want to get the list of values progmatically, use the Lookups endpoints. Available Statuses: Assigned - By default, newly created status Submitted - Returned -
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
"name": "Homework 1",
"description": "Homework 1 (Topic 105)",
"status": "draft",
"metadata": {"dates": {"open_at": "2019-08-24T14:15:22Z",
"close_at": "2019-08-24T14:15:22Z",
"due_at": "2019-08-24T14:15:22Z"
},
"grading": {"type": "points"
},
"submission": {"allow_late_submission": true,
"max_attempts": 99
},
"assignments": {"auto_assign": "none",
"assignee_type": "all",
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"assignees": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"attachments": 0,
"attempts": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Submission

You can remove a single submission from the task of the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Change Submission Status

Changes status of a submission to the status specified in the request body..

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Change Submission Status

status

required

string (Status)

Default: "assigned"

Enum: "assigned" "submitted" "returned"

Submission Status. If you want to get the list of values progmatically, use the Lookups endpoints.

Available Statuses:

Assigned - By default, newly created status
Submitted -
Returned -

Responses

Request samples

Payload

Content type

application/json

{"status": "assigned"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Submission Attachments

Attachments attached to the submission of the gradebook.

Attachment Types:

File - File Attachment
Link - Link Attachment
Note - Note Attachment

Get Attachments

Returns a list of attachments of the submission.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"submission_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Attachment

Add an attachment to the submission.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Task Attachment

type required	string (Attachment Type) Enum: "file" "link" "note" Attachment Type. If you want to get the list of values progmatically, use the Lookups endpoints. Attachment Types: File - File Attachment Link - Link Attachment Note - Note Attachment
name required	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"submission_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Attachment

Returns a single attachment details from the submission.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"submission_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Attachment

You can update fields of an attachment.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task Attachment

name	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"submission_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Attachment

Updates one or more fields in an attachment. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Task Attachment

name	string (Name) Attachment Name
description	string (Description) Attachment Description
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
"submission_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"metadata": {"grading": {"type": "points"
},
"ref": {"submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
"submitted_at": "2019-08-24T14:15:22Z",
"unsubmitted_by": "bc49d23f-af73-4c1f-b751-14949d92b6b9",
"unsubmitted_at": "2019-08-24T14:15:22Z",
"returned_by": "6945d65c-9d7f-40c0-b480-5ad7fb654bce",
"returned_at": "2019-08-24T14:15:22Z"
}
},
"status": "assigned",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"name": "Homework 1",
"description": "Homework 1",
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Employee CV.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Attachment

Remove a single attachment from the submission.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
submission_id required	string <uuid> (Submission Id) Submission Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Grades

Gradebook allows for complicated grade calculations, but it also accommodates simple, straightforward averages.

The simplest way to calculate grades is to have only one category and have the maximum points for each task equal the task weight. The result is a simple average.

Alternatively, you can define multiple tasks that are organized in different task categories (for example, homework tasks in the Homework category, quizzes in the Quiz category, and so on). That way each assignment can have its own maximum points and weight (in points), and the task category itself can have a specific percentage of the overall grade.

For example, the tasks that make up the homework category overall can make up 25 percent of the final grade, and the Quiz category overall can make up 50 percent of the overall grade.

Get Grades

Returns a list of grades of the gradebook that the requester is permitted to view.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"scheme_scale_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Grade

create a new grade in the gradebook. The system calculates weighted grades for individual tasks like this:

(student's grade in points × task weight) ÷ maximum grade in points for the task

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Grade

user_id required	string <uuid> (user_id) User Id
type required	string (Grade Type) Enum: "overall" "period_overall" Grade Types Overall - Period Overall -
period_id	string <uuid> (Period Id) Period Id
score required	integer (Overall Grade) Overall Grade

Responses

Request samples

Payload

Content type

application/json

{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Recalculate Grades

The system calculates weighted grades for individual tasks like this:

(student's grade in points × task weight) ÷ maximum grade in points for the task

The system calculates cumulative task category grades like this:

total of task weighted grades / total weight of tasks that count for the category (not including extra credit)

The system excludes ungraded tasks from the calculation until the due date.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Recalculate Grades

type	string (Grade Type) Enum: "overall" "period_overall" Grade Types Overall - Period Overall -
period_id	string <uuid> (Period Id) Period Id. Used only when type is period overall.

Responses

Request samples

Payload

Content type

application/json

{"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Get Grade

Retrieve single grade details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
grade_id required	string <uuid> (Grade id) Grade Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"scheme_scale_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Grade

You can update fields of a grade. The system calculates weighted grades for individual tasks like this:

(student's grade in points × task weight) ÷ maximum grade in points for the task

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
grade_id required	string <uuid> (Grade id) Grade Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grade

type	string (Grade Type) Enum: "overall" "period_overall" Grade Types Overall - Period Overall -
period_id	string <uuid> (Period Id) Period Id
score	integer (Overall Grade) Overall Grade
score_override	integer (Overridden Score) Overridden Score
scheme_id	string <uuid> (Grading Scheme Id) Grading Scheme Id
scheme_scale_id	string <uuid> (Scale Id) Grading Scale Id
grade_letter	string (Grade Letter) Grade Letter

Responses

Request samples

Payload

Content type

application/json

{"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"scheme_scale_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Grade

Updates one or more fields in a grade. The operation updates passed fields only. The system calculates weighted grades for individual tasks like this:

(student's grade in points × task weight) ÷ maximum grade in points for the task

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
grade_id required	string <uuid> (Grade id) Grade Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grade

type	string (Grade Type) Enum: "overall" "period_overall" Grade Types Overall - Period Overall -
period_id	string <uuid> (Period Id) Period Id
score	integer (Overall Grade) Overall Grade
score_override	integer (Overridden Score) Overridden Score
scheme_id	string <uuid> (Grading Scheme Id) Grading Scheme Id
scheme_scale_id	string <uuid> (Scale Id) Grading Scale Id
grade_letter	string (Grade Letter) Grade Letter

Responses

Request samples

Payload

Content type

application/json

{"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"grade_letter": "A"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "overall",
"period_id": "6ce135b2-3d2a-48df-89ee-28d5de4ff349",
"period_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"name": "1st Semester",
"description": "1st Semester",
"status": "opened",
"sequence": 1,
"metadata": {"dates": {"enabled": false,
"start_at": "2019-08-24",
"end_at": "2019-08-24"
},
"grading": {"weight": 50
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"score": 98,
"score_override": 99,
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scheme_scale_id": "cb2a85a5-77cc-40d3-8d42-73efe01e8081",
"scheme_scale_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"grade_letter": "A",
"status": "draft",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Grade

You can delete a single grade from the gradebook with this operation.

This only removes the specified grade from the gradebook and does not affect the user profile. The system recalculates the weighted grades for individual tasks after this operation.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
grade_id required	string <uuid> (Grade id) Grade Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Change Grade Status

Changes status of a grade to the status specified in the request body..

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
grade_id required	string <uuid> (Grade id) Grade Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Change Grade Status

status

string (Grade Status)

Enum: "draft" "overridden" "finalized" "locked" "archived"

Grade Status. If you want to get the list of values progmatically, use the Lookups endpoints.

Available Statuses:

draft - Not finalized grade
overridden - User manually changed grade
finalized - Final Grade
locked - Locked grade, cannot be changed
archived - Archived grade, cannot be changed

Responses

Request samples

Payload

Content type

application/json

{"status": "draft"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Gradebook Groups

Gradebook groups are used to organize members into smaller sets for easier management and grading. Groups can be used to assign tasks, manage submissions, and apply grading schemes to specific sets of members.

Groups can be created for different purposes, such as project teams, study groups, or class sections. Members can belong to multiple groups within a gradebook.

Get Groups

Returns a list of groups of this gradebook that the requester is permitted to view.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Group

Add group into the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id

required

string <uuid> (Gradebook Id)

Gradebook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create group

name required	string (Name) Group Name
description	string (Description) Group Description
members	Array of strings <uuid> (Members) Group Members
metadata	object (Group Metadata) Group Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Get Group

Retrieve single group details from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
group_id required	string <uuid> (Group Id) Gradebook Group Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Group

You can update fields of a group after the group is created. The following fields can be updated any time after the group is created.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
group_id required	string <uuid> (Group Id) Gradebook Group Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update group

name	string (Name) Group Name
description	string (Description) Group Description
members	Array of strings <uuid> (Members) Group Members
metadata	object (Group Metadata) Group Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Group

Updates one or more fields in a group. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
group_id required	string <uuid> (Group Id) Gradebook Group Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update group

name	string (Name) Group Name
description	string (Description) Group Description
members	Array of strings <uuid> (Members) Group Members
metadata	object (Group Metadata) Group Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Math 1",
"description": "Math 1",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"status": "draft",
"metadata": {"join": {"enabled": true,
"join_code": "abc-123-efg-456"
},
"branding": {"image": "/img/gradebook-image.png",
"theme_color": "blue"
},
"grading": {"default_scheme_id": "1cf76cd1-1449-4923-b547-0d8d503b5f66",
"default_rubric_id": "c04bd029-c0c2-4ecc-9428-92945e214666"
},
"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Group A",
"description": "Group A",
"members": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Group

Deletes a group from the gradebook. This operation removes the group and all its members from the gradebook.

Authorizations:

Scopes

path Parameters

gradebook_id required	string <uuid> (Gradebook Id) Gradebook Id
group_id required	string <uuid> (Group Id) Gradebook Group Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Schemes

A grading scheme is a set of rules that define how grades are calculated and represented in the gradebook. It includes grading scales, letter grades, and GPA calculations.

Grading schemes can be customized to fit the specific needs of a school or course, allowing for flexibility in grading practices.

Get Grading Schemes

Returns a list of grading schemes that the requester is permitted to view. The grading schemes are used to calculate grades for tasks and gradebooks. The system uses the default grading scheme if no other scheme is specified.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Grading Scheme

Create a new grading scheme. The grading scheme is used to calculate grades for tasks and gradebooks. The system uses the default grading scheme if no other scheme is specified.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Grading Scheme

name required	string (Name) Grading Scheme Name
description	string (Description) Grading Scheme Description
	object (Grading Scheme Metadata) Grading Scheme Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.
	Array of objects (Scales) Scales to add for the grading scheme.

Responses

Request samples

Payload

Content type

application/json

{"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"scales": [{"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Grading Scheme

Returns a single grading scheme details. The grading scheme is used to calculate grades for tasks and gradebooks. The system uses the default grading scheme if no other scheme is specified.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Grading Scheme

You can update fields of a grading scheme after the grading scheme is created. The following fields can be updated any time after the grading scheme is created.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grading Scheme

name	string (Name) Grading Scheme Name
description	string (Description) Grading Scheme Description
	object (Rubric Metadata) Rubric Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Grading Scheme

Updates one or more fields in a grading scheme. The operation updates passed fields only. The following fields can be updated any time after the grading scheme is created.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grading Scheme

name	string (Name) Grading Scheme Name
description	string (Description) Grading Scheme Description
	object (Rubric Metadata) Rubric Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Grading Scheme

Delete a grading scheme. The grading scheme is used to calculate grades for tasks and gradebooks. The system uses the default grading scheme if no other scheme is specified.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Copy Grading Scheme

Create new grading scheme using specific grading scheme id with it's data.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scales": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"scales": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Scheme Scales

Scheme Scales are the specific scales used within a grading scheme to convert raw scores into letter grades or GPA values.

Each scale defines the ranges of scores that correspond to specific letter grades (e.g., A, B, C) or GPA values.
Scales can be customized to reflect different grading standards, such as traditional letter grades or standards-based grading.
Helps ensure consistent and transparent grading across tasks and submissions.

Get Grading Scales

Returns a list of grading scales that the requester is permitted to view. The grading scales are used to calculate grades for tasks and gradebooks. The system uses the default grading scale if no other scale is specified.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Grading Scale

Add a new grading scale to the grading scheme. The grading scale is used to calculate grades for tasks and gradebooks. The system uses the default grading scale if no other scale is specified.

Authorizations:

Scopes

path Parameters

scheme_id

required

string <uuid> (Grading Scheme Id)

Grading Scheme Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Grading Scale

name required	string (Name) Scale Name
description	string (Description) Scale Description
min_score	number <float> (Min Score) Minimum Score for the Scale
max_score	number <float> (Max Score) Maximum Score for the Scale
gpa	number <float> (GPA) Grade Point Average for the Scale
letter	string (Letter) Letter for the Scale
metadata	object (Scale Metadata) Grading Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Grading Scale

Returns a single grading scale details. The grading scale is used to calculate grades for tasks and gradebooks.

Authorizations:

Scopes

path Parameters

scheme_id required	string <uuid> (Grading Scheme Id) Grading Scheme Id
scale_id required	string <uuid> (Scale Id) Grading Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Grading Scale

You can update fields of a criteria after the grading scale is added.

Authorizations:

Scopes

path Parameters

scheme_id required	string <uuid> (Grading Scheme Id) Grading Scheme Id
scale_id required	string <uuid> (Scale Id) Grading Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grading Scale

name	string (Name) Scale Name
description	string (Description) Scale Description
min_score	number <float> (Min Score) Minimum Score for the Scale
max_score	number <float> (Max Score) Maximum Score for the Scale
gpa	number <float> (GPA) Grade Point Average for the Scale
letter	string (Letter) Letter for the Scale
metadata	object (Scale Metadata) Grading Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Grading Scale

Updates one or more fields in a grading scale. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

scheme_id required	string <uuid> (Grading Scheme Id) Grading Scheme Id
scale_id required	string <uuid> (Scale Id) Grading Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Grading Scale

name	string (Name) Scale Name
description	string (Description) Scale Description
min_score	number <float> (Min Score) Minimum Score for the Scale
max_score	number <float> (Max Score) Maximum Score for the Scale
gpa	number <float> (GPA) Grade Point Average for the Scale
letter	string (Letter) Letter for the Scale
metadata	object (Scale Metadata) Grading Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheme_id": "1138cdd3-9f6d-45a5-ae92-04d708b61778",
"scheme_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Standart A-F",
"description": "Grading Scheme for Standart A-F",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "A",
"description": "A Scale",
"min_score": 90,
"max_score": 100,
"gpa": 4,
"letter": "A",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Grading Scale

You can remove a single grading scale from the grading scheme.

Authorizations:

Scopes

path Parameters

scheme_id required	string <uuid> (Grading Scheme Id) Grading Scheme Id
scale_id required	string <uuid> (Scale Id) Grading Scale Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rubrics

A rubric is a scoring tool you can use to evaluate graded task. When you create a rubric, you divide the assigned task into parts. You can provide clear descriptions of the characteristics of the task associated with each part, at varying levels of skill.

Get Rubrics

Returns a list of rubrics that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Rubric

Create a rubric.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Rubric

name required	string (Name) Rubric Name
description	string (Description) Rubric Description
	object (Rubric Metadata) Rubric Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.
	Array of objects (Criterias) Criterias to add for the rubric.
	Array of objects (Associations) Associations to add for the rubric.

Responses

Request samples

Payload

Content type

application/json

{"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"criterias": [{"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"levels": [{"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}
]
}
],
"associations": [{"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Rubric

Returns a single rubric details.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Rubric

You can update fields of a rubric after the rubric is created. The following fields can be updated any time after the rubric is created.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric

name	string (Name) Rubric Name
description	string (Description) Rubric Description
	object (Rubric Metadata) Rubric Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Rubric

Updates one or more fields in a rubric. The operation updates passed fields only.

Available fields to update:

name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric

name	string (Name) Rubric Name
description	string (Description) Rubric Description
	object (Rubric Metadata) Rubric Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Rubric

Delete a rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Copy Rubric

Create new rubric using specific rubic id with it's data.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"criterias": 0,
"associations": 0,
"assessments": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"associations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Rubric Criterias

Rubric Criterias define the individual evaluation points or dimensions within a rubric.

Each rubric consists of one or more criterias.
Examples of criteria include: Clarity, Creativity, Accuracy, Completeness.
These criterias describe what aspects of the student’s work will be evaluated.

Get Criterias

Returns a list of criterias of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"levels": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Criteria

Add a criteria to the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Criteria

name required	string (Name) Criteria Name
description	string (Description) Criteria Description
sequence	integer <int32> (Sequence) Criteria Sequence
metadata	object (Criteria Metadata) Criteria Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.
	Array of objects (Levels) Levels to add for the criteria.

Responses

Request samples

Payload

Content type

application/json

{"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"levels": [{"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"levels": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Criteria

Returns a single criteria details of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"levels": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Criteria

You can update fields of a criteria after the criteria is added.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Criteria

name	string (Name) Criteria Name
description	string (Description) Criteria Description
sequence	integer <int32> (Sequence) Criteria Sequence
metadata	object (Criteria Metadata) Criteria Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"levels": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Criteria

Updates one or more fields in a criteria. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Criteria

name	string (Name) Criteria Name
description	string (Description) Criteria Description
sequence	integer <int32> (Sequence) Criteria Sequence
metadata	object (Criteria Metadata) Criteria Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"levels": 0,
"points": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Criteria

You can remove a single criteria from the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rubric Criteria Levels

Rubric Criteria Levels define the performance levels within each criteria.

Each level corresponds to a score and description.
Common levels might be: Excellent (4 points), Good (3 points), Fair (2 points), Poor (1 point).
Helps teachers describe expected quality at each performance tier.

Get Levels

Returns a list of levels of the criteria.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Level

Add a level to the criteria.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Criteria Level

name required	string (Name) Level Name
description	string (Description) Level Description
points	integer (Points) Level Points. Used only when scoring of the rubric is enabled.
sequence	integer <int32> (Sequence) Level Sequence
metadata	object (Level Metadata) Level Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Level

Returns a single level details of the criteria.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id
level_id required	string <uuid> (Level Id) Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Level

You can update fields of a level after the level is added.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id
level_id required	string <uuid> (Level Id) Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Criteria Level

name	string (Name) Level Name
description	string (Description) Level Description
points	integer (Points) Level Points. Used only when scoring of the rubric is enabled.
sequence	integer <int32> (Sequence) Level Sequence
metadata	object (Level Metadata) Level Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Level

Updates one or more fields in a level. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id
level_id required	string <uuid> (Level Id) Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Criteria Level

name	string (Name) Level Name
description	string (Description) Level Description
points	integer (Points) Level Points. Used only when scoring of the rubric is enabled.
sequence	integer <int32> (Sequence) Level Sequence
metadata	object (Level Metadata) Level Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Level

You can remove a single level from the criteria with this operation.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id
level_id required	string <uuid> (Level Id) Level Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rubric Associations

Rubric Associations are links between a rubric and a gradebook task.

This tells the system which rubric is used for which assignment/task.
A rubric can be reused across multiple tasks via associations.
Includes optional weighting.

Get Associations

Returns a list of associations of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"assessments": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Association

Add an association to the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Rubric Association

type required	string (Association Type) Enum: "gradebook_task" "custom" Association Type. If you want to get the list of values progmatically, use the Lookups endpoints.
description	string (Description) Association Description
	Gradebook Task (object) or Custom (object) (Association Metadata) Association Metadata. It depends on association type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"assessments": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Association

Returns a single association details of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
association_id required	string <uuid> (Association Id) Association Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"assessments": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Association

You can update fields of an association after the association is added.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
association_id required	string <uuid> (Association Id) Association Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric Association

type	string (Association Type) Enum: "gradebook_task" "custom" Association Type. If you want to get the list of values progmatically, use the Lookups endpoints.
description	string (Description) Association Description
	Gradebook Task (object) or Custom (object) (Association Metadata) Association Metadata. It depends on association type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"assessments": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Association

Updates one or more fields in an association. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
association_id required	string <uuid> (Association Id) Association Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric Association

type	string (Association Type) Enum: "gradebook_task" "custom" Association Type. If you want to get the list of values progmatically, use the Lookups endpoints.
description	string (Description) Association Description
	Gradebook Task (object) or Custom (object) (Association Metadata) Association Metadata. It depends on association type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"assessments": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"assessments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Association

You can remove a single association from the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
association_id required	string <uuid> (Association Id) Association Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rubric Assessments

Rubric Assessments are the actual evaluations given to a student submission using a rubric.

Created when a teacher scores a student’s work using the rubric.
Links to a specific task submission and rubric.
Captures total score, individual criteria results, comments, and grader identity.

Get Assessments

Returns a list of assessments of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"association_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"assessor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criterias": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Assessment

Add an assessment to the rubric.

Authorizations:

Scopes

path Parameters

rubric_id

required

string <uuid> (Rubric Id)

Rubric Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Rubric Assessment

association_id required	string <uuid> (Association Id) Association Id
object_type required	string (Object Type) Value: "submission" The object type of the assessment. If you want to get the list of values progmatically, use the Lookups endpoints.
object_id required	string (Object Id) the id of the object of the assessment
object_attempt	integer <int32> (Attempt) the current number of attempts made on the object of the assessment
assessor_id	string <uuid> (user_id) User Id
description	string (Description) Description of Assessment
metadata	object (Assessment Metadata) Assessment Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.
	Array of objects (Create Assessment Criteria)

Responses

Request samples

Payload

Content type

application/json

{"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"criterias": [{"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating."
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"association_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"assessor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criterias": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Assessment

Returns a single assessment details of the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"association_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"assessor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criterias": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Assessment

You can update fields of an assessment after the assessment is added.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric Assessment

association_id	string <uuid> (Association Id) Association Id
object_type	string (Object Type) Value: "submission" The object type of the assessment. If you want to get the list of values progmatically, use the Lookups endpoints.
object_id	string (Object Id) the id of the object of the assessment
object_attempt	integer <int32> (Attempt) the current number of attempts made on the object of the assessment
assessor_id	string <uuid> (user_id) User Id
description	string (Description) Description of Assessment
metadata	object (Assessment Metadata) Assessment Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"association_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"assessor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criterias": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Assessment

Updates one or more fields in an assessment. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rubric Assessment

association_id	string <uuid> (Association Id) Association Id
object_type	string (Object Type) Value: "submission" The object type of the assessment. If you want to get the list of values progmatically, use the Lookups endpoints.
object_id	string (Object Id) the id of the object of the assessment
object_attempt	integer <int32> (Attempt) the current number of attempts made on the object of the assessment
assessor_id	string <uuid> (user_id) User Id
description	string (Description) Description of Assessment
metadata	object (Assessment Metadata) Assessment Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"rubric_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "IELTS Speaking",
"description": "Rubric for IELTS Speaking",
"metadata": {"dataset": {"enabled": false,
"dataset_id": null
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"association_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"type": "gradebook_task",
"description": "string",
"metadata": {"gradebook_id": "0c020a1c-9952-4a36-9c56-19313fd01984",
"gradebook_task_id": "e60ea49b-f01d-43bf-90d7-6ddc9df974e8"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 0,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"assessor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criterias": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criterias": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Assessment

You can remove a single assessment from the rubric.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rubric Assessment Criterias

Rubric Assessment Criterias represent the selected level for each criteria in an assessment.

Stores which level (e.g., “Good”, “Excellent”) was selected for each criteria.
Includes optional comments per criteria.
Enables analytics like: “Most students scored ‘Fair’ in Creativity.”

Get Criterias

Returns a list of criterias of the assessment.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"assessment_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"level_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Criteria

Add a criteria to the assessment.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Assessment Criteria

criteria_id required	string <uuid> (Criteria Id) Criteria Id
level_id required	string <uuid> (Level Id) Level Id
points	integer (Points) Assessment Criteria Points
description	string (Description) Assessment Criteria Description

Responses

Request samples

Payload

Content type

application/json

{"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating."
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"assessment_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"level_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Criteria

Returns a single criteria details of the assessment.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"assessment_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"level_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Criteria

You can update fields of a criteria after the criteria is added.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Assessment Criteria

level_id	string <uuid> (Level Id) Level Id
points	integer (Points) Assessment Criteria Points
description	string (Description) Assessment Criteria Description

Responses

Request samples

Payload

Content type

application/json

{"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating."
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"assessment_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"level_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Criteria

Updates one or more fields in a criteria. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Assessment Criteria

level_id	string <uuid> (Level Id) Level Id
points	integer (Points) Assessment Criteria Points
description	string (Description) Assessment Criteria Description

Responses

Request samples

Payload

Content type

application/json

{"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"points": 1,
"description": "Criteria 1 Rating."
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
"assessment_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"association_id": "b7261822-545a-4eed-9acd-2428afa0245c",
"object_type": "submission",
"object_id": "submission_123",
"object_attempt": 1,
"score": 0,
"assessor_id": "f446e2e6-cdbc-47d5-9f4b-e66107a84999",
"description": "Gradebook task's submission graded successfully.",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"criteria_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rubric_id": "e76c2a30-2636-4bc1-9470-419e0c197029",
"name": "Criteria 1",
"description": "Criteria 1",
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"level_id": "3cb85fcc-c00c-4c83-ae89-cd2568531125",
"level_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
"name": "Level 1",
"description": "Level 1",
"points": 1,
"sequence": 1,
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"points": 1,
"description": "Criteria 1 Rating.",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Criteria

You can remove a single criteria from the assessment.

Authorizations:

Scopes

path Parameters

rubric_id required	string <uuid> (Rubric Id) Rubric Id
assessment_id required	string <uuid> (Assessment Id) Assessment Id
criteria_id required	string <uuid> (Criteria Id) Criteria Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Audit Logs

It is used to track important changes such as grade updates, task edits, submissions, membership changes, and more.

This helps admins, teachers, and even students (limited view) to review who made a change, what was changed, and when it happened.

Get Audit Logs

Returns a list of audit trail entries that record actions such as grade edits, task updates, rubric evaluations, or member changes. Useful for tracking what changed, who changed it, and when.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"timestamp": "2025-07-09T10:15:00Z",
"action": "update",
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"actor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"entity_type": "gradebook_submission",
"entity_id": "sub_456",
"entity_name": "Week 2 Homework - Batbold",
"changes": [{"field": "status",
"old_value": "missing",
"new_value": "submitted"
},
{"field": "submitted_at",
"old_value": null,
"new_value": "2025-07-08T23:59:59Z"
}
],
"context_ip": "203.91.112.14",
"context_agent": "Mozilla/5.0 (Mac)",
"context_request": "req_12345678"
}
]
}

Purge Audit Logs

Deletes all audit log entries. This operation is irreversible and should be used with caution.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Purge Audit Logs

entity_type	string (log_entity_type) Enum: "gradebook" "gradebook_member" "gradebook_period" "gradebook_topic" "gradebook_category" "gradebook_task" "gradebook_task_attachment" "gradebook_submission" "gradebook_submission_attachment" "gradebook_grade" "rubric" "rubric_criteria" "rubric_criteria_level" "rubric_association" "rubric_assessment" "rubric_assessment_criteria" "system_settings" "audit_logs" What kind of object was changed (e.g., "gradebook", "gradebook_task", "gradebook_submission")
entity_id	string The unique ID of the entity to purge logs for (e.g., "sub_456")
action	string Enum: "create" "update" "delete" "transfer" The action to purge logs for (e.g., "create", "update", "delete")
actor_id	string <uuid> (user_id) User Id
context_ip	string IP address of the actor performing the purge
start_date	string <date-time> Start date for the logs to purge (inclusive)
end_date	string <date-time> End date for the logs to purge (inclusive)

Responses

Request samples

Payload

Content type

application/json

{"entity_type": "gradebook_submission",
"entity_id": "sub_456",
"action": "update",
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"context_ip": "string",
"start_date": "2025-01-01T00:00:00Z",
"end_date": "2025-12-31T23:59:59Z"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Get Audit Log Entry

Returns a single audit log entry details.

Authorizations:

Scopes

path Parameters

log_id

required

string <uuid> (Log Id)

Log Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"timestamp": "2025-07-09T10:15:00Z",
"action": "update",
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"actor_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "say.hello@bayaraa.com",
"email": "say.hello@bayaraa.com",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://bayaraa.com",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"entity_type": "gradebook_submission",
"entity_id": "sub_456",
"entity_name": "Week 2 Homework - Batbold",
"changes": [{"field": "status",
"old_value": "missing",
"new_value": "submitted"
},
{"field": "submitted_at",
"old_value": null,
"new_value": "2025-07-08T23:59:59Z"
}
],
"context_ip": "203.91.112.14",
"context_agent": "Mozilla/5.0 (Mac)",
"context_request": "req_12345678"
}

Delete Audit Log Entry

Deletes a single audit log entry. This operation is irreversible and should be used with caution.

Authorizations:

Scopes

path Parameters

log_id

required

string <uuid> (Log Id)

Log Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Webhooks

The Webhooks API allows external systems to receive real-time notifications when specific events occur within the Gradebook system.

Developers can register webhook endpoints, subscribe to events (such as grade updates or new submissions), and receive secure HTTP POST requests when those events are triggered.

This enables automation, integration with third-party tools, and system-wide observability.

Get Registered Webhooks

Returns a list of registered webhooks that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
}
]
}

Register Webhook

Registers a new webhook for receiving real-time notifications from the Gradebook system.

When specific events such as gradebook_submission.created or gradebook_grade.updated occur, the system will send an HTTP POST request to the provided target_url with a signed JSON payload describing the event.

You can subscribe to one or more events and optionally provide a secret for securing the webhook payload using an HMAC SHA256 signature.

The webhook will remain active until deleted or deactivated. Duplicate registrations with the same URL and event types are allowed.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Register Webhook

target_url required	string <uri> (Target URL) The endpoint that will receive webhook events
events required	Array of strings List of event types to subscribe to
secret	string Optional secret used to sign webhook payloads

Responses

Request samples

Payload

Content type

application/json

{"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get Registered Webhook

Returns a single webhook details.

Authorizations:

Scopes

path Parameters

webhook_id

required

string <uuid> (Webhook Id)

Webhook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update Webhook

You can update fields of a webhook after the webhook is created. The following fields can be updated any time after the webhook is created.

Authorizations:

Scopes

path Parameters

webhook_id

required

string <uuid> (Webhook Id)

Webhook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Webhook

target_url	string <uri> (Target URL) The endpoint that will receive webhook events
events	Array of strings List of event types to subscribe to
secret	string Optional secret used to sign webhook payloads
metadata	object (Webhook Metadata) Webhook Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Patch Webhook

Updates one or more fields in a webhook. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

webhook_id

required

string <uuid> (Webhook Id)

Webhook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Webhook

target_url	string <uri> (Target URL) The endpoint that will receive webhook events
events	Array of strings List of event types to subscribe to
secret	string Optional secret used to sign webhook payloads
metadata	object (Webhook Metadata) Webhook Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Webhook

Delete registered webhook.

Authorizations:

Scopes

path Parameters

webhook_id

required

string <uuid> (Webhook Id)

Webhook Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Test Webhook

Sends a test notification to the webhook's target URL to verify its functionality. The payload will contain a sample event data structure.

Authorizations:

Scopes

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Test Webhook

event	string (webhook_event_type) Enum: "gradebook.created" "gradebook.updated" "gradebook.deleted" "gradebook_member.created" "gradebook_member.updated" "gradebook_member.deleted" "gradebook_period.created" "gradebook_period.updated" "gradebook_period.deleted" "gradebook_topic.created" "gradebook_topic.updated" "gradebook_topic.deleted" "gradebook_category.created" "gradebook_category.updated" "gradebook_category.deleted" "gradebook_task.created" "gradebook_task.updated" "gradebook_task.deleted" "gradebook_task_attachment.created" "gradebook_task_attachment.updated" "gradebook_task_attachment.deleted" "gradebook_submission.created" "gradebook_submission.updated" "gradebook_submission.deleted" "gradebook_submission_attachment.created" "gradebook_submission_attachment.updated" "gradebook_submission_attachment.deleted" "gradebook_grade.created" "gradebook_grade.updated" "gradebook_grade.deleted" "rubric.created" "rubric.updated" "rubric.deleted" "rubric_criteria.created" "rubric_criteria.updated" "rubric_criteria.deleted" "rubric_criteria_level.created" "rubric_criteria_level.updated" "rubric_criteria_level.deleted" "rubric_association.created" "rubric_association.updated" "rubric_association.deleted" "rubric_assessment.created" "rubric_assessment.updated" "rubric_assessment.deleted" "rubric_assessment_criteria.created" "rubric_assessment_criteria.updated" "rubric_assessment_criteria.deleted" "system_settings.updated" "audit_logs.created" "audit_logs.deleted" "audit_logs.purged" The type of event that triggers the webhook.
target_url	string <uri> (Target URL) The endpoint that will receive webhook events
secret	string Optional secret used to sign webhook payloads
	object The payload to send in the test webhook

Responses

Request samples

Payload

Content type

application/json

{"event": "gradebook_task.updated",
"target_url": "https://yourapp.com/webhooks",
"secret": "xyz-secret-key",
"payload": {"gradebook_id": "gb_123",
"gradebook_task_id": "task_456",
"status": "updated",
"updated_at": "2025-07-09T10:15:00Z"
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "gradebook_task.updated",
"timestamp": "2025-07-09T10:15:00Z",
"status": "success",
"response_code": 200,
"response_body": "{\"success\": true}",
"error_message": "Connection timeout",
"duration_ms": 150,
"delivery_attempts": 3,
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"webhook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
},
"payload": {"gradebook_id": "gb_123",
"gradebook_task_id": "task_456",
"status": "updated",
"updated_at": "2025-07-09T10:15:00Z"
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z"
}

Webhook Deliveries

The Webhook Deliveries API allows developers to manage the delivery of webhook events to their registered endpoints.

It provides endpoints to list, retrieve, and retry webhook deliveries, ensuring that events are successfully sent and processed by external systems.

This API is essential for monitoring webhook performance and troubleshooting delivery issues.

Get Webhook Deliveries

Returns a list of webhook delivery attempts for the specified webhook. Each delivery attempt includes the status, response code, and timestamp.

Authorizations:

Scopes

path Parameters

webhook_id

required

string <uuid> (Webhook Id)

Webhook Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "gradebook_task.updated",
"timestamp": "2025-07-09T10:15:00Z",
"status": "success",
"response_code": 200,
"response_body": "{\"success\": true}",
"error_message": "Connection timeout",
"duration_ms": 150,
"delivery_attempts": 3,
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"webhook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
},
"payload": {"gradebook_id": "gb_123",
"gradebook_task_id": "task_456",
"status": "updated",
"updated_at": "2025-07-09T10:15:00Z"
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Retry Webhook Delivery

Retries a specific webhook delivery attempt that previously failed. This can be useful for resending notifications that may have been missed due to temporary issues.

Authorizations:

Scopes

path Parameters

webhook_id required	string <uuid> (Webhook Id) Webhook Id
delivery_id required	string <uuid> (Webhook Delivery Id) Webhook Delivery Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "gradebook_task.updated",
"timestamp": "2025-07-09T10:15:00Z",
"status": "success",
"response_code": 200,
"response_body": "{\"success\": true}",
"error_message": "Connection timeout",
"duration_ms": 150,
"delivery_attempts": 3,
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"webhook_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target_url": "https://yourapp.com/webhooks",
"events": ["gradebook_task.updated",
"gradebook_submission.created"
],
"secret": "xyz-secret-key",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
"deliveries": 120,
"successful_deliveries": 110,
"failed_deliveries": 10,
"success_rate": 91.67,
"last_delivery_at": "2025-07-09T10:15:00Z",
"average_latency_ms": 248,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
},
"payload": {"gradebook_id": "gb_123",
"gradebook_task_id": "task_456",
"status": "updated",
"updated_at": "2025-07-09T10:15:00Z"
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z"
}

Webhook Events

The Webhook Events API provides a list of available webhook events that can be subscribed to.

Each event includes its name, description, and the data structure it provides. This allows developers to understand what events are available and how to handle them in their applications.

Events:

gradebook.created
gradebook.updated
gradebook.deleted
gradebook_member.created
gradebook_member.updated
gradebook_member.deleted
gradebook_group.created
gradebook_group.updated
gradebook_group.deleted
gradebook_group_member.created
gradebook_group_member.updated
gradebook_group_member.deleted
gradebook_period.created
gradebook_period.updated
gradebook_period.deleted
gradebook_topic.created
gradebook_topic.updated
gradebook_topic.deleted
gradebook_category.created
gradebook_category.updated
gradebook_category.deleted
gradebook_task.created
gradebook_task.updated
gradebook_task.deleted
gradebook_task_attachment.created
gradebook_task_attachment.updated
gradebook_task_attachment.deleted
gradebook_submission.created
gradebook_submission.updated
gradebook_submission.deleted
gradebook_submission_attachment.created
gradebook_submission_attachment.updated
gradebook_submission_attachment.deleted
gradebook_grade.created
gradebook_grade.updated
gradebook_grade.deleted
grading_scheme.created
grading_scheme.updated
grading_scheme.deleted
grading_scheme_scale.created
grading_scheme_scale.updated
grading_scheme_scale.deleted
rubric.created
rubric.updated
rubric.deleted
rubric_criteria.created
rubric_criteria.updated
rubric_criteria.deleted
rubric_criteria_level.created
rubric_criteria_level.updated
rubric_criteria_level.deleted
rubric_association.created
rubric_association.updated
rubric_association.deleted
rubric_assessment.created
rubric_assessment.updated
rubric_assessment.deleted
rubric_assessment_criteria.created
rubric_assessment_criteria.updated
rubric_assessment_criteria.deleted
system_settings.updated
audit_logs.created
audit_logs.deleted
audit_logs.purged

Get Webhook Events

Returns a list of available webhook events that can be subscribed to. Each event includes its name, description, and the data structure it provides.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"event": "gradebook_task.updated"
}
]
}

Gradebook APIs (v1)

Introduction

Endpoints

General:

Gradebook Management:

Grading Schemes:

Rubric Management:

Audit Trail:

Integration:

Server Health

Check Health

Authorizations:

Responses

Response samples

Server Settings

Get Server Settings

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Update Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Gradebooks

Get Gradebooks

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create Gradebook

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Gradebook

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update Gradebook

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Gradebook

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Gradebook

Authorizations:

path Parameters