身份标准对外接口
根据身份类型，查询身份标准【属性、名称、字典】【常用】（1.9版本）
根据身份类型查询组织身份类型标准 对外API接口（1.9.1版本）
1 根据身份类型，查询身份标准【属性、名称、字典】【常用】
请求地址
http://self.xxx.com/linkid/api/public/identitystandard/get/{identityCategoryCode}
功能说明
根据身份类型代码， 查询该身份类型下的所有数据项
请求示例
curl http://self.xxx.com/linkid/api/public/identitystandard/get/01
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| identityCategoryCode | String | 是 | 身份类型代码 实际情况以客户实施数据为准， 请找实施经理确认具体值 |
返回参数
{
"code": 200,
"message": "OK",
"data": [
{
"schoolId": "5fc88d81b058630006f0e3f0",//数据项id
"constraint": "OPTIONAL",//是否必填， REQUIRED为必填， OPTIONAL为可选
"explain": "",//数据项的解释
"valueSpace": "dict",//数据项的值空间
"valueSpaceShow": "字典表",//数据项的值空间展示名称
"number": "JG120086",//数据项的名称
"name": "AIHAO",//数据项的名称
"cnshortname": "爱好",//数据项的中文简称
"userPropertyId": "5fc88d81b058630006f0e3ef",//数据项的平台标准id
"isUnique": false,//数据项是否有唯一约束
}
]
}
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| schoolId | String | 数据项id |
| number | String | 数据项的编号 |
| name | String | 数据项的名称 |
| cnshortname | String | 数据项的中文简称 |
| constraint | String | 是否必填， REQUIRED为必填， OPTIONAL为可选 |
| isUnique | String | 数据项是否有唯一约束 |
| explain | String | 数据项的解释 |
| valueSpace | String | 数据项的值空间 |
| valueSpaceShow | String | 数据项的值空间展示名称 |
| userPropertyId | String | 数据项的平台标准id |
2 查询身份平台的所有身份类型
请求地址
http://self.xxx.com/linkid/api/public/identitycategory/all/get
请求参数：实例如下
http://self.xxx.com/linkid/api/public/identitycategory/all/get?tree=true
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| tree | Boolean | 否 | 是否按照树结构返回数据， true表示按照树形结构返回， false为平铺结构返回， 不传默认为false |
响应参数: 实例如下
/**
"id": "5d089015ac438c8026912af0",//人员类型id
"parentId": null,//父人员类型的id
"code": "01",//人员类型的代码
"name": "员工",//人员类型的名称
"desc": "员工",//人员类型的描述
"isDefault": true,//是否是内置人员类型
"identityCategoryUserStatuses": [//人员类型的状态列表
],
"children": [],//子人员类型列表
"level": 0,//人员类型的树层级，前端展示用
"createTime": "2019-06-18T09:08:19.762+0000",//人员类型的创建时间
"pageId": null,//人员类型对应的人员管理页面的id
"isDeleted": null,//人员类型是否被删除
"updatedTime": null//人员类型的更新时间
**/
{
"code": 200,
"message": "OK",
"data": [
{
"id": "5d089015ac438c8026912af0",//人员类型id
"parentId": null,//父人员类型的id
"code": "01",//人员类型的代码
"name": "员工",//人员类型的名称
"desc": "员工",//人员类型的描述
"isDefault": true,//是否是内置人员类型
"identityCategoryUserStatuses": [//人员类型的状态列表
{
"code": "退休",
"name": "退休",
"desc": "退休",
"isInherit": false
},
{
"code": "离休",
"name": "离休",
"desc": "离休",
"isInherit": false
},
{
"code": "退休",
"name": "退休",
"desc": "退休",
"isInherit": false
},
{
"code": "死亡",
"name": "死亡",
"desc": "死亡",
"isInherit": false
},
{
"code": "返聘",
"name": "返聘",
"desc": "返聘",
"isInherit": false
},
{
"code": "调出",
"name": "调出",
"desc": "调出",
"isInherit": false
},
{
"code": "辞职",
"name": "辞职",
"desc": "辞职",
"isInherit": false
},
{
"code": "离职",
"name": "离职",
"desc": "离职",
"isInherit": false
},
{
"code": "开除",
"name": "开除",
"desc": "开除",
"isInherit": false
},
{
"code": "下落不明",
"name": "下落不明",
"desc": "下落不明",
"isInherit": false
},
{
"code": "在职",
"name": "在职",
"desc": "在职",
"isInherit": false
},
{
"code": "延聘",
"name": "延聘",
"desc": "延聘",
"isInherit": false
},
{
"code": "待退休",
"name": "待退休",
"desc": "待退休",
"isInherit": false
},
{
"code": "长病假",
"name": "长病假",
"desc": "长病假",
"isInherit": false
},
{
"code": "因公出国",
"name": "因公出国",
"desc": "因公出国",
"isInherit": false
},
{
"code": "停薪留职",
"name": "停薪留职",
"desc": "停薪留职",
"isInherit": false
},
{
"code": "待岗",
"name": "待岗",
"desc": "待岗",
"isInherit": false
},
{
"code": "其他",
"name": "其他",
"desc": "其他",
"isInherit": false
}
],
"children": [],//子人员类型列表
"level": 0,//人员类型的树层级，前端展示用
"createTime": "2019-06-18T09:08:19.762+0000",//人员类型的创建时间
"pageId": null,//人员类型对应的人员管理页面的id
"isDeleted": null,//人员类型是否被删除
"updatedTime": null//人员类型的更新时间
},
{
"id": "5d089152ac438c8026912af1",
"parentId": null,
"code": "2",
"name": "实习生",
"desc": "实习生",
"isDefault": true,
"identityCategoryUserStatuses": [
{
"code": "返聘",
"name": "返聘",
"desc": "返聘",
"isInherit": false
},
{
"code": "调出",
"name": "调出",
"desc": "调出",
"isInherit": false
},
{
"code": "辞职",
"name": "辞职",
"desc": "辞职",
"isInherit": false
},
{
"code": "离职",
"name": "离职",
"desc": "离职",
"isInherit": false
},
{
"code": "下落不明",
"name": "下落不明",
"desc": "下落不明",
"isInherit": false
},
{
"code": "在职",
"name": "在职",
"desc": "在职",
"isInherit": false
},
{
"code": "延聘",
"name": "延聘",
"desc": "延聘",
"isInherit": false
},
{
"code": "开除",
"name": "开除",
"desc": "开除",
"isInherit": false
},
{
"code": "下落不明",
"name": "下落不明",
"desc": "下落不明",
"isInherit": false
},
{
"code": "其他",
"name": "其他",
"desc": "其他",
"isInherit": false
}
],
"children": [],
"level": 0,
"createTime": "2019-06-18T09:16:26.190+0000",
"pageId": null,
"isDeleted": null,
"updatedTime": null
},
{
"id": "5d089249ac438c8026912af8",
"parentId": null,
"code": "05",
"name": "临时人员",
"desc": "临时人员",
"isDefault": true,
"identityCategoryUserStatuses": [
{
"code": "退休",
"name": "退休",
"desc": "退休",
"isInherit": false
},
{
"code": "离休",
"name": "离休",
"desc": "离休",
"isInherit": false
},
{
"code": "退休",
"name": "退休",
"desc": "退休",
"isInherit": false
},
{
"code": "死亡",
"name": "死亡",
"desc": "死亡",
"isInherit": false
},
{
"code": "返聘",
"name": "返聘",
"desc": "返聘",
"isInherit": false
},
{
"code": "调出",
"name": "调出",
"desc": "调出",
"isInherit": false
},
{
"code": "辞职",
"name": "辞职",
"desc": "辞职",
"isInherit": false
},
{
"code": "离职",
"name": "离职",
"desc": "离职",
"isInherit": false
},
{
"code": "开除",
"name": "开除",
"desc": "开除",
"isInherit": false
},
{
"code": "下落不明",
"name": "下落不明",
"desc": "下落不明",
"isInherit": false
},
{
"code": "在职",
"name": "在职",
"desc": "在职",
"isInherit": false
},
{
"code": "延聘",
"name": "延聘",
"desc": "延聘",
"isInherit": false
},
{
"code": "待退休",
"name": "待退休",
"desc": "待退休",
"isInherit": false
},
{
"code": "长病假",
"name": "长病假",
"desc": "长病假",
"isInherit": false
},
{
"code": "因公出国",
"name": "因公出国",
"desc": "因公出国",
"isInherit": false
},
{
"code": "停薪留职",
"name": "停薪留职",
"desc": "停薪留职",
"isInherit": false
},
{
"code": "待岗",
"name": "待岗",
"desc": "待岗",
"isInherit": false
},
{
"code": "其他",
"name": "其他",
"desc": "其他",
"isInherit": false
}
],
"children": [],
"level": 0,
"createTime": "2019-06-19T09:08:19.762+0000",
"pageId": null,
"isDeleted": null,
"updatedTime": null
}
]
}
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| schoolId | String | 数据项id |
| number | String | 数据项的编号 |
| name | String | 数据项的名称 |
| cnshortname | String | 数据项的中文简称 |
| constraint | String | 是否必填， REQUIRED为必填， OPTIONAL为可选 |
| isUnique | String | 数据项是否有唯一约束 |
| explain | String | 数据项的解释 |
| valueSpace | String | 数据项的值空间 |
| valueSpaceShow | String | 数据项的值空间展示名称 |
| userPropertyId | String | 数据项的平台标准id |
3 组织终身id生成规则与外部系统对接（1.9.1版本）
请求地址
http://self.xxx.com/linkid/api/public/id/generate
请求示例
{
"ruleId":"xxxxx",
"from":"R", // R: 自然人， I: 组织身份类别, O：组织中心
"identityInfo": {"SFLBDM":"01"}, // 用户信息:身份信息，人信息
"identityCategoryInfo": {"code":"01","name":"员工"}, // 身份类型定义信息
}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| ruleId | string | SourceId生成规则id， 找实施经理提供 |
| from | string | R: 自然人， I: 组织身份类别, O：组织中心 |
| identityInfo | map | {"SFLBDM":"01"} 用户信息:身份信息，人信息 如果生成规则需要根据人的信息来生成id， 则需要传对应的信息， 否则不需要传 例： 规则：人员类型代码+当前日期yyyyMMdd+随机数字， 则需要传用户的人员类型代码SFLBDM |
| identityCategoryInfo | map | {"code":"01","name":"员工"}, 身份类型定义信息 如果生成规则需要根据身份类型的信息来生成id， 则需要传对应的信息， 否则不需要传 |
返回参数
{
"code" : 200,
"message" : "OK",
"data" : "JXRY20210001"
}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 接口返回码， 200：请求成功 |
| message | string | R: 自然人， I: 组织身份类别, O：组织中心 |
| data | String | 生成的id值 |
接口调用失败请查看开发指南-Token与Api调用失败须知
4 查询自然人标准 对外API接口（1.9.1版本）
请求地址
http://self.xxx.com/linkid/public/api/standard/personnelstandard
请求方式
POST
请求示例
http://self.xxx.com/linkid/public/api/standard/personnelstandard
参数说明
无
返回参数
{
"code": 200,
"message": "OK",
"data": [
{
"identityTypeCode": "0",
"identityTypeName": "自然人",
"dataSubset": "自然人数据子集",
"standardClass": "基本信息",
"standardSubclass": "基本信息子类1",
"dataItemDetails": {
"number": "RY010101",
"code": "TEST",
"chineseAbbreviation": "TEST",
"isRequired": false,
"isUnique": false,
"valueSpace": "unlimitLengthStr",
"explain": "解释/举例",
"type": "C",
"length": 123123,
"dictValueDetails": null
}
},
{
"identityTypecode": "0",
"identityTypeName": "自然人",
"dataSubset": "自然人数据子集",
"standardClass": "基本信息",
"standardSubclass": "基本信息子类1",
"dataItemDetails": {
"number": "RY010102",
"code": "BODY",
"chineseAbbreviation": "BODY",
"isRequired": false,
"isUnique": false,
"valueSpace": "dict",
"explain": "解释/举例",
"type": "C",
"length": 123123,
"dictValueDetails": [
{
"desc": "字典说明1",
"value": "字典代码1",
"label": "字典值1",
"children": [
{
"desc": "字典说明1.1",
"value": "字典代码1.1",
"label": "字典值1.1",
"children": []
},
{
"desc": "字典说明2",
"value": "字典代码2",
"label": "字典值2",
"children": []
}
]
},
{
"desc": "字典说明2",
"value": "字典代码2",
"label": "字典值2",
"children": [
{
"desc": "字典说明",
"value": "字典代码",
"label": "字典值",
"children": []
}
]
}
]
}
},
{
"identityTypeCode": "0",
"identityTypeName": "自然人",
"dataSubset": "自然人数据子集",
"standardClass": "基本信息",
"standardSubclass": null,
"dataItemDetails": {
"number": "RY010004",
"code": "XB",
"chineseAbbreviation": "性别",
"isRequired": false,
"isUnique": false,
"valueSpace": "dict",
"explain": "1 男性;2 女性",
"type": "",
"length": null,
"dictValueDetails": [
{
"desc": null,
"value": "0",
"label": "未知的性别",
"children": []
},
{
"desc": null,
"value": "1",
"label": "男性",
"children": []
},
{
"desc": null,
"value": "2",
"label": "女性",
"children": []
},
{
"desc": null,
"value": "9",
"label": "未说明的性别",
"children": []
}
]
}
}
]
}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 接口返回码， 200：请求成功 |
| message | string | R: 自然人， I: 组织身份类别, O：组织中心 |
| data | list | 自然人标准数据集 |
| identityTypecode | string | 身份类型编码 |
| identityTypeName | string | 自然人标准数据集 |
| dataSubset | string | 数据子集 |
| standardClass | string | 标准类 |
| standardSubclass | string | 标准子类 |
| dataItemDetails | Object | 数据项详情结构 |
| dataItemDetails.number | string | 数据项编号 |
| dataItemDetails.code | string | 数据项编码 |
| dataItemDetails.chineseAbbreviation | string | 中文简称 |
| dataItemDetails.isRequired | boolean | 约束 false：可选、true：必填 |
| dataItemDetails.isUnique | boolean | 唯一性 true：唯一、false：不唯一 |
| dataItemDetails.valueSpace | string | 值空间 dict：字典表、unlimitLengthStr：无限制字符串、limitLengthStr：限制长度的字符串、trimWhiteSpaceStr：去除多余空格字符串、oWhiteSpaceStr：去空格字符串、customStr：自定义格式字符串、number：数字、date：日期、 year：年、 yearMonth：年月、 time：时间、 dateTime：日期和时间、 department：部门、 post：岗位、 birthPlace：籍贯、 sflbdmTreeDict：人员类型 |
| dataItemDetails.explain | string | 数据项解释说明 |
| dataItemDetails.type | string | 类型 C-字符、 N-数值、 M-币值、 B-二进制、 T-文本 |
| dataItemDetails.length | string | 长度 |
| dictValueDetails | string | 字典表详情结构 |
| dictValueDetails.desc | string | 字典说明 |
| dictValueDetails.value | string | 字典代码 |
| ddictValueDetails.label | string | 字典值 |
| dictValueDetails.children | list | 子字典表详情结构 |
接口调用失败请查看开发指南-Token与Api调用失败须知
5 根据身份类型查询组织身份类型标准 对外API接口（1.9.1版本）
请求地址
http://self.xxx.com/linkid/public/api/standard/identity/types/{identityTypeCode}
请求方式
POST
请求示例
http://self.xxx.com/linkid/public/api/standard/identity/types/01
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| identityTypeCode | string | 组织身份类型标准编码code |
返回参数
{
"code" : 200,
"message" : "OK",
"data" : [
{
"identityTypeCode": "01",
"identityTypeName": "员工",
"dataSubset": "员工管理数据子集",
"standardClass": "员工基本数据类",
"standardSubclass": "员工基础数据子类",
"dataItemDetails": {
"number": "JG010102",
"code": "WHCDM",
"chineseAbbreviation": "文化程度码",
"isRequired": false,
"isUnique": false,
"valueSpace": "unlimitLengthStr",
"explain": "本人实际具有的文化水平",
"type": "",
"length": null,
"dictValueDetails": null
}
},
{
"identityTypeCode": "01",
"identityTypeName": "员工",
"dataSubset": "员工管理数据子集",
"standardClass": "员工基本数据类",
"standardSubclass": null,
"dataItemDetails": {
"number": "RY010004",
"code": "XB",
"chineseAbbreviation": "性别",
"isRequired": false,
"isUnique": false,
"valueSpace": "dict",
"explain": "1 男性;2 女性",
"type": "",
"length": null,
"dictValueDetails": [
{
"desc": null,
"value": "0",
"label": "未知的性别",
"children": []
},
{
"desc": null,
"value": "1",
"label": "男性",
"children": []
},
{
"desc": null,
"value": "2",
"label": "女性",
"children": []
},
{
"desc": null,
"value": "9",
"label": "未说明的性别",
"children": []
}
]
}
}
]
}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 接口返回码， 200：请求成功 |
| message | string | R: 自然人， I: 组织身份类别, O：组织中心 |
| data | list | 自然人标准数据集 |
| identityTypecode | string | 身份类型编码 |
| identityTypeName | string | 自然人标准数据集 |
| dataSubset | string | 数据子集 |
| standardClass | string | 标准类 |
| standardSubclass | string | 标准子类 |
| dataItemDetails | Object | 数据项详情结构 |
| dataItemDetails.number | string | 数据项编号 |
| dataItemDetails.code | string | 数据项编码 |
| dataItemDetails.chineseAbbreviation | string | 中文简称 |
| dataItemDetails.isRequired | boolean | 约束 false：可选、true：必填 |
| dataItemDetails.isUnique | boolean | 唯一性 true：唯一、false：不唯一 |
| dataItemDetails.valueSpace | string | 值空间 dict：字典表、unlimitLengthStr：无限制字符串、limitLengthStr：限制长度的字符串、trimWhiteSpaceStr：去除多余空格字符串、oWhiteSpaceStr：去空格字符串、customStr：自定义格式字符串、number：数字、date：日期、 year：年、 yearMonth：年月、 time：时间、 dateTime：日期和时间、 department：部门、 post：岗位、 birthPlace：籍贯、 sflbdmTreeDict：人员类型 |
| dataItemDetails.explain | string | 数据项解释说明 |
| dataItemDetails.type | string | 类型 C-字符、 N-数值、 M-币值、 B-二进制、 T-文本 |
| dataItemDetails.length | string | 长度 |
| dictValueDetails | string | 字典表详情结构 |
| dictValueDetails.desc | string | 字典说明 |
| dictValueDetails.value | string | 字典代码 |
| ddictValueDetails.label | string | 字典值 |
| dictValueDetails.children | list | 子字典表详情结构 |
接口调用失败请查看开发指南-Token与Api调用失败须知