问卷星开放文档

问卷星开放文档


2.1.3获取问卷设置[1000003]

<p>[TOC]</p> <h1>接口地址</h1> <p>生产环境:<code>https://www.wjx.cn/openapi/default.aspx</code></p> <ul> <li> <h1>2.1.3.1 请求参数格式</h1> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">字段</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>必需</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">vid</td> <td style="text-align: left;">int</td> <td>问卷编号</td> <td>是</td> <td>问卷星发送问卷链接中activityid的值</td> </tr> <tr> <td style="text-align: left;">additional_setting</td> <td style="text-align: left;">string[]</td> <td>自定义返回参数设置</td> <td>否</td> <td>参数内容详见<a href="https://www.showdoc.com.cn/wjxopenapi/8961208800507921" title="自定义返回参数内容">自定义返回参数内容</a></td> </tr> </tbody> </table> <ul> <li>举例</li> </ul> <pre><code class="language-csharp">Content-Type:application/json {     "encode": "sha1",     "vid": "91432",     "appid": "907",     "sign": "d2050d70204bc2fd98e60cfe34cd6f2501500078",     "action": "1000003",     "ts": 1583812686, "additional_setting": "[1000,1001]", }</code></pre> <ul> <li> <h1>2.1.3.2响应参数列表:</h1> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>必需</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">vid</td> <td style="text-align: left;">int</td> <td>问卷编号</td> <td>是</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">string</td> <td>问卷名称</td> <td>是</td> </tr> <tr> <td style="text-align: left;">path</td> <td style="text-align: left;">string</td> <td>问卷Url相对路径</td> <td>是</td> </tr> <tr> <td style="text-align: left;">activity_domain</td> <td style="text-align: left;">string</td> <td>问卷访问域名</td> <td>是</td> </tr> <tr> <td style="text-align: left;">iframe_auto_url</td> <td style="text-align: left;">string</td> <td>iframe自适应链接</td> <td>是</td> </tr> <tr> <td style="text-align: left;">iframe_noauto_url</td> <td style="text-align: left;">string</td> <td>iframe不自适应链接</td> <td>是</td> </tr> <tr> <td style="text-align: left;">time_setting</td> <td style="text-align: left;">TimeSetting[]</td> <td>问卷时间设置</td> <td>否</td> <td>参见<a href="#2.3.2.1">2.3.2.1问卷时间设置</a></td> </tr> <tr> <td style="text-align: left;">after_submit_setting</td> <td style="text-align: left;">AfterSubmitSetting[]</td> <td>问卷提交后处理</td> <td>否</td> <td>参见<a href="#2.3.2.2">2.3.2.2问卷提交后处理</a></td> </tr> <tr> <td style="text-align: left;">scores_setting</td> <td style="text-align: left;">KaoShiScoreSetting</td> <td>成绩单设置</td> <td>否</td> <td>参见<a href="#2.3.2.3">2.3.2.3成绩单设置</a></td> </tr> <tr> <td style="text-align: left;">category_setting</td> <td style="text-align: left;">Dictionary&lt;int, Dictionary&lt;int, Category&gt;&gt;</td> <td>维度设置</td> <td>否</td> <td>键1:维度层级<br>键2:具体维度编号<br>值的定义参见 <a href="#2.3.2.7">2.3.2.7 维度</a></td> </tr> <tr> <td style="text-align: left;">sojumpparm_activity_setting</td> <td style="text-align: left;">ExtSojumpparmSetting</td> <td>自定义链接参数-问卷答题设置<br>【将在2022-08-01取消,请使用sojumpparm_setting字段】</td> <td>否</td> <td>参见<a href="#2.3.2.9.1">2.3.2.9.1自定义链接参数答题设置</a></td> </tr> <tr> <td style="text-align: left;">sojumpparm_global_setting</td> <td style="text-align: left;">ExtSojumpparmSetting</td> <td>自定义链接参数-全局答题设置<br>【将在2022-08-01取消,请使用sojumpparm_setting字段】</td> <td>否</td> <td>参见<a href="#2.3.2.9.1">2.3.2.9.1自定义链接参数答题设置</td> </tr> <tr> <td style="text-align: left;">sojumpparm_setting</td> <td style="text-align: left;">SojumpparmNewSetting</td> <td>自定义链接参数答题设置</td> <td>否</td> <td>参见<a href="#2.3.2.9">2.3.2.9自定义链接参数答题设置</td> </tr> <tr> <td style="text-align: left;">award_setting</td> <td style="text-align: left;">AwardSetting</td> <td>奖品设置(即时开奖和定时开奖设置)</td> <td>否</td> <td>参见<a href="#2.3.3.0">2.3.3.0奖品设置</td> </tr> <tr> <td style="text-align: left;">msg_setting</td> <td style="text-align: left;">MsgSetting</td> <td>数据推送设置</td> <td>否</td> <td>该字段内容后台更新后会有10秒缓存,字段详情参见<a href="#2.3.3.3">2.3.3.3数据推送设置</td> </tr> </tbody> </table> <h1>2.3.2.1问卷时间设置(TimeSetting)</h1> <table> <thead> <tr> <th style="text-align: left;">参数</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>必需</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">begin_time</td> <td style="text-align: left;">string</td> <td>问卷开始时间</td> <td>否</td> <td>时间格式:yyyy-MM-dd HH:mm:ss;</td> </tr> <tr> <td style="text-align: left;">begin_words</td> <td style="text-align: left;">string</td> <td>问卷开始提示语</td> <td>否</td> </tr> <tr> <td style="text-align: left;">end_time</td> <td style="text-align: left;">string</td> <td>问卷结束时间</td> <td>否</td> <td>时间格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_words</td> <td style="text-align: left;">string</td> <td>问卷结束提示语</td> <td>否</td> </tr> <tr> <td style="text-align: left;">daily_start_time1</td> <td style="text-align: left;">string</td> <td>每天问卷开始时间1</td> <td>否</td> </tr> <tr> <td style="text-align: left;">daily_end_time1</td> <td style="text-align: left;">string</td> <td>每天问卷结束时间1</td> <td>否</td> </tr> <tr> <td style="text-align: left;">daily_start_time2</td> <td style="text-align: left;">string</td> <td>每天问卷开始时间2</td> <td>否</td> </tr> <tr> <td style="text-align: left;">daily_end_time2</td> <td style="text-align: left;">string</td> <td>每天问卷结束时间2</td> <td>否</td> </tr> <tr> <td style="text-align: left;">daily_outoftime_words</td> <td style="text-align: left;">string</td> <td>不在指定时间提示语</td> <td>否</td> </tr> <tr> <td style="text-align: left;">max_answer_seconds</td> <td style="text-align: left;">int</td> <td>最长作答时间(秒)</td> <td>否</td> </tr> <tr> <td style="text-align: left;">max_no_operat_seconds</td> <td style="text-align: left;">int</td> <td>答题时最长没有新操作就强制交卷时间(秒)</td> <td>否</td> </tr> <tr> <td style="text-align: left;">max_tab_screen_count</td> <td style="text-align: left;">int</td> <td>允许切屏最大次数</td> <td>否</td> </tr> </tbody> </table> <div id="2.3.2.2"></div> 2.3.2.2问卷提交后处理(AfterSubmitSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |show_thanks |bool |显示感谢信息 |否 || |thank_words |string |感谢信息 |否 || |invalid_answer_words |string |答卷无效提示语 |否 || |go_redirect |bool |跳转到指定页面 |否 || |redirect_url |string |跳转链接地址 |否 || |redirect_words |string |跳转提示语 |否 || |redirect_with_answer |bool |Post答卷数据 |否 || |redirect_with_activitycontent |bool |Post问卷内容 |否 || |show_scores |bool |显示考试成绩 |否 ||| <div id="2.3.2.3"></div> # 2.3.2.3 成绩单设置(KaoShiScoreSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |show_rank |bool |显示实时排名 |否 || |show_total_scroe |bool |显示答题人和总得分 |否 || |show_question |bool |显示作答题目 |否 || |show_correct_answer |bool |显示正确答案 |否 || |show_cost_times |bool |显示考试完成时间 |否 || |not_allowed_save |bool |不允许保存报告 |否 || |scroes_comments |ScroesCommentSetting[] |分值评语 |否 |参见 <a href="#2.3.2.4">2.3.2.4 分值评语设置</a>| |certificate_setting |CertificateSetting |证书设置 |否 |<a href="#2.3.2.5">2.3.2.5 证书设置</a>| <div id="2.3.2.4"></div> # 2.3.2.4 分值评语设置(ScroesCommentSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |start_score |double |开始分数(包含) |否 || |end_score |double |结束分数(不包含) |否 || |score_words |string |得分评语 |否 ||| <div id="2.3.2.5"></div> # 2.3.2.5 证书设置(CertificateSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |show_certificate |bool |考试完成以后自动跳转证书页面 |否 || |show_certificate_score |double |显示证书最低分数 |否 || |certificate_template |string |证书模板图片地址 |否 || |certificate_fields |CertificateField[] |证书字段 |否 |参见 <a href="#2.3.2.6">2.3.2.6证书字段</a>| <div id="2.3.2.6"></div> # 2.3.2.6 证书字段(CertificateField) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |field_name |string |字段名称 |否 |当字段名称类型[q1]\[q2]时,需要引用问卷相应的题目标题| |font_size |string |字段字体大小 |否 || |font_color |double |字段字体颜色 |否 || |position_x |int |字段位置x轴数值 |否 || |position_y |int |字段位置y轴数值 |否 || |field_enable |bool |是否启用 |否 || |field_value |string |字段值 |否 |当字段为二维码时为二维码地址| <div id="2.3.2.7"></div> # 2.3.2.7 维度(Category) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |id |int |维度编号 |否 || |name |string |维度名称 |否 || |level |int |所在维度等级 |否 || |parent_id |int |父级维度编号 |否 || |score |double |维度标准分 |否 |当score_type值<br>1:平均分标准分<br>2:总分标准分<br>3: T分标准分| |score_type |int |维度类型(总分/平均分) |否 |1: 平均分<br>2:总分<br>3:T分| |weight |int |维度权重 |否 || |score_rule |string |自定义维度的计分规则 |否 || |qid |int[] |绑定的题目编号 |否 || |score_result |CategoryScoreResult[] |维度结果与建议 |否 |参见:<a href="#2.3.2.8">2.3.2.8 维度结果与建议</a>| |low_min |double |最小低分(不包含) |否 |360评估才有| |low_max |double |最大低分(包含) |否 |360评估才有| |middle_min |double |最小中分(不包含) |否 |360评估才有| |middle_max |double |最大中分(包含) |否 |360评估才有| |high_min |double |最小高分(不包含) |否 |360评估才有| |hign_max |double |最大高分(包含) |否 |360评估才有| <div id="2.3.2.8"></div> # 2.3.2.8 维度结果与建议(CategoryScoreResult) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |min_value |double |最小得分(包含) |否 || |max_value |double |最大得分(不包含) |否 || |result |string |维度得分结果与建议 |否 ||| <div id="2.3.2.9"></div> # 2.3.2.9 自定义链接参数答题设置(SojumpparmNewSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |sojumpparm_activity_setting |<a href="#2.3.2.9.1">ExtSojumpparmSetting</a> |自定义链接参数-单个问卷答题设置 |否 || |sojumpparm_global_setting |<a href="#2.3.2.9.1">ExtSojumpparmSetting</a> |自定义链接参数-全局答题设置 |否 ||| <div id="2.3.2.9.1"></div> # 2.3.2.9.1 自定义链接参数答题详情设置(ExtSojumpparmSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |join_limit |int |作答次数限制 |是 |默认为1<br>1 :只许填写1次 <br>2 :只许填写2次 <br>3 :只许填写3次 <br>4 :只许填写4次 <br>5 :只许填写5次 <br>-1:每天可填1次 <br>-2:每天可填2次 <br>-3:每天可填3次 <br>-4:每天可填4次 <br>-5:每天可填5次 <br>0 :不限填写次数| |signature_verify |bool |是否校验参数签名 |是 |默认为false| |allow_queryresult |bool |是否允许作答后查看 |是 |默认为false| <div id="2.3.3.0"></div> # 2.3.3.0 奖品设置(AwardSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |status |int |奖品设置状态 |是 |0表示不抽奖,1、2表示即时抽奖,3表示红包抽奖,4表示定时抽奖| |end_date |datetime |截止时间 |是 |截止时间【即时开奖】,开奖时间【定时开奖】| |publisherName |string |发奖人姓名 |是 || |contactInfo |string |发奖人联系方式 |是 || |deliverRule |string |奖品发放方式、规则说明 |否 || |noInfo |bool |是否无需获奖者提供联系方式 |否 |即时抽奖设置项| |awardByJoin |int |中奖概率<br>每awardByJoin个参与者抽中一个奖品 |否 |即时抽奖设置项| |awardByPercent |int |中奖概率-与awardByJoin二选一设置 |否 |即时抽奖设置项| |notRepeat |bool |同一手机号码只允许领奖一次 |否 |即时抽奖设置项| |maxPerDay |int |全部奖品每天最多抽中 |否 |即时抽奖设置项| |smsAwardNotify |bool |中奖时短信通知获奖者 |否 |即时抽奖设置项| |smsSendNotify |bool |发奖时短信通知获奖者 |否 |即时抽奖设置项 |notDisplayAward |bool |问卷页面不显示奖品信息 |否 |即时抽奖设置项| |notDisplayName |bool |问卷页面不显示获奖名单 |否 |即时抽奖设置项| |awardWays |int |开奖方式 |否 | 1表示按指定时间自动开奖,<br>2表示达到指定参与人数开奖,<br>3表示主办方手动开奖,定时抽奖设置项| |receiveDays |int |开奖后限制领取时间【天数】 |否 |定时抽奖设置项| |address |int |地区限制 |否 | 定时抽奖设置项| |valueAward |int |参与抽奖分数条件 |否 | 考试问卷才显示,定时抽奖设置项| |activityAwardList |<a href="#2.3.3.1">List<AwardList></a> |奖品详情 |否 || |activityAwardVerifier |<a href="#2.3.3.2">List<AwardVerifierList></a> |发放员列表 |否 |奖品包含优惠券时可添加| <div id="2.3.3.1"></div> # 2.3.3.1 奖品详情字段(AwardList) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |awardName |string |奖品名称 |是 || |awardCount |double |奖品数量 |是 || |awardtype |int |奖品类型 |否 |0表示虚拟奖品,1表示实物奖品,6表示优惠券,7表示微信现金红包,-1表示链接| |ext |string |附加信息 |否 || |imagePath |string |图片地址 |否 || |awardPosition |int |奖品位置 |否 ||| <div id="2.3.3.2"></div> # 2.3.3.2 发放员字段(AwardVerifierList) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |userId |string |ID |是 || |nickName |string |微信昵称 |是 || |addTime |string |添加时间 |否 ||| <div id="2.3.3.3"></div> # 2.3.3.3 数据推送字段(MsgSetting) |参数|类型|说明|必需|备注| |:--- |:------ |--- |-|-------- | |post_url |string |快速推送 |否 || |retry |bool |开启失败后重发 |否 ||| |post_url_global |string |推送地址全局设置 |否 |||

页面列表

ITEM_HTML