获取所有分组信息
接口说明: 获取所有开启api对接的分组信息。
请求方式:POST（HTTPS）
请求地址:https://api.xinrenxinshi.com/v5/calculation/group/list
请求Header:
| key | value |
|---|---|
| access_token | 获取的access_token的实际值 |
Query参数:
| key | value |
|---|---|
| sign | 签名值 |
Body参数:
| 参数 | 类型 | 必传(Y/N) | 说明 |
|---|---|---|---|
| timestamp | Long | Y | 请求时间戳（精确到毫秒） |
返回结果:
| 参数 | 类型 | 必传(Y/N) | 说明 |
|---|---|---|---|
| errcode | Integer | Y | 0成功，其他失败 |
| errmsg | String | Y | 结果描述 |
| data | PlatformGroupDockingResultData | N | 处理成功时的数据结果 |
PlatformGroupDockingResultData
| 参数 | 类型 | 必传(Y/N) | 说明 |
|---|---|---|---|
| groups | List<PlatformGroupDockingResult> | Y | 分组数据 |
| syncKey | String | Y | 同步数据key,(每次调用接口 都会生成一个最新的 如果想多次同步数据自行保存) 如 一次性想全量同步3w条数据 每次同步3000的话 则10次使用同一个syncKey |
PlatformGroupDockingResult
| 参数 | 类型 | 必传(Y/N) | 说明 |
|---|---|---|---|
| groupId | Integer | Y | 分组id |
| groupName | String | Y | 分组名称 |
| type | Integer | Y | 分组类型 0:导入明细 1:关联系统导入明细 2:导入分类配置明细 |
| dockingType | Integer | Y | 接收类型 0:增量 1:全量 |
| relevanceEmployee | String | Y | 用来关联员工的字段，在同步数据接口中，这个字段将是必填的，用来匹配员工数据 |
| fields | List<PlatformFieldDockingResult> | Y | 组内字段 |
PlatformFieldDockingResult
| 参数 | 类型 | 必传(Y/N) | 说明 |
|---|---|---|---|
| fieldId | String | Y | 字段id |
| groupId | Integer | Y | 字段所属分组id |
| fieldName | String | Y | 字段名称 |
| type | Integer | Y | 字段类型 0:单行文本 1:多行文本 2:日期 8:数值 |
| maxLength | Integer | N | 最大长度 |
| decimalPlace | Integer | N | 小数位数 |
| placeholder | String | N | 提示 |
| isSystemField | Integer | Y | 是否系统关联字段 |
| uniqueSign | Integer | Y | 是否唯一标识 0否1是 |
请求示例(HTTPS):
https://api.xinrenxinshi.com/v5/calculation/group/list?sign=7omyqoNIY5QPWKCyQM3Q7Hk8mNQ%3D
请求Body示例:
{
"timestamp":1625826941760
}
SDK请求示例(java):
CalculationCompanyGroupV2Request request = new CalculationCompanyGroupV2Request(access_token());
OpenapiResponse<List<CalculationCompanyGroupV2Response>> response = XrxsCalculationService.getAllCompanyGroupV2(request);
响应示例:
{
"errcode":0,
"errmsg":"成功",
"data":{
"syncKey": "10cdce5b52df4b8489d17c713e4d34d0",
"groups": [
{
"groupId":163,
"groupName":"测试导入",
"type":0,
"dockingType":0,
"relevanceEmployee":"mobile",
"fields":[
{
"fieldId":"97ae12eda1c941829315564cbfca418e",
"groupId":163,
"fieldName":"字段1",
"type":0,
"maxLength":50,
"decimalPlace":2,
"placeholder":"",
"isSystemField":0,
"uniqueSign": 0
}
]
}
]
}
}