API开放平台

TIP

# 字典表管理

# 查询自定义字典表选项

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/apaas/v1/queryDicOptions/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：


{"dicKey":"xxxeeee"}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
dicKey string 是 字典表的key

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": "90b4b267dd3d49aeace879038b1e721",
    "response_data": "[{\"code\":\"tN59jGq8\",\"createTime\":\"2024-11-18 20:05:47\",\"creatorId\":\"5598183076781204037\",\"modifyTime\":null,\"modifyierId\":null,\"name\":\"12\",\"optionStatus\":\"1\",\"pcode\":\"TQEYwFoi\",\"pname\":\"1\",\"sequence\":1.0}]"
}

说明：对象信息详见下面

响应请求中对象信息解析

异常示例：

{
    "return_code": "1",
    "return_msg": "系统错误，请联系管理员。",
    "msg_id": ""
}

响应请求的字典选项（示例）

[
    {
        "code": "tN59jGq8",
        "createTime": "2024-11-18 20:05:47",
        "creatorId": "5598183076781204037",
        "modifyTime": null,
        "modifyierId": null,
        "name": "12",
        "optionStatus": "1",
        "pcode": "TQEYwFoi",
        "pname": "1",
        "sequence": 1
    }
]

响应参数说明

参数 类型 说明
code VARCHAR(32) 选项code
pcode VARCHAR(32) 选项的父节点的code(如果是树形字典有效)
pname VARCHAR(32) 选项的父节点的选项名称(如果是树形字典有效)
name VARCHAR(100) 选项名称
sequence NUMERIC 排序号
optionStatus VARCHAR(32) 选项状态 0:删除，1：正常，2：停用
createTime VARCHAR(32) 创建时间。格式：yyyy-MM-dd HH:mm:ss
creatorId VARCHAR(32) 创建人id
modifyierId VARCHAR(32) 修改人id
modifyTime VARCHAR(32) 修改时间。格式：yyyy-MM-dd HH:mm:ss

# 新增字典表选项

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/apaas/v1/addDicOption/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{"code":"dfsfsf227","dicKey":"mwi9dzei_dic","name":"dfsfsf227名称1","pcode":null,"sequence":6,"thirdId":"dfsfsf227thirdPid","thirdPid":null}
说明： pcode和thirdPid 指定任一即可,优先取pcode;

参数说明：

参数 类型 必填 说明
dicKey VARCHAR(32) 是 字典key
code VARCHAR(32) 是 选项code
thirdId VARCHAR(32) 否 选项的第三方id
pcode VARCHAR(32) 否 选项的父节点的code(如果是树形字典有效)
thirdPid VARCHAR(32) 否 选项的父节点的第三方id(如果是树形字典有效)
name VARCHAR(100) 是 选项名称
sequence NUMERIC 否 排序号

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }"
}

说明：对象信息详见下面

响应请求中对象信息解析

异常示例：

{
    "return_code": "1",
    "return_msg": "系统错误，请联系管理员。",
    "msg_id": ""
}

# 修改字典表选项

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/apaas/v1/editDicOption/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{"code":"dfsfsf227","dicKey":"mwi9dzei_dic","name":"dfsfsf227名称1","pcode":null,"sequence":6,"thirdId":"dfsfsf227thirdPid","thirdPid":null}
说明： code和thirdid 指定任一即可,优先取code; pcode和thirdPid 指定任一即可,优先取pcode;

参数说明：

参数 类型 必填 说明
dicKey VARCHAR(32) 是 字典key
code VARCHAR(32) 否 选项code
thirdId VARCHAR(32) 否 选项的第三方id
pcode VARCHAR(32) 否 选项的父节点的code(如果是树形字典有效)
thirdPid VARCHAR(32) 否 选项的父节点的第三方id(如果是树形字典有效)
name VARCHAR(100) 是 选项名称
sequence NUMERIC 否 排序号

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }"
}

说明：对象信息详见下面

响应请求中对象信息解析

异常示例：

{
    "return_code": "1",
    "return_msg": "系统错误，请联系管理员。",
    "msg_id": ""
}

# 切换字典表选项状态

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/apaas/v1/switchOptionStatus/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{"code":"dfsfsf227","dicKey":"mwi9dzei_dic","thirdId":"dfsfsf227thirdPid","optionStatus":"2"}
说明： code和thirdid 指定任一即可,优先取code;

参数说明：

参数 类型 必填 说明
dicKey VARCHAR(32) 是 字典key
code VARCHAR(32) 否 选项code
thirdId VARCHAR(32) 否 选项的第三方id
optionStatus VARCHAR(32) 是 选项状态 0:删除，1：正常，2：停用

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }"
}

说明：对象信息详见下面

响应请求中对象信息解析

异常示例：

{
    "return_code": "1",
    "return_msg": "系统错误，请联系管理员。",
    "msg_id": ""
}

← 数据报表相关接口 →