1.调查问卷-接口文档

古城微笑少年丶 2022-03-09 04:52 404阅读 0赞

调查问卷表：

QUESTIONNAIRE\_MANAGE\_T*--问卷活动管理表*

QUESTIONNAIRE\_MANAGE\_EXTEND\_T*--问卷活动管理扩展表*

QUE\_ANSWER\_FREQUENCY\_T*--答题次数查询表*

QUESTIONNAIRE\_INFO\_T*--题干表*

QUESTIONNAIRE\_EXTEND\_INFO\_T*--选项表*

QUESTIONNAIRE\_ANSWER\_T*--调查问卷答题表*

STANDARD\_ANSWER\_SCORE*--旅客评分表--无业务需要暂无评分*

# **1.请求参数基本格式** #

## **1.入参格式说明** ##

由于IBM Worklight Adapter 的入参不支持多层json.所以需要将json对象转为jsonstr拼入新的json对象

最终对象如下

“req”:”jsonstr”  //入参的json对象字符串

## **2.server解析入参** ##

String req=request.getParameter(“req”);

req转Map  //转换方式随意

## **3.出参格式说明** ##

"activityId": "asdfghjkl",

"individualization": "'公共','有午餐可填','有餐可填',有早餐可填",

"questionIdName": "第一套题",

"answerNum": "6",

"questionContent": "第一套题简介",

"maxAnswerNum": "10",

"code": "00000000",

"msg": "查询获取返回文言"

返回结果中都含有错误码(code)为00000000代表成功，其它代表失败。

# **2.接口需求** #

## **   1.查询题目接口** ##

**介绍：获取调查问卷用户答题题目**

地址：[http://localhost:8085/demo/commonQuestionnaire/queryQuestionnaire.do][http_localhost_8085_demo_commonQuestionnaire_queryQuestionnaire.do]

<table style="margin-left:6.75pt;width:501.8pt;"> 
 <tbody> 
 <tr> 
 <td style="width:125.45pt;"> 参数名 </td> 
 <td style="width:65.95pt;"> 中文名称 </td> 
 <td style="width:42.5pt;"> 必填 </td> 
 <td style="width:267.9pt;"> 注释 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> activityId </td> 
 <td style="vertical-align:top;width:65.95pt;"> 活动id </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> 后台表QUESTIONNAIRE_MANAGE_T --问卷活动管理表中字段id </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> lang </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户查询语言 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> userId </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户唯一标识 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> userId不传时是不记名答题 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> individualization </td> 
 <td style="vertical-align:top;width:65.95pt;"> 个性化题目要求 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> 传多个时以“,”隔开，例：早餐,晚餐 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> answer_level </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户等级 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

1.入参说明

入参样例：

{
    	"activityId": "asdfghjkl",
    	"lang": "中文",
    	"userId": "18730733961",
    	"individualization": "有早餐可填",
    	"answer_level": "普卡"
    }

2.出参说明

<table style="margin-left:6.75pt;width:503.25pt;"> 
 <tbody> 
 <tr> 
 <td style="width:125.45pt;"> 参数名 </td> 
 <td style="width:125.45pt;"> 中文名称 </td> 
 <td style="width:252.35pt;"> 注释 </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> activityId </td> 
 <td style="vertical-align:top;width:125.45pt;"> 活动id </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> individualization </td> 
 <td style="vertical-align:top;width:125.45pt;"> 个性化展示的关键字 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> questionIdName </td> 
 <td style="vertical-align:top;width:125.45pt;"> 本次问卷的名字 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> answerNum </td> 
 <td style="vertical-align:top;width:125.45pt;"> 答题旅客答题次数 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 返回0是没有查询到旅客答题记录，或没传userId </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> questionContent </td> 
 <td style="vertical-align:top;width:125.45pt;"> 本次问卷的简介 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> maxAnswerNum </td> 
 <td style="vertical-align:top;width:125.45pt;"> 本次问卷的最大答题次数 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 0为无限制 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> code </td> 
 <td style="vertical-align:top;width:125.45pt;"> 错误编码 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> msg </td> 
 <td style="vertical-align:top;width:125.45pt;"> 错误描述 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> urlParam </td> 
 <td style="vertical-align:top;width:125.45pt;"> 首页图片url </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> questionnaireInfo </td> 
 <td style="vertical-align:top;width:125.45pt;"> 旅客答题问卷信息 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> urlParam </td> 
 <td style="vertical-align:top;width:125.45pt;"> 首页图片url </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> questionSequence </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题号从1开始依次递增 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 1，2，3，4，5，6…… </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> questionID </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题的唯一id </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> required </td> 
 <td style="vertical-align:top;width:125.45pt;"> 是否必填 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 1必填 0非必填 </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> questionType </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题的类型 </td> 
 <td style="vertical-align:top;width:252.35pt;"> single_choice-单选题：中文：天气如何 multiple_choice-多选题：中文：多选 essay-简答题 yes_no-是否题 true_false-对错题 score-评分题 fill_blanks-填空题 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> questionContent </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题目 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> ifAnswerFlag </td> 
 <td style="vertical-align:top;width:125.45pt;"> 是否存在用户答案 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 1已答题 0未答题 </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> watermark </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题干水印 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> urlParam </td> 
 <td style="vertical-align:top;width:125.45pt;"> 题干图片url </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> individualization </td> 
 <td style="vertical-align:top;width:125.45pt;"> 本题属于个性化的关键字 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> choiceBlanksNumber </td> 
 <td style="vertical-align:top;width:125.45pt;"> 填空最大空数 选择最大可选数 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> minScore </td> 
 <td style="vertical-align:top;width:125.45pt;"> 评分题最小评分 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> maxScore </td> 
 <td style="vertical-align:top;width:125.45pt;"> 评分题最大评分 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> optionScore </td> 
 <td style="vertical-align:top;width:125.45pt;"> 默认显示评分 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> optionList </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选择题：选项List </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> optionSequence </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选择题选项号，1，2，3…… </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> optionID </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选项唯一id </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> optionContent </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选项内容 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> watermark </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选项水印 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> urlParam </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选项包含图片url </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> showBlanksList </td> 
 <td style="vertical-align:top;width:125.45pt;"> 选择显示说明框的选项 评分题小于这个评分显示说明框 </td> 
 <td style="vertical-align:top;width:252.35pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> answerOption </td> 
 <td style="vertical-align:top;width:125.45pt;"> 答题选择 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 多选用逗号隔开例：&nbsp;"0001,0002" 是否题：1为是，0为否 对错题：1为对，0为错 评分题：评分 </td> 
 </tr> 
 <tr> 
 <td style="width:125.45pt;"> answerContent </td> 
 <td style="vertical-align:top;width:125.45pt;"> 答题内容 </td> 
 <td style="vertical-align:top;width:252.35pt;"> 填空题答案：多个答案用“#”隔开 简答题答案 </td> 
 </tr> 
 </tbody> 
</table>

出参样例：

{
      "activityId": "asdfghjkl",
      "individualization": "'公共','有午餐可填','有餐可填',有早餐可填",
      "questionIdName": "第一套题",
      "answerNum": "7",
      "questionContent": "第一套题简介",
      "maxAnswerNum": "10",
      "code": "00000000",
      "msg": "查询获取返回文言",
      "questionnaireInfo": [
        {
          "questionSequence": "1",
          "questionID": "1",
          "required": "1",
          "questionType": "single_choice",
          "questionContent": "单选题：中文：天气如何",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "有午餐可填",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [
            {
              "optionSequence": "1",
              "optionID": "0001",
              "optionContent": "选项A",
              "watermark": "选择A水印",
              "urlParam": ""
            },
            {
              "optionSequence": "2",
              "optionID": "0002",
              "optionContent": "选项B",
              "watermark": "选择B水印",
              "urlParam": ""
            }
          ],
          "showBlanksList": [],
          "answerOption": "0001",
          "answerContent": ""
        },
        {
          "questionSequence": "2",
          "questionID": "2",
          "required": "1",
          "questionType": "multiple_choice",
          "questionContent": "多选题：中文：多选",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "有午餐可填",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [
            {
              "optionSequence": "1",
              "optionID": "0001",
              "optionContent": "选项A",
              "watermark": "水印",
              "urlParam": ""
            },
            {
              "optionSequence": "2",
              "optionID": "0002",
              "optionContent": "选项B",
              "watermark": "水印",
              "urlParam": ""
            },
            {
              "optionSequence": "3",
              "optionID": "0003",
              "optionContent": "选项C",
              "watermark": "水印",
              "urlParam": ""
            }
          ],
          "showBlanksList": [
            "0001",
            "0002"
          ],
          "answerOption": "0001,0002",
          "answerContent": "多选题说明，因为都会用到所有选择了两个选项"
        },
        {
          "questionSequence": "3",
          "questionID": "4",
          "required": "1",
          "questionType": "essay",
          "questionContent": "简单题：中文",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "有午餐可填",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [],
          "showBlanksList": [],
          "answerOption": "",
          "answerContent": "简答题的答案"
        },
        {
          "questionSequence": "4",
          "questionID": "6",
          "required": "1",
          "questionType": "yes_no",
          "questionContent": "是否题：中文",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "公共",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [],
          "showBlanksList": [],
          "answerOption": "1",
          "answerContent": "是否题，1选“是”，0选“否”"
        },
        {
          "questionSequence": "5",
          "questionID": "7",
          "required": "1",
          "questionType": "true_false",
          "questionContent": "对错题：中文",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "公共",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [],
          "showBlanksList": [],
          "answerOption": "1",
          "answerContent": "对错题，1选“对”，0选“错”"
        },
        {
          "questionSequence": "6",
          "questionID": "3",
          "required": "1",
          "questionType": "score",
          "questionContent": "评分题：中文",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "有午餐可填",
          "choiceBlanksNumber": "1",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [],
          "showBlanksList": [],
          "answerOption": "9",
          "answerContent": "评分题：描述评分原因"
        },
        {
          "questionSequence": "7",
          "questionID": "5",
          "required": "1",
          "questionType": "fill_blanks",
          "questionContent": "填空题：中文",
          "ifAnswerFlag": "1",
          "watermark": "题干水印",
          "urlParam": "",
          "individualization": "有早餐可填",
          "choiceBlanksNumber": "2",
          "minScore": "0",
          "maxScore": "10",
          "optionScore": "0",
          "optionList": [],
          "showBlanksList": [],
          "answerOption": "",
          "answerContent": "填空1#填空2（旅客不能输入“#”）"
        }
      ],
      "urlParam": "第一套题封面url"
    }

## **   2.用户答题接口** ##

**介绍：保存用户答题信息**

地址：http://localhost:8085/demo/commonQuestionnaire/saveQuestionnaire.do

<table style="margin-left:6.75pt;width:501.8pt;"> 
 <tbody> 
 <tr> 
 <td style="width:125.45pt;"> 参数名 </td> 
 <td style="width:65.95pt;"> 中文名称 </td> 
 <td style="width:42.5pt;"> 必填 </td> 
 <td style="width:267.9pt;"> 注释 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> answerList </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户答题List </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> questionID </td> 
 <td style="vertical-align:top;width:65.95pt;"> 题的唯一id </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> answerOption </td> 
 <td style="vertical-align:top;width:65.95pt;"> 答题选则 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> answerContent </td> 
 <td style="vertical-align:top;width:65.95pt;"> 答题内容 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> userId </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户唯一标识 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> activityId </td> 
 <td style="vertical-align:top;width:65.95pt;"> 活动id </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> lang </td> 
 <td style="vertical-align:top;width:65.95pt;"> 语言 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:125.45pt;"> answer_level </td> 
 <td style="vertical-align:top;width:65.95pt;"> 用户等级 </td> 
 <td style="vertical-align:top;width:42.5pt;"> 1 </td> 
 <td style="vertical-align:top;width:267.9pt;"> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

1.入参说明

入参样例：

{
    	"answerList": [{
    		"questionID": "1",
    		"answerOption": "0001"
    	},
    	{
    		"questionID": "2",
    		"answerOption": "0001,0002",
    		"answerContent": "多选题说明，因为都会用到所有选择了两个选项"
    	},
    	{
    		"questionID": "4",
    		"answerContent": "简答题的答案"
    	},
    	{
    		"questionID": "6",
    		"answerOption": "1",
    		"answerContent": "是否题，1选“是”，0选“否”"
    	},
    	{
    		"questionID": "7",
    		"answerOption": "1",
    		"answerContent": "对错题，1选“对”，0选“错”"
    	},
    	{
    		"questionID": "3",
    		"answerOption": "9",
    		"answerContent": "评分题：描述评分原因"
    	},
    	{
    		"questionID": "5",
    		"answerContent": "填空1#填空2（旅客不能输入“#”）"
    	}],
    	"userId": "18730733961",
    	"activityId": "asdfghjkl",
    	"lang": "中文",
    	"answer_level": "普卡"
    }

2.出参说明

出参样例：

{
      "code": "00000000",
      "msg": "查询获取返回文言"
    }

**希望对你有帮助，祝你有一个好心情，加油！**

**若有错误、不全、可优化的点，欢迎纠正与补充！**

[http_localhost_8085_demo_commonQuestionnaire_queryQuestionnaire.do]: http://localhost:8085/intf/commonQuestionnaire/queryQuestionnaire.do