1. 系统参数设定API

API列表

编号 API名称
1.1 系统参数设定列表
1.2 获取系统参数设定信息
1.3 新增系统参数设定
1.4 更新系统参数设定信息
1.5 系统参数类型选择

HTTP协议：

HTTP,HTTPS

API调用

1.1:系统参数设定列表

获取系统参数设定列表

请求信息

URI：https://biz-running-uat.smartmideazy.com/charge/sys/params/set/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
paramType BODY STRING 否 查询类型
paramCode BODY STRING 是 查询编码
paramName BODY STRING 是 查询名称模糊匹配
beginModifyTimestamp BODY DATE 否 开始时间
endModifyTimestamp BODY DATE 否 结束时间
pageNo BODY Integer 是 页码
pageSize BODY Integer 是 分页数

请求Body描述(非Form表单数据)

{
    "paramType":"ARREAR_REMIND_TIME",
    "pageNo":1,
    "pageSize":5
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
total data INTEGER 是 总记录数
pages data INTEGER 是 页数
records data JSONArray 是 参数信息
paramType records STRING 否 参数类型
endDateActive records STRING 否 参数结束时间
startDateActive records STRING 否 参数生效时间
paramCode records STRING 否 参数值
paramName records STRING 否 参数名称
createTime records STRING 否 创建时间
sysParamSetId records Integer 否 参数ID
description records STRING 否 描述
enabledFlag records STRING 否 是否可用
updateTime records STRING 否 更新时间

返回结果示例

{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "paramType": "ARREAR_REMIND_TIME",
                "endDateActive": "",
                "startDateActive": "2021-07-05 00:00:00",
                "paramCode": "7",
                "paramName": "欠费催缴时间限制",
                "createTime": "2021-07-05 08:30:02",
                "sysParamSetId": 1,
                "description": "欠费催缴时间限制",
                "enabledFlag": "Y",
                "updateTime": "2021-07-05 09:01:58"
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

1.2:获取系统参数设定信息

描述

请求信息

URI：https://biz-running-uat.smartmideazy.com/charge/sys/params/set/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
sysParamSetId BODY Integer 是 要查询的记录ID

请求Body描述(非Form表单数据)

{
    "sysParamSetId":1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
paramType data STRING 否 参数类型
endDateActive data STRING 否 参数结束时间
startDateActive data STRING 否 参数生效时间
paramCode data STRING 否 参数值
paramName data STRING 否 参数名称
createTime data STRING 否 创建时间
sysParamSetId data Integer 否 参数ID
description data STRING 否 描述
enabledFlag data STRING 否 是否可用
updateTime data STRING 否 更新时间

返回结果示例

{
    "code": 200,
    "data": {
        "paramType": "ARREAR_REMIND_TIME",
        "endDateActive": "",
        "startDateActive": "2021-07-05 00:00:00",
        "paramCode": "8",
        "paramName": "欠费催缴时间限制",
        "createTime": "2021-07-05 08:30:02",
        "sysParamSetId": 1,
        "description": "欠费催缴时间限制",
        "enabledFlag": "Y",
        "updateTime": "2021-07-05 08:56:14"

    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

1.3:新增系统参数设定

描述

请求信息

URI：https://biz-running-uat.smartmideazy.com/charge/sys/params/set/create

方法：POST

请求参数

名称 位置 类型 必填 描述
paramType BODY STRING 是 参数类型
paramCode BODY STRING 是 参数值
paramName BODY STRING 是 参数名称
description BODY STRING 是 参数描述
enabledFlag BODY STRING 是 参数是否可用：Y：可用；N：不可用
startDateActive BODY DATE 是 参数生效时间

请求Body描述(非Form表单数据)

{
    "paramType": "ARREAR_REMIND_MEMBER",
    "paramCode": "7",
    "paramName": "欠费催缴时间限制",
    "description": "欠费催缴时间限制",
    "enabledFlag": "Y",
    "startDateActive": "2021-07-05 00:00:00"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

1.4:更新系统参数设定信息

描述

请求信息

URI：https://biz-running-uat.smartmideazy.com/charge/sys/params/set/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
sysParamSetId BODY Integer 是 要更新的记录ID
paramType BODY STRING 是 参数类型
paramCode BODY STRING 是 参数值
paramName BODY STRING 是 参数名称
description BODY STRING 是 参数描述
enabledFlag BODY STRING 是 参数是否可用：Y：可用；N：不可用
startDateActive BODY DATE 是 参数生效时间

请求Body描述(非Form表单数据)

{
    "sysParamSetId":1,
    "paramType": "ARREAR_REMIND_TIME",
    "paramCode": "7",
    "paramName": "欠费催缴时间限制",
    "description": "欠费催缴时间限制",
    "enabledFlag": "Y",
    "startDateActive": "2021-07-05 00:00:00"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

1.5:系统参数类型选择

系统参数类型选择

请求信息

URI：https://biz-running-uat.smartmideazy.com/charge/sys/params/set/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
paramType BODY STRING 是 查询类型
pageNo BODY Integer 是 页码
pageSize BODY Integer 是 分页数

请求Body描述(非Form表单数据)

{
    "paramType":"SYSTEM_PARAM_TYPE",
    "pageNo":1,
    "pageSize":5
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
total data INTEGER 是 总记录数
pages data INTEGER 是 页数
records data JSONArray 是 参数信息
paramType records STRING 否 参数类型
paramName records STRING 否 参数名称
endDateActive records STRING 否 参数结束时间
startDateActive records STRING 否 参数生效时间
paramCode records STRING 否 参数值：返回的paramCode作为新增数据选择的paramType的选择项，单选
createTime records STRING 否 创建时间
sysParamSetId records Integer 否 参数ID
description records STRING 否 描述
enabledFlag records STRING 否 是否可用
updateTime records STRING 否 更新时间

返回结果示例

{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "paramType": "SYSTEM_PARAM_TYPE",
                "paramName": "催缴时间限制",
                "endDateActive": "",
                "startDateActive": "2021-07-12 16:44:19",
                "paramCode": "ARREAR_REMIND_TIME",
                "createTime": "2021-07-12 16:44:19",
                "sysParamSetId": 4,
                "description": "催缴时间限制",
                "enabledFlag": "Y",
                "updateTime": "2021-07-12 16:44:19"
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

results matching ""

    No results matching ""