Survey API
API change historyList of APIs related to Survey
Add survey
Create a survey.
If the parentID/moduleID is specified, only user with the Manager access can create the survey under the module.
Otherwise only users with “RootResource.Create” role can call this API.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
The survey information with its settings.
{
"parentId": "string",
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"lessonID": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "data used when creating a survey",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"parentId": {
"format": "uuid",
"description": "parent id of the survey, null means no parent",
"type": "string"
},
"access": {
"description": "all access rights defined for the survey",
"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"
}
}
}
]
},
"lessonID": {
"format": "uuid",
"description": "lesson Id if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}{
"parentId": "string",
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"lessonID": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "data used when creating a survey",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"parentId": {
"format": "uuid",
"description": "parent id of the survey, null means no parent",
"type": "string"
},
"access": {
"description": "all access rights defined for the survey",
"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"
}
}
}
]
},
"lessonID": {
"format": "uuid",
"description": "lesson Id if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}{
"parentId": "string",
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"lessonID": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "data used when creating a survey",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"parentId": {
"format": "uuid",
"description": "parent id of the survey, null means no parent",
"type": "string"
},
"access": {
"description": "all access rights defined for the survey",
"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"
}
}
}
]
},
"lessonID": {
"format": "uuid",
"description": "lesson Id if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}{
"parentId": "string",
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"lessonID": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "data used when creating a survey",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"parentId": {
"format": "uuid",
"description": "parent id of the survey, null means no parent",
"type": "string"
},
"access": {
"description": "all access rights defined for the survey",
"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"
}
}
}
]
},
"lessonID": {
"format": "uuid",
"description": "lesson Id if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}Responses
201 Created
Added survey information
Representations
{
"description": "The survey which used to build a question list for gathering feedback purposes",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Folder ID",
"type": "string"
},
"parentId": {
"format": "uuid",
"description": "the parent entity of the survey, usually the module. if it is same as ID, means it has no parent.",
"type": "string"
},
"access": {
"description": "Access rights of the current login user",
"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"
}
}
}
]
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this survey",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "the date this survey created",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "ID of the user who lastly updated the survey",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the last updated date of thos survey",
"type": "string"
},
"creatorName": {
"description": "the name of the user who created the survey",
"type": "string"
},
"updatorName": {
"description": "the name of the user who lastly updated the survey",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}{
"id": "string",
"parentId": "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
},
"creatorID": "string",
"createdDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"creatorName": "string",
"updatorName": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "The survey which used to build a question list for gathering feedback purposes",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Folder ID",
"type": "string"
},
"parentId": {
"format": "uuid",
"description": "the parent entity of the survey, usually the module. if it is same as ID, means it has no parent.",
"type": "string"
},
"access": {
"description": "Access rights of the current login user",
"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"
}
}
}
]
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this survey",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "the date this survey created",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "ID of the user who lastly updated the survey",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the last updated date of thos survey",
"type": "string"
},
"creatorName": {
"description": "the name of the user who created the survey",
"type": "string"
},
"updatorName": {
"description": "the name of the user who lastly updated the survey",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}{
"id": "string",
"parentId": "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
},
"creatorID": "string",
"createdDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"creatorName": "string",
"updatorName": "string",
"name": "string",
"publish": true,
"startDate": "string",
"endDate": "string",
"description": "string",
"closeMessage": "string",
"displayType": {},
"isAnonymous": true,
"allowModifyAfterSubmit": true,
"requireAnswerAllQuestions": true,
"isTask": true
}{
"description": "The survey which used to build a question list for gathering feedback purposes",
"required": [
"allowModifyAfterSubmit",
"displayType",
"endDate",
"isAnonymous",
"name",
"publish",
"startDate"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The Folder ID",
"type": "string"
},
"parentId": {
"format": "uuid",
"description": "the parent entity of the survey, usually the module. if it is same as ID, means it has no parent.",
"type": "string"
},
"access": {
"description": "Access rights of the current login user",
"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"
}
}
}
]
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this survey",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "the date this survey created",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "ID of the user who lastly updated the survey",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the last updated date of thos survey",
"type": "string"
},
"creatorName": {
"description": "the name of the user who created the survey",
"type": "string"
},
"updatorName": {
"description": "the name of the user who lastly updated the survey",
"type": "string"
},
"name": {
"description": "survey name",
"type": "string"
},
"publish": {
"description": "publish flag of the survey",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "survey start date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "survey expiry date",
"type": "string"
},
"description": {
"description": "description/instructional text of the survey",
"type": "string"
},
"closeMessage": {
"description": "message displayed after user submit the survey",
"type": "string"
},
"displayType": {
"description": "display type - \r\n\r\n0 - Full page, all contents displayed in one page\r\n\r\n1 - By Section, one section per page\r\n\r\n2 - By Question, one question per page",
"allOf": [
{
"format": "int32",
"description": "survey display type",
"enum": [
0,
1,
2
],
"type": "integer"
}
]
},
"isAnonymous": {
"description": "is student's identity hidden to the lecturer when taking the survey",
"type": "boolean"
},
"allowModifyAfterSubmit": {
"description": "allow user to modify their answers after submitted the survey",
"type": "boolean"
},
"requireAnswerAllQuestions": {
"description": "once enabled, student need to answer all questions in order to submit the survey",
"type": "boolean"
},
"isTask": {
"description": "whether the survey should be added as a task",
"type": "boolean"
}
}
}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"
}404 Not Found
Specified parent not found
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/survey/"
-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/survey/?" + 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/survey/");
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/survey/?" + $.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/survey/";
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/survey/');
$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", "/survey/?%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", "/survey/?%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/survey/')
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