查询合同模板变量信息

接口说明

[!NOTE]
查询合同模板变量信息,注意:复制的变量不返回。

http请求方式

[!NOTE]
POST application/x-www-form-urlencoded

http请求地址

[!NOTE]
$SERVICE_URL/v2/tmpl/pdfTpl/info #其中$SERVICE_URL为生产或测试的地址

http请求参数

除公共必填参数外,还需要传以下参数

参数 类型 是否必填 默认值 说明
templateNo string * 模版编号或共享编码

代码实现

JAVA实现
     Map<String, Object> params = bodyParams;
        String url = SERVICE_URL + "/v2/tmpl/pdfTpl/info";
        params.put("templateNo", "09602483980B483ABF68ECCDEC9601E0");//模版ID
        String str = HttpClientUtils.init().getPost(url, null, params, true);
        System.out.println(str);

http返回参数

[!NOTE]
返回response为application/json的数据,其字段说明如下

参数 类型 是否必返回 说明
success bool * 成功true;异常false
msg string ? 异常时,返回异常原因
data json ? 模板信息

data参数说明

参数 类型 是否必返回 说明
templateName string 模板名称
templateNo string 模板编号
params json 模板变量

params参数说明

参数 类型 是否必返回 说明
isRequired int * 1 必填,0:非必填
copyCount int * 复制变量数
name string * 变量名
defineValues json ? 预设值,多选单选的选项值
maxInputWordCount int * 最大输入字数
type int * 变量类型 -1:多行文本 0:文本 1:数字 2:日期 3:手机号 4:身份证 5:营业执照 6:统一社会信用代码 7:邮箱 8:单选 9:多选

[!NOTE]
返回结果,参考:

//正确响应:
{"data":{"params":[{"copyCount":0,"isRequired":1,"maxInputWordCount":100,"name":"姓名","type":-1},{"copyCount":0,"isRequired":1,"maxInputWordCount":100,"name":"身份证号","type":4}],"templateName":"企业服务授权书555","templateNo":"09602483980B483ABF68ECCDEC9601E0"},"success":true}

//错误响应:
{"msg":"查询不到模版","resultCode":"TEMPLATE_NOT_EXISTS","success":false}

results matching ""

    No results matching ""