AssessmentTopicServiceRest Resource

Assessment Topic (LMS)

Available Since
1.6.0

POST /2.0/lms/assessmenttopic/create

This method has been deprecated. Use POST /lms/api/v0/assessmenttopics/ instead

Create a Assessment Topic

Available Since
1.6.0
Request Body
media type data type description
application/json AssessmentTopicApiVO (JSON)

Request JSON (example):


 {
 	"title" : "Title Assessment Topic", // Title (required)
 	"description" : "Description Assessment Topic", // Description (required)
 	"parentItemId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT"
 	"securityPermission": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ]
 }
 
Response Body
media type data type description
application/json object (JSON)
This method return HTTP 200 status, Object AssessmentTopicApiVO
{ content: { "id" : 192, "name" : "Title Assessment Topic", "description" : "Description Assessment Topic", "parentItemId": 10, "inheritPermissions" : "INHERIT" "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ]}, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/assessmenttopic/edit

This method has been deprecated. Use PUT /lms/api/v0/assessmenttopics/ instead

Update a Assessment Topic

Available Since
1.6.0
Request Body
media type data type description
application/json AssessmentTopicApiVO (JSON)

Request JSON (example):


 {
 	"id" : 192, // Assessment Topic ID
 	"title" : "Assessment Topic Title", // Name (required)
 	"description" : "Assessment Topic Description", // Assessment Topic description (required)
 	"parentItemId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT"
 	"securityPermission": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ]
 }
 
Response Body
media type data type description
application/json object (JSON)
This method return HTTP 200 status, Object AssessmentTopicApiVO
{ content: { "id" : 192, "name" : "Title Assessment Topic", "description" : "Description Assessment Topic", "parentItemId": 10, "inheritPermissions" : "INHERIT" "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ]}, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.5.6

POST /2.0/lms/assessmenttopic/delete/{assessmentTopicId}

This method has been deprecated. Use DELETE /lms/api/v0/assessmenttopics/{id} instead

Delete the Assessment Topic

Available Since
1.5.6
Request Parameters
name type description constraints
assessmentTopicId path
REQUIRED
AssessmentTopic ID
long
Response Body
media type data type description
application/json object (JSON)

Response JSON (example):


 {
 	"content": "OK",
 	"message": null
 }
Available Since
1.6.0

POST /2.0/lms/assessmenttopic/move/{assessmentTopicId}/{destinationId}

This method has been deprecated. Use POST /lms/api/v0/assessmenttopics/move/{id}/{destinationId} instead

Move a AssessmentTopic to another AssessmentTopic

Available Since
1.6.0
Request Parameters
name type description constraints
assessmentTopicId path ID Topic to be moved long
destinationId path destination folder ID long
Response Body
media type data type
application/json object (JSON)