部位导入接口
接口说明
接口地址:/gys/common/position/positionSync
接口用途:第三方部位导入
请求方式:POST
请求参数:JSON格式字符串
注意事项:
1、调用接口之前,一定要选择正确的“工程部位字典来源”,否则可能导致接口导入失败;
开启方式:切换到项目层,在【管控中心】-【系统设置】-【参数设置】-【部位管理】-【工程部位字典来源】选择“其他系统”。
2、如传递多层级部位,需要优先同步父部位之后再推送子部位;
3、相同层级部位名称不能重复;
4、为避免调用超时,请分批次传递数据;
请求参数
参数 |
类型 |
必填 |
取值范围(字符长度) |
描述 |
projectId |
Long |
N |
1-20 |
项目id,projectId和syncCode有且只能其一有值 |
syncCode |
String |
N |
0-255 |
同步编码,projectId和syncCode有且只能其一有值 |
positionSyncVos |
Array |
Y |
|
同步的部位信息集合 |
sourceCode |
String |
N |
0-255 |
数据来源(三方系统标示) |
positionSyncInfos格式:
字段 |
类型 |
必填 |
描述 |
unitId |
String |
Y |
三方部位id(全局唯一) |
unitPId |
String |
Y |
三方部位所属父id(如果为根部位,其对应的父部位:0) |
optType |
int |
Y |
操作类型,0为新增/编辑,2为删除 |
positionName |
String |
N |
部位名称 |
请求数据格式:
{
"syncCode": "jcsx_xm001",
"sourceCode": "xxx",
"positionSyncVos": [
{
"unitId": "1663581281019144",
"unitPId": "0",
"positionName": "桥梁上部",
"optType": 0
},
{
"unitId": "386862145110553",
"unitPId": "1663581281019144",
"positionName": "施工便道",
"optType": 0
}
]
}
成功返回值说明
{
"code": 200, // 响应的状态码
"data": "{\"syncFailData\":[],\"failPosition\":[]}",
"message": "操作成功", // 响应提示信息
"success": true // 状态
}
异常返回值说明
{
"code": 200,
"data": "{\"failPosition\":[{\"errorMsg\":\"未找到父部位id\",\"unitId\":\"386862145110553\",\"optType\":0,\"unitPId\":\"1663581281019144\",\"positionName\":\"施工便道\"}]}",
"message": "操作成功",
"success": true
}
data为导入失败数据封装后的JsonStr
内部字段解释:
-- syncFailData 封装校验未通过数据
-- failPosition 当同步部位时,封装同步失败部位
-- 异常原因封装在 errorMsg字段中