查询中类资料
【基本信息】
信息 | 值 | 备注 |
---|---|---|
接口名称 | 查询中类资料 | 分页查询中类资料,默认按EFF_DD倒序 |
请求状态 | POST | RESTful方式 |
接口路径 | http://localhost:23798/api/Indx/List | 向服务器地址发送POST请求 |
远程模式 | http://www.linkerplus.com/api/ext_erp/Indx/List | 远程模式向服务器地址发送POST请求,需要ERP注册号注册远程模式,并在Headers添加sn参数 |
【请求参数】
Headers
参数名称 | 是否必须 | 参数值 | 备注 |
---|---|---|---|
Content-Type | 是 | application/json | 用于指定数据的传输类型 |
LoginId | 是 | e835943e-55c2-4bf0-832d-6f4166592941 | 用户登录的LoginId,取用户登录或账套验证接口返回的LoginId |
sn | 否 | MGR_REST_1001 | 远程模式需添加sn参数,MGR_REST_+ERP注册号 |
Body
参数名称 | 类型 | 是否必须 | 参数值 | 备注 |
---|---|---|---|---|
CURRENT_PAGE | int | 是 | 1 | 当前页码,表示返回该页数据 |
PAGE_SIZE | int | 否 | 100 | 每页数据数量,默认【100】,值在【1-1000】中选择,传其它值会取默认值 |
USR_NO | string | 否 | 用户代号。账套验证的LoginId需添加USR_NO,用户登录的LoginId则无需添加USR_NO | |
FILTER | object | 否 | 见下方详细说明 | 过滤条件 |
ORDER_BY | object | 否 | 有值时:{"IDX_NO":"DESC","NAME":"ASC"} | 排序条件。按INDX表中栏位自动匹配,为空时按EFF_DD倒序。 DESC:降序、ASC:升序 |
### FILTER ###
{
"START_DD": "", //查询EFF_DD大于该时间的数据(可用于同步中类资料数据),格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss
"IDX_NO_B": "", // 起始中类代号
"IDX_NO_E": "", // 截止中类代号
"NAME": "", // 中类名称,模糊匹配
"UP_IDX": "" // 上层中类,模糊匹配
}
【返回数据】
参数名称 | 类型 | 参数值 | 备注 |
---|---|---|---|
code | int | 0:表示查询成功。 1:表示查询失败。 | |
message | string | 执行信息 | |
result | object | 查询到的信息,JSON格式,具体信息参考下面调用范例 |
【调用范例】
请求:
{
"CURRENT_PAGE": 1, //必填,当前第几页
"PAGE_SIZE": 1, //选填,默认每页100,可传1-1000
"USR_NO": "ADMIN", //账套验证的LoginId需添加USR_NO,用户登录的LoginId则无需添加
"FILTER": {//选填
"START_DD": "", //查询EFF_DD大于该时间的数据(可用于同步中类资料数据),格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss
"IDX_NO_B": "", // 起始中类代号
"IDX_NO_E": "", // 截止中类代号
"NAME": "", // 中类名称,模糊匹配
"UP_IDX": "" // 上层中类,模糊匹配
},
"ORDER_BY": {} //选填,排序条件,按INDX表栏位自动匹配,默认以EFF_DD倒序,使用此接口同步最新资料时,需记录第一页第一条数据的EFF_DD
}
返回:
{
"code":0,
"message":"查询成功。",
"result":{
"total": 99,
"total_page": 99,
"current_total": 1,
"current_page": 1,
"page_size": 1,
"has_pre": false,
"has_next": true,
"data": [
{
"IDX_NO": "001", //中类代号
"NAME": "001", //中类名称
"UP_IDX": "002", // 上层中类
"CLS": "",
"REL_CLS": ""
}
]
}
}
【备注】
必须在Headers里面传入用户登录或账套验证的LoginId。
使用该接口同步中类资料的建议
排序条件不用填,第一次调用后,记录第1页第一项数据的EFF_DD,作为下一次调用的FILTER中的START_DD的传值,若下一次调用有数据返回,则表示有中类数据更新或者新增,通过此方法可获取全部中类数据。
EFF_DD为空未审核数据不返回。