Files API
API change historyList of APIs related to folders which contain files
Export to gradebook
Export student marks in submission folder to gradebook. This api does not applicable to turnitin folder.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Export to gradebook form
{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"parentID": "string",
"importResource": [
"string"
],
"importType": "string",
"name": "string",
"itemDesc": "string",
"categoryName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string"
}{
"description": "Input class for importing to grade item from tool(s)",
"required": [
"importResource",
"importType",
"name",
"parentID",
"showAverageMedian",
"showGrade",
"showHighLow",
"showMark",
"showPercentile",
"showRemark",
"showRubrics",
"studentDisplayType"
],
"type": "object",
"properties": {
"access": {
"description": "Access rights for graded item, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for Graded Item",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"parentID": {
"format": "uuid",
"description": "Parent ID of the Grade Item => the ID of the Module resource",
"type": "string"
},
"importResource": {
"description": "IDs of the resources which the grade item is importing from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"importType": {
"description": "Import type for the imported tool (Assessment/Quiz or Files). L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"name": {
"description": "Grade Item Title",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"itemDesc": {
"description": "Grade Item Description",
"type": "string"
},
"categoryName": {
"description": "The name of the category which the grade item belongs to",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
}
}
}{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"parentID": "string",
"importResource": [
"string"
],
"importType": "string",
"name": "string",
"itemDesc": "string",
"categoryName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string"
}{
"description": "Input class for importing to grade item from tool(s)",
"required": [
"importResource",
"importType",
"name",
"parentID",
"showAverageMedian",
"showGrade",
"showHighLow",
"showMark",
"showPercentile",
"showRemark",
"showRubrics",
"studentDisplayType"
],
"type": "object",
"properties": {
"access": {
"description": "Access rights for graded item, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for Graded Item",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"parentID": {
"format": "uuid",
"description": "Parent ID of the Grade Item => the ID of the Module resource",
"type": "string"
},
"importResource": {
"description": "IDs of the resources which the grade item is importing from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"importType": {
"description": "Import type for the imported tool (Assessment/Quiz or Files). L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"name": {
"description": "Grade Item Title",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"itemDesc": {
"description": "Grade Item Description",
"type": "string"
},
"categoryName": {
"description": "The name of the category which the grade item belongs to",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
}
}
}{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"parentID": "string",
"importResource": [
"string"
],
"importType": "string",
"name": "string",
"itemDesc": "string",
"categoryName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string"
}{
"description": "Input class for importing to grade item from tool(s)",
"required": [
"importResource",
"importType",
"name",
"parentID",
"showAverageMedian",
"showGrade",
"showHighLow",
"showMark",
"showPercentile",
"showRemark",
"showRubrics",
"studentDisplayType"
],
"type": "object",
"properties": {
"access": {
"description": "Access rights for graded item, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for Graded Item",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"parentID": {
"format": "uuid",
"description": "Parent ID of the Grade Item => the ID of the Module resource",
"type": "string"
},
"importResource": {
"description": "IDs of the resources which the grade item is importing from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"importType": {
"description": "Import type for the imported tool (Assessment/Quiz or Files). L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"name": {
"description": "Grade Item Title",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"itemDesc": {
"description": "Grade Item Description",
"type": "string"
},
"categoryName": {
"description": "The name of the category which the grade item belongs to",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
}
}
}{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"parentID": "string",
"importResource": [
"string"
],
"importType": "string",
"name": "string",
"itemDesc": "string",
"categoryName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string"
}{
"description": "Input class for importing to grade item from tool(s)",
"required": [
"importResource",
"importType",
"name",
"parentID",
"showAverageMedian",
"showGrade",
"showHighLow",
"showMark",
"showPercentile",
"showRemark",
"showRubrics",
"studentDisplayType"
],
"type": "object",
"properties": {
"access": {
"description": "Access rights for graded item, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for Graded Item",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"parentID": {
"format": "uuid",
"description": "Parent ID of the Grade Item => the ID of the Module resource",
"type": "string"
},
"importResource": {
"description": "IDs of the resources which the grade item is importing from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"importType": {
"description": "Import type for the imported tool (Assessment/Quiz or Files). L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"name": {
"description": "Grade Item Title",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"itemDesc": {
"description": "Grade Item Description",
"type": "string"
},
"categoryName": {
"description": "The name of the category which the grade item belongs to",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
}
}
}Responses
201 Created
The exported gradebook item
Representations
{
"description": "Grade Item",
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Grade Item ID",
"type": "string"
},
"name": {
"description": "The Grade Item Name",
"type": "string"
},
"access": {
"description": "Grade Item access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"description": "The date this grade item is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this grade item",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the grade item",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the grade item",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the grade item",
"type": "string"
},
"readonlyAccess": {
"description": "whether the login user has read only access",
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this grade item is last edited",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this grade item",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the grade item",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this grade item is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this grade item is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the grade item is published to students.",
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"itemDesc": {
"description": "Description of the grade item",
"type": "string"
},
"weightage": {
"format": "float",
"description": "Weightage of the grade item",
"type": "number"
},
"maxMark": {
"format": "float",
"description": "Maximum mark of the Grade Item",
"type": "number"
},
"importResource": {
"description": "IDs of the resources which the grade item is imported from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"description": "Tool which is imported from. A = Assessment/Quiz; F = Files",
"type": "string"
},
"toolTypeName": {
"description": "Text for ToolType",
"type": "string",
"readOnly": true
},
"importType": {
"description": "Import type for the imported tool. L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"importTypeName": {
"description": "Text for ImportType",
"type": "string",
"readOnly": true
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"scoreByMarks": {
"description": "Whether scoring of the grade item for the students is by marks or by rubrics. \r\nThe grades will be computed based on the grading schema with the entered mark.",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
},
"rubricID": {
"format": "uuid",
"description": "Rubric ID",
"type": "string"
}
}
}{
"id": "string",
"name": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"readonlyAccess": true,
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"itemDesc": "string",
"weightage": 0.0,
"maxMark": 0.0,
"importResource": [
"string"
],
"toolType": "string",
"toolTypeName": "string",
"importType": "string",
"importTypeName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"scoreByMarks": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string",
"rubricID": "string"
}{
"description": "Grade Item",
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Grade Item ID",
"type": "string"
},
"name": {
"description": "The Grade Item Name",
"type": "string"
},
"access": {
"description": "Grade Item access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"description": "The date this grade item is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this grade item",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the grade item",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the grade item",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the grade item",
"type": "string"
},
"readonlyAccess": {
"description": "whether the login user has read only access",
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this grade item is last edited",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this grade item",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the grade item",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this grade item is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this grade item is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the grade item is published to students.",
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"itemDesc": {
"description": "Description of the grade item",
"type": "string"
},
"weightage": {
"format": "float",
"description": "Weightage of the grade item",
"type": "number"
},
"maxMark": {
"format": "float",
"description": "Maximum mark of the Grade Item",
"type": "number"
},
"importResource": {
"description": "IDs of the resources which the grade item is imported from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"description": "Tool which is imported from. A = Assessment/Quiz; F = Files",
"type": "string"
},
"toolTypeName": {
"description": "Text for ToolType",
"type": "string",
"readOnly": true
},
"importType": {
"description": "Import type for the imported tool. L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"importTypeName": {
"description": "Text for ImportType",
"type": "string",
"readOnly": true
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"scoreByMarks": {
"description": "Whether scoring of the grade item for the students is by marks or by rubrics. \r\nThe grades will be computed based on the grading schema with the entered mark.",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
},
"rubricID": {
"format": "uuid",
"description": "Rubric ID",
"type": "string"
}
}
}{
"id": "string",
"name": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"readonlyAccess": true,
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"itemDesc": "string",
"weightage": 0.0,
"maxMark": 0.0,
"importResource": [
"string"
],
"toolType": "string",
"toolTypeName": "string",
"importType": "string",
"importTypeName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"scoreByMarks": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string",
"rubricID": "string"
}{
"description": "Grade Item",
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Grade Item ID",
"type": "string"
},
"name": {
"description": "The Grade Item Name",
"type": "string"
},
"access": {
"description": "Grade Item access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"description": "The date this grade item is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this grade item",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the grade item",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the grade item",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the grade item",
"type": "string"
},
"readonlyAccess": {
"description": "whether the login user has read only access",
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this grade item is last edited",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this grade item",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the grade item",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the grade item",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this grade item is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this grade item is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the grade item is published to students.",
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
"type": "string"
},
"itemDesc": {
"description": "Description of the grade item",
"type": "string"
},
"weightage": {
"format": "float",
"description": "Weightage of the grade item",
"type": "number"
},
"maxMark": {
"format": "float",
"description": "Maximum mark of the Grade Item",
"type": "number"
},
"importResource": {
"description": "IDs of the resources which the grade item is imported from",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"description": "Tool which is imported from. A = Assessment/Quiz; F = Files",
"type": "string"
},
"toolTypeName": {
"description": "Text for ToolType",
"type": "string",
"readOnly": true
},
"importType": {
"description": "Import type for the imported tool. L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt",
"type": "string"
},
"importTypeName": {
"description": "Text for ImportType",
"type": "string",
"readOnly": true
},
"showMark": {
"description": "Whether to display the marks of the Grade Item",
"type": "boolean"
},
"showRemark": {
"description": "Whether to display the student remarks of the Grade Item",
"type": "boolean"
},
"showGrade": {
"description": "Whether to display the student grades of the Grade Item",
"type": "boolean"
},
"showRubrics": {
"description": "Whether to display the student rubrics of the Grade Item",
"type": "boolean"
},
"showHighLow": {
"description": "Whether to display the highest and lowest marks for the grade item",
"type": "boolean"
},
"showPercentile": {
"description": "Whether to display the 25 and 75 percentile for the grade item",
"type": "boolean"
},
"showAverageMedian": {
"description": "Whether to display the average and median marks of the grade item",
"type": "boolean"
},
"scoreByMarks": {
"description": "Whether scoring of the grade item for the students is by marks or by rubrics. \r\nThe grades will be computed based on the grading schema with the entered mark.",
"type": "boolean"
},
"gradingSchema": {
"description": "Grading Schema for the grade item. Letter grades and its respectives max marks.\r\nGrades will be computed based on the grading schema with the entered mark.",
"type": "array",
"items": {
"description": "Grading Schema for the Gradebook (deprecated)",
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"description": "Letter grade",
"type": "string"
},
"maxMark": {
"format": "float",
"description": "Maximum mark for the letter grade",
"type": "number"
}
}
}
},
"studentDisplayType": {
"description": "When marking, the display of the student for the Grade Item. Values: Student Name (N), Student Number (M)",
"type": "string"
},
"rubricID": {
"format": "uuid",
"description": "Rubric ID",
"type": "string"
}
}
}400 Bad Request
Bad Request
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}403 Forbidden
Login user not authorized to perform this action
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}500 Internal Server Error
Server Error
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}Code samples
@ECHO OFF
curl -v -X POST "https://luminus.azure-api.net/files/exportToGradebook"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://luminus.azure-api.net/files/exportToGradebook?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/files/exportToGradebook");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json-patch+json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://luminus.azure-api.net/files/exportToGradebook?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://luminus.azure-api.net/files/exportToGradebook";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://luminus.azure-api.net/files/exportToGradebook');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/files/exportToGradebook?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/files/exportToGradebook?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://luminus.azure-api.net/files/exportToGradebook')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body