Files API
API change historyList of APIs related to folders which contain files
Update turnitin folders
Update selected multiple turnitin folders to have the same setting.This API does not apply to non-turnitin folders.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
New folder settings
{
"folderIds": [
"string"
],
"overwritePermission": true,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"publish": true,
"feedbackReleaseDate": "string"
}{
"description": "input class when assign same folder setting for selected multiple turnitin folders",
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"folderIds": {
"description": "the ID list of selected multiple folders",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"overwritePermission": {
"description": "give new permission for all the selected folders",
"type": "boolean"
},
"access": {
"description": "Access rights defined for all selected folders, used only when overwritePermission=true",
"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"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
}
}
}{
"folderIds": [
"string"
],
"overwritePermission": true,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"publish": true,
"feedbackReleaseDate": "string"
}{
"description": "input class when assign same folder setting for selected multiple turnitin folders",
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"folderIds": {
"description": "the ID list of selected multiple folders",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"overwritePermission": {
"description": "give new permission for all the selected folders",
"type": "boolean"
},
"access": {
"description": "Access rights defined for all selected folders, used only when overwritePermission=true",
"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"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
}
}
}{
"folderIds": [
"string"
],
"overwritePermission": true,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"publish": true,
"feedbackReleaseDate": "string"
}{
"description": "input class when assign same folder setting for selected multiple turnitin folders",
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"folderIds": {
"description": "the ID list of selected multiple folders",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"overwritePermission": {
"description": "give new permission for all the selected folders",
"type": "boolean"
},
"access": {
"description": "Access rights defined for all selected folders, used only when overwritePermission=true",
"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"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
}
}
}{
"folderIds": [
"string"
],
"overwritePermission": true,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"publish": true,
"feedbackReleaseDate": "string"
}{
"description": "input class when assign same folder setting for selected multiple turnitin folders",
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"folderIds": {
"description": "the ID list of selected multiple folders",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"overwritePermission": {
"description": "give new permission for all the selected folders",
"type": "boolean"
},
"access": {
"description": "Access rights defined for all selected folders, used only when overwritePermission=true",
"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"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
}
}
}Responses
200 OK
Success
Representations
{
"type": "array",
"items": {
"description": "returned folder information",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the record",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the record",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the record",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the record",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the record",
"type": "string"
},
"name": {
"description": "the name/title of the resource",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"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"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
},
"isActive": {
"description": "Indicate whether the folder is open or close",
"type": "boolean",
"readOnly": true
},
"parentFolderPath": {
"description": "path of parent folder when populated",
"type": "string"
},
"sortFilesBy": {
"description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
"type": "string"
},
"allowUpload": {
"description": "flag to indicate whether students are allowed to submit documents to this folder",
"type": "boolean"
},
"uploadDisplayOption": {
"description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
"type": "string"
},
"viewAll": {
"description": "flag to indicate whether students can view documents uploaded by others",
"type": "boolean"
},
"folderScore": {
"format": "double",
"description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
"type": "number"
},
"allowComments": {
"description": "allow student to comment",
"type": "boolean"
},
"allowAnnotate": {
"description": "allow student to view annotations, create annotations, reply annotations.",
"type": "boolean"
},
"submissionDeadline": {
"format": "date-time",
"description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
"type": "string"
},
"allowLateSubmission": {
"description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
"type": "boolean"
},
"isTurnitinFolder": {
"description": "true measn this folder is a turnitin submission folder",
"type": "boolean"
},
"allowedFileType": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"type": "string"
}
},
"allowedSubmissionFileTypes": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"description": "Name of the restrited file type",
"required": [
"fileTypeName"
],
"type": "object",
"properties": {
"fileTypeName": {
"description": "Name of the file type",
"type": "string"
},
"extensions": {
"description": "file type extensions",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"name": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"feedbackReleaseDate": "string",
"isActive": true,
"parentFolderPath": "string",
"sortFilesBy": "string",
"allowUpload": true,
"uploadDisplayOption": "string",
"viewAll": true,
"folderScore": 0.0,
"allowComments": true,
"allowAnnotate": true,
"submissionDeadline": "string",
"allowLateSubmission": true,
"isTurnitinFolder": true,
"allowedFileType": [
"string"
],
"allowedSubmissionFileTypes": [
{
"fileTypeName": "string",
"extensions": [
"string"
]
}
]
}
]{
"type": "array",
"items": {
"description": "returned folder information",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the record",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the record",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the record",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the record",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the record",
"type": "string"
},
"name": {
"description": "the name/title of the resource",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"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"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
},
"isActive": {
"description": "Indicate whether the folder is open or close",
"type": "boolean",
"readOnly": true
},
"parentFolderPath": {
"description": "path of parent folder when populated",
"type": "string"
},
"sortFilesBy": {
"description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
"type": "string"
},
"allowUpload": {
"description": "flag to indicate whether students are allowed to submit documents to this folder",
"type": "boolean"
},
"uploadDisplayOption": {
"description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
"type": "string"
},
"viewAll": {
"description": "flag to indicate whether students can view documents uploaded by others",
"type": "boolean"
},
"folderScore": {
"format": "double",
"description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
"type": "number"
},
"allowComments": {
"description": "allow student to comment",
"type": "boolean"
},
"allowAnnotate": {
"description": "allow student to view annotations, create annotations, reply annotations.",
"type": "boolean"
},
"submissionDeadline": {
"format": "date-time",
"description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
"type": "string"
},
"allowLateSubmission": {
"description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
"type": "boolean"
},
"isTurnitinFolder": {
"description": "true measn this folder is a turnitin submission folder",
"type": "boolean"
},
"allowedFileType": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"type": "string"
}
},
"allowedSubmissionFileTypes": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"description": "Name of the restrited file type",
"required": [
"fileTypeName"
],
"type": "object",
"properties": {
"fileTypeName": {
"description": "Name of the file type",
"type": "string"
},
"extensions": {
"description": "file type extensions",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"name": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"feedbackReleaseDate": "string",
"isActive": true,
"parentFolderPath": "string",
"sortFilesBy": "string",
"allowUpload": true,
"uploadDisplayOption": "string",
"viewAll": true,
"folderScore": 0.0,
"allowComments": true,
"allowAnnotate": true,
"submissionDeadline": "string",
"allowLateSubmission": true,
"isTurnitinFolder": true,
"allowedFileType": [
"string"
],
"allowedSubmissionFileTypes": [
{
"fileTypeName": "string",
"extensions": [
"string"
]
}
]
}
]{
"type": "array",
"items": {
"description": "returned folder information",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the record",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the record",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the record",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the record",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the record",
"type": "string"
},
"name": {
"description": "the name/title of the resource",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this resource is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this resource is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"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"
},
"feedbackReleaseDate": {
"format": "date-time",
"description": "the feedback release date used for turnitin folder.",
"type": "string"
},
"isActive": {
"description": "Indicate whether the folder is open or close",
"type": "boolean",
"readOnly": true
},
"parentFolderPath": {
"description": "path of parent folder when populated",
"type": "string"
},
"sortFilesBy": {
"description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
"type": "string"
},
"allowUpload": {
"description": "flag to indicate whether students are allowed to submit documents to this folder",
"type": "boolean"
},
"uploadDisplayOption": {
"description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
"type": "string"
},
"viewAll": {
"description": "flag to indicate whether students can view documents uploaded by others",
"type": "boolean"
},
"folderScore": {
"format": "double",
"description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
"type": "number"
},
"allowComments": {
"description": "allow student to comment",
"type": "boolean"
},
"allowAnnotate": {
"description": "allow student to view annotations, create annotations, reply annotations.",
"type": "boolean"
},
"submissionDeadline": {
"format": "date-time",
"description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
"type": "string"
},
"allowLateSubmission": {
"description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
"type": "boolean"
},
"isTurnitinFolder": {
"description": "true measn this folder is a turnitin submission folder",
"type": "boolean"
},
"allowedFileType": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"type": "string"
}
},
"allowedSubmissionFileTypes": {
"description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
"type": "array",
"items": {
"description": "Name of the restrited file type",
"required": [
"fileTypeName"
],
"type": "object",
"properties": {
"fileTypeName": {
"description": "Name of the file type",
"type": "string"
},
"extensions": {
"description": "file type extensions",
"type": "array",
"items": {
"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"
}201 Created
Returns updated Folders information
Representations
404 Not Found
All folders are not found
Representations
Code samples
@ECHO OFF
curl -v -X PUT "https://luminus.azure-api.net/files/turnitin_multiple"
-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/turnitin_multiple?" + 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.PutAsync(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/turnitin_multiple");
URI uri = builder.build();
HttpPut request = new HttpPut(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/turnitin_multiple?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// 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/turnitin_multiple";
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:@"PUT"];
// 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/turnitin_multiple');
$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_PUT);
// 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("PUT", "/files/turnitin_multiple?%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("PUT", "/files/turnitin_multiple?%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/turnitin_multiple')
request = Net::HTTP::Put.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