AssessmentServiceRest Resource

Assessment (LMS)

Available Since
1.6.0

POST /2.0/lms/assessment/create

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

Create a Assessment

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

Request JSON (example):


 {
 	"name" : "Name Assessment", // Name of Assessment (required)
 	"description" : "Description Assessment", // Description of Assessment (required)
 	"evaluationMonitored": false,
 	"monitorsIds": [10,15, 20], // IDs of monitors of assessment (fluig id)
 	"showScores": false, // Show score
 	"showApprovalStatus": false, // Show approval status
 	"showPerformanceOnQuestions": false, // Show performance on questions
 	"showCorrectAnswers": false, // Show correct answers
 	"solicitFeedbackEvaluation": false, // Solicit feedback evaluations
 	"allowCommentsOnQuestions": false, // Allow comments on questions
 	"anonymous": false, // Anonymous assessment
 	"showConclusionMessage": false, // Show conclusion message
 	"conclusionMessage": "Message of conclusion of assessment", // Conclusion message
 	"correctorsIds": [10,15,20], // IDs of correctors of assessment (fluig id)
 	"requiredAllQuestions": false, // Required all questions
 	"requiredScore" : "70.00", // Minimum required score for approval
 	"maxExecutionTime": 10, // Max execution time
 	"minExecutionTime": 0, // Min execution time
 	"allowEssayQuestion": false, // Allow essay questions in assessment
 	"allowRestartAppFromCheckpoint": true, // Allow restart assessment application from last checkpoint (optional, default is true)
 	"keepExistingAssessmentBlockVersion": true, // Keep all existing assessment block version (optional, used for editing, default is true)
 	"assessmentBlockVersions": [ // Block version setup
 		{
 			"blockId": 193, // Block id (required)
 			"assessmentBlockVersionId": null, // Assessment block version id (optional, used only for editing)
 			"weight": 1, // Block weigth (optional, default is 1)
 			"order": 0, // order that will be presented on the assessment application (optional, default is 0)
 			"allQuestionsRequired": false, // Required to answer all block question (optional, default is false)
 			"requiredScore": "61.00", // Minimum score (optional)
 			"allowsZero": false, // Allow score 0 (required, default is false)
 			"numberRandomQuestions":10, //Number of questions random.
 			"selectQuestions":"ALL", // Type of question selection ( "All", "SOME_SELECTED", "SOME_RANDOM")
 			"questionVersionIds":[38, 44], // List of selected questions (when the selectQuestions is "SOME_SELECTED")
 			"topicFilters":[ //list of question selections filter (if block is not reusable - optional)
 					{
 					"topicId":106, //topic id
 					"type":"ADD", //Type filter
 					"difficultyStart":0, //difficulty start filter
 					"difficultyEnd":5, //difficulty end filter
 					"tags":"spanish english" //tags filter
 					}
 				]
 			}
 	],
 	"enabled": true, // Assessment is enabled (default is true),
 	"imageProperties": {  // Defines images properties for the crop operation
 		 "imageName": "asessment_image.png", // File must already be on the learn user upload directory. Acceptable image types: JPG,JPGE,PNG,GIF
 		 "coordinateX": "0", // Set the pixel x coordinate
 		 "coordinateY": "0", // Set the pixel y coordinate
 		 "width": "500", // Set the width of the image in pixels
 		 "height": "500" // Set the height of the image in pixels
 	 }
 }
 
Response Body
media type data type description
application/json object (JSON)
This method return HTTP 200 status, Object AssessmentVO
{ content: { "id" : 192, "name" : "Name Assessment", // Name of Assessment (required) "description" : "Description Assessment", // Description of Assessment (required) "evaluationMonitored": false, "monitorsIds": [10,15, 20], // IDs of monitors of assessment (fluig id) "showScores": false, // Show score "showApprovalStatus": false, // Show approval status "showPerformanceOnQuestions": false, // Show performance on questions "showCorrectAnswers": false, // Show correct answers "solicitFeedbackEvaluation": false, // Solicit feedback evaluations "allowCommentsOnQuestions": false, // Allow comments on questions "anonymous": false, // Anonymous assessment "showConclusionMessage": false, // Show conclusion message "conclusionMessage": "Message of conclusion of assessment", // Conclusion message "correctorsIds": [10,15,20], // IDs of correctors of assessment (fluig id) "requiredAllQuestions": false, // Required all questions "requiredScore" : "70.00", // Minimum required score for approval "maxExecutionTime": 10, // Max execution time "minExecutionTime": 0, // Min execution time "allowEssayQuestion": false, // Allow essay questions in assessment "allowRestartAppFromCheckpoint": true, // Allow restart assessment application from last checkpoint (optional, default is true) "keepExistingAssessmentBlockVersion": true, // Keep all existing assessment block version (optional, used for editing, default is true) "assessmentBlockVersions": [ // Block version setup { "blockId": 193, // Block id (required) "assessmentBlockVersionId": null, // Assessment block version id (optional, used only for editing) "weight": 1, // Block weigth (optional, default is 1) "order": 0, // order that will be presented on the assessment application (optional, default is 0) "allQuestionsRequired": false, // Required to answer all block question (optional, default is false) "requiredScore": "61.00", // Minimum score (optional) "allowsZero": false, // Allow score 0 (required, default is false) "numberRandomQuestions":10, //Number of questions random. "selectQuestions":"ALL", // Type of question selection ( "All", "SOME_SELECTED", "SOME_RANDOM") "questionVersionIds":[38, 44], // List of selected questions (when the selectQuestions is "SOME_SELECTED") "topicFilters":[ //list of question selections filter { "id": 1931 // id Filter (required) "topicId":106, //topic id "type":"ADD", //Type filter "difficultyStart":0, //difficulty start filter "difficultyEnd":5, //difficulty end filter "tags":"spanish english" //tags filter } ] } ], "enabled": true, // Enabled assessment, "imageProperties": { "imageName": "track_image.png", "coordinateX": "0", "coordinateY": "0", "width": "500", "height": "500" } message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/assessment/edit

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

Edit a Assessment

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

Request JSON (example):


 {
 	"id" : 192,
 	"name" : "Name Assessment", // Name of Assessment (required)
 	"description" : "Description Assessment", // Description of Assessment (required)
 	"evaluationMonitored": false,
 	"monitorsIds": [10,15, 20], // IDs of monitors of assessment (fluig id)
 	"showScores": false, // Show score
 	"showApprovalStatus": false, // Show approval status
 	"showPerformanceOnQuestions": false, // Show performance on questions
 	"showCorrectAnswers": false, // Show correct answers
 	"solicitFeedbackEvaluation": false, // Solicit feedback evaluations
 	"allowCommentsOnQuestions": false, // Allow comments on questions
 	"anonymous": false, // Anonymous assessment
 	"showConclusionMessage": false, // Show conclusion message
 	"conclusionMessage": "Message of conclusion of assessment", // Conclusion message
 	"correctorsIds": [10,15,20], // IDs of correctors of assessment (fluig id)
 	"requiredAllQuestions": false, // Required all questions
 	"requiredScore" : "70.00", // Minimum required score for approval
 	"maxExecutionTime": 10, // Max execution time
 	"minExecutionTime": 0, // Min execution time
 	"allowEssayQuestion": false, // Allow essay questions in assessment
 	"allowRestartAppFromCheckpoint": true, // Allow restart assessment application from last checkpoint (optional, default is true)
 	"keepExistingAssessmentBlockVersion": true, // Keep all existing assessment block version (optional, used for editing, default is true)
 	"assessmentBlockVersions": [ // Block version setup
 		{
 			"blockId": 193, // Block id (required)
 			"assessmentBlockVersionId": null, // Assessment block version id (optional, used only for editing)
 			"weight": 1, // Block weigth (optional, default is 1)
 			"order": 0, // order that will be presented on the assessment application (optional, default is 0)
 			"allQuestionsRequired": false, // Required to answer all block question (optional, default is false)
 			"requiredScore": "61.00", // Minimum score (optional)
 			"allowsZero": false, // Allow score 0 (required, default is false)
 			"numberRandomQuestions":10, //Number of questions random.
 			"selectQuestions":"ALL", // Type of question selection ( "All", "SOME_SELECTED", "SOME_RANDOM")
 			"questionVersionIds":[38, 44], // List of selected questions (when the selectQuestions is "SOME_SELECTED")
 			"topicFilters":[ //list of question selections filter
 				{
 				"id": 1931 // id Filter
 				"topicId":106, //topic id
 				"type":"ADD", //Type filter
 				"difficultyStart":0, //difficulty start filter
 				"difficultyEnd":5, //difficulty end filter
 				"tags":"spanish english" //tags filter
 				}
 			 ]
 			}
 	],
 	"enabled": true, // Assessment is enabled (default is true),
 	"imageProperties": {  // Defines images properties for the crop operation
 		 "imageName": "asessment_image.png", // File must already be on the learn user upload directory. Acceptable image types: JPG,JPGE,PNG,GIF
 		 "coordinateX": "0", // Set the pixel x coordinate
 		 "coordinateY": "0", // Set the pixel y coordinate
 		 "width": "500", // Set the width of the image in pixels
 		 "height": "500" // Set the height of the image in pixels
 	 }
 }
 
Response Body
media type data type description
application/json object (JSON)
This method return HTTP 200 status, Object AssessmentVO
{ content: { "id" : 192, "name" : "Name Assessment", // Name of Assessment (required) "description" : "Description Assessment", // Description of Assessment (required) "evaluationMonitored": false, "monitorsIds": [10,15, 20], // IDs of monitors of assessment (fluig id) "showScores": false, // Show score "showApprovalStatus": false, // Show approval status "showPerformanceOnQuestions": false, // Show performance on questions "showCorrectAnswers": false, // Show correct answers "solicitFeedbackEvaluation": false, // Solicit feedback evaluations "allowCommentsOnQuestions": false, // Allow comments on questions "anonymous": false, // Anonymous assessment "showConclusionMessage": false, // Show conclusion message "conclusionMessage": "Message of conclusion of assessment", // Conclusion message "correctorsIds": [10,15,20], // IDs of correctors of assessment (fluig id) "requiredAllQuestions": false, // Required all questions "requiredScore" : "70.00", // Minimum required score for approval "maxExecutionTime": 10, // Max execution time "minExecutionTime": 0, // Min execution time "allowEssayQuestion": false, // Allow essay questions in assessment "allowRestartAppFromCheckpoint": true, // Allow restart assessment application from last checkpoint (optional, default is true) "keepExistingAssessmentBlockVersion": true, // Keep all existing assessment block version (optional, used for editing, default is true) "assessmentBlockVersions": [ // Block version setup { "blockId": 193, // Block id (required) "assessmentBlockVersionId": null, // Assessment block version id (optional, used only for editing) "weight": 1, // Block weigth (optional, default is 1) "order": 0, // order that will be presented on the assessment application (optional, default is 0) "allQuestionsRequired": false, // Required to answer all block question (optional, default is false) "requiredScore": "61.00", // Minimum score (optional) "numberRandomQuestions":10, //Number of questions random. "selectQuestions":"ALL", // Type of question selection ( "All", "SOME_SELECTED", "SOME_RANDOM") "questionVersionIds":[38, 44], // List of selected questions (when the selectQuestions is "SOME_SELECTED") "topicFilters":[ //list of question selections filter { "topicId":106, //topic id "type":"ADD", //Type filter "difficultyStart":0, //difficulty start filter "difficultyEnd":5, //difficulty end filter "tags":"spanish english" //tags filter } ] } ], "enabled": true, // Enabled assessment, "imageProperties": { "imageName": "track_image.png", "coordinateX": "0", "coordinateY": "0", "width": "500", "height": "500" } message: { message: "OK", detail: "OK", type: "INFO" } } }
Available Since
1.6

POST /2.0/lms/assessment/delete/{assessmentId}

This method has been deprecated. Use PUT /lms/api/v0/assessments/{assessmentId} instead.

Delete the Assessment

Available Since
1.6
Request Parameters
name type description constraints
assessmentId path
REQUIRED
Assessment 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/assessment/release

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

Releases the version of the assessment that is being edited

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

Request JSON (example):


 {
 	"id" : 192, // id of assessment (required)
 	"releaseNotes" : "Release Notes" // Release Notes (required)
 }
 
Response Body
media type data type description
application/json object (JSON)
This method return HTTP 200 status and the assessment version id
{ "content": 193, // Assessment version id "message": null }