LacunaQuestionServiceRest Resource

Lacuna questions (LMS)

Available Since
1.6.0

POST /2.0/lms/lacunaquestion/create

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

Create a Lacuna Question

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

Request JSON (example):


 {
 	"question" : "Description of Question ### and ###", // Description of Question (required)
 	"title" : "Title", // Title of Question (required)
 	"difficulty" : 1, // Difficulty (required)
 	"source": "source of question", // Source of Question (required)
 	"author": "jack", // Author of Question (required)
 	"tags": "lms ams elearning java", // Tags of Question (optional)
 	"topicId": 10, // Topic Id is parent item of Question (required)
 	"assessWhole": false, //Assesses the issue as a whole (optional)
 	"dropDown": false, // View list format (optional)
 	"disabled": false, // Disabled question (optional)
 	"disableHTML": false, // Disable html in question description. Default is false (optional)
 	"lacunaAlternatives": [  // Defines the lacuna alternatives for the Question (required)
 		{
 			"alternatives": [ //(required)
 				{
 					"description": "alternative 1, lacuna 1", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				},{
 					"description": "alternative 2, lacuna 1", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				}
 			]
 		},
 		{
 			"alternatives": [ //(required)
 				{
 					"description": "alternative 1, lacuna 2", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				},{
 					"description": "alternative 2, lacuna 2", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				}
 			]
 		}
 	],
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT" (required)
 	"securityPermission": [  // Defines the security configurations for the Question (required)
 		{
 			"partyId": 193, // Party ID (required)
 			"roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		}
 	],
 	"securityRestriction": [  // Defines the security configurations for the Question (required)
 		{
 			"partyId": 193, // Party ID (required)
 			"roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		}
 	]
 }
 
Response Body
media type data type description
application/json object (JSON)

     This method return HTTP 200 status and Object LacunaQuestionVO
{ content: { "id" : 1, "question" : "Description of Question ### and ###", "title" : "Title", "difficulty" : 1, "source": "source of question", "author": "jack", "tags": "lms, ams, elearning, java", "topicId": 10, "assessWhole": false, "dropDown": false, "disabled": false, "lacunaAlternatives": [ { "alternatives": [ { "description": "alternative 1, lacuna 1", "score": 10 },{ "description": "alternative 2, lacuna 1", "score": 10 } ] }, { "alternatives": [ { "description": "alternative 1, lacuna 2", "score": 10 },{ "description": "alternative 2, lacuna 2", "score": 10 } ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ], "inheritPermissions" : "INHERIT" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/lacunaquestion/edit

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

Edit a Lacuna Question

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

Request JSON (example):


 {
 	"id" : "Id of Question ###", // Id of Question (required)
 	"question" : "Description of Question ### and ###", // Description of Question (required)
 	"title" : "Title", // Title of Question (required)
 	"difficulty" : 1, // Difficulty (required)
 	"source": "source of question", // Source of Question (required)
 	"author": "jack", // Author of Question (required)
 	"tags": "lms ams elearning java", // Tags of Question (optional)
 	"topicId": 10, // Topic Id is parent item of Question (required)
 	"assessWhole": false, //Assesses the issue as a whole (optional)
 	"dropDown": false, // View list format (optional)
 	"disabled": false, // Disabled question (optional)
 	"lacunaAlternatives": [  // Defines the lacuna alternatives for the Question (required)
 		{
 			"alternatives": [ //(required)
 				{
 					"description": "alternative 1, lacuna 1", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				},{
 					"description": "alternative 2, lacuna 1", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				}
 			]
 		},
 		{
 			"alternatives": [ //(required)
 				{
 					"description": "alternative 1, lacuna 2", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				},{
 					"description": "alternative 2, lacuna 2", // Alternative description (required)
 					"score": 10 // Alternative score (required)
 				}
 			]
 		}
 	],
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT" (required)
 	"securityPermission": [  // Defines the security configurations for the Question (required)
 		{
 			"partyId": 193, // Party ID (required)
 			"roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		}
 	],
 	"securityRestriction": [  // Defines the security configurations for the Question (required)
 		{
 			"partyId": 193, // Party ID (required)
 			"roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		}
 	]
 }
 
Response Body
media type data type description
application/json object (JSON)

     This method return HTTP 200 status and Object LacunaQuestionVO
{ content: { "id" : 1, "question" : "Description of Question ### and ###", "title" : "Title", "difficulty" : 1, "source": "source of question", "author": "jack", "tags": "lms, ams, elearning, java", "topicId": 10, "assessWhole": false, "dropDown": false, "disabled": false, "lacunaAlternatives": [ { "alternatives": [ { "description": "alternative 1, lacuna 1", "score": 10 },{ "description": "alternative 2, lacuna 1", "score": 10 } ] }, { "alternatives": [ { "description": "alternative 1, lacuna 2", "score": 10 },{ "description": "alternative 2, lacuna 2", "score": 10 } ] } ], "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ], "inheritPermissions" : "INHERIT" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/lacunaquestion/delete/{questionId}

This method has been deprecated. Use DELETE /lms/api/v0/lacunaquestions/{questionId} instead.

Delete the Lacuna Question

Available Since
1.6.0
Request Parameters
name type description constraints
questionId path
REQUIRED
Question 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/lacunaquestion/release

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

Releases the version of the lacuna question 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 Lacuna Question (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 question version id
{ "content": 121, // Question version id message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/lacunaquestion/move/{questionId}/{topicId}

This method has been deprecated. Use POST /lms/api/v0/lacunaquestions/move/{questionId}/{topicId} instead.

Move a lacuna question to another topic

Available Since
1.6.0
Request Parameters
name type description constraints
questionId path
REQUIRED
Question ID
long
topicId path
REQUIRED
Topic ID
long
Response Body
media type data type description
application/json object (JSON)

Response JSON (example):


 {
 	"content": "OK",
 	"message": null
 }