调用GetProfileList接口分页获取人员档案列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetProfileList

系统规定参数。取值:GetProfileList。

CorpId String 区域id

区域id

IsvSubId String 区域中对人员数据隔离

区域中对人员数据隔离

PageNumber Long 1

页码

PageSize Long 20

每页大小

Name String 人员档案名称

人员档案名称

CatalogId Long 1

人员分类ID

IdNumber String 身份证号码

身份证号码

FaceUrl String 人脸图片

人脸图片

LiveAddress String 居住地址

居住地址

Gender Integer 1

性别1男2女

PlateNo String 车牌号码

车牌号码

PhoneNo String 手机号码

手机号码

SceneType String 客户附属信息,由客户自定义决定是否填写

客户附属信息,由客户自定义决定是否填写

BizId String 1

客户方具有唯一性的业务id,允许为空,不允许和身份证号同时为空,身份证号和业务id同时出现,业务方id优先级大于身份证号。

PersonIdList Json ["a1"]

动态人员Id集合

ProfileIdList Json [1,2,3]

用户档案ID集合

MatchingRateThreshold String 0.8

相似度匹配阈值

FaceImageId String http://xxxx:ssss/a.jpg

动态人员图片地址

返回数据

名称 类型 示例值 描述
Code String OK

响应码

Data Struct

数据响应实体

PageNumber Long 1

页码

PageSize Long 20

每页大小

Records Array of Records

结果集合

BizId String 1

客户方具有唯一性的业务id,允许为空,不允许和身份证号同时为空,身份证号和业务id同时出现,业务方id优先级大于身份证号。

CatalogId Integer 1

人员分类Id

FaceUrl String 人脸图片

人脸图片

Gender String 1

性别1男2女

IdNumber String 身份证号码

身份证号码

IsvSubId String 区域中对人员数据隔离

区域中对人员数据隔离

Name String 人员档案名称

人员档案名称

PersonId String 1

动态人员ID

ProfileId Integer 1

用户档案Id

SceneType String 客户附属信息,由客户自定义决定是否填写

客户附属信息,由客户自定义决定是否填写

SearchMatchingRate String 0.8

相似度,最大不会超过1

Success Boolean true

是否成功

Total Long 100

总页数

Message String SUCCESS

错误消息

RequestId String XXXX-XXX-XXXX

本地请求链路追踪id

示例

请求示例

http(s)://[Endpoint]/?Action=GetProfileList
&PageNumber=1
&PageSize=20
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>XXXX-XXX-XXXX</RequestId>
<Message>SUCCESS</Message>
<Data>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <Total>100</Total>
    <Records>
        <ProfileId>1</ProfileId>
        <SceneType>客户附属信息,由客户自定义决定是否填写</SceneType>
        <PersonId>1</PersonId>
        <IdNumber>身份证号码</IdNumber>
        <IsvSubId>区域中对人员数据隔离</IsvSubId>
        <SearchMatchingRate>0.8</SearchMatchingRate>
        <Gender>1</Gender>
        <CatalogId>1</CatalogId>
        <BizId>1</BizId>
        <FaceUrl>人脸图片</FaceUrl>
        <Name>人员档案名称</Name>
    </Records>
    <Success>true</Success>
</Data>
<Code>OK</Code>

JSON 格式

{"RequestId":"XXXX-XXX-XXXX","Message":"SUCCESS","Data":{"PageSize":"20","PageNumber":"1","Total":"100","Records":[{"ProfileId":"1","SceneType":"客户附属信息,由客户自定义决定是否填写","PersonId":"1","IdNumber":"身份证号码","IsvSubId":"区域中对人员数据隔离","SearchMatchingRate":"0.8","Gender":"1","CatalogId":"1","BizId":"1","FaceUrl":"人脸图片","Name":"人员档案名称"}],"Success":"true"},"Code":"OK"}

错误码

HttpCode 错误码 错误信息 描述
401 InvalidCorpId The specified CorpId is invalid. ISV要操作的组织不存在.

访问错误中心查看更多错误码。