简要描述:

  • 用户增量数据

接口版本:

版本号 制定人 制定日期 修订日期
v0.1 dev 2020-03-23 init

请求URL:

  • http://{api-gateway-host}/base/modify_users/action/search

请求方式:

  • POST

认证方式:

  • HMAC

详细可参见 开放平台API的认证说明

请求头:

参数名 是否必须 类型 说明
Content-Type string 请求类型: application/json
Date string http协议标准头
Authorization string hmac 签名
sdp-app-id string 应用租户ID,具体信息获取方式参见应用的sdp-app-id参数获取方式
#### 请求参数:

|参数名|是否必须|类型|默认值|说明|
|body |是|ModifyUserParam||搜索条件|

#####SchoolVoForSearch

|参数名|是否必须|类型|默认值|说明|
|:—- |:—|:—– |—– |
|offset|是|long||分页索引|
|limit|是|long||每页数量|
|org_id|是|long||组织id(学校id)|
|operate|否|string||操作类型:CREATE、UPDATE、DELETE 不传为全部操作|
|stat_period_start_date|是|long||操作开始时间:格式yyyyMMdd|
|stat_period_end_date|是|long||操作结束时间:格式yyyyMMdd|

返回示例:

正确时返回:

{
    "total": 0,
    "items": [
        {
            "user_id": 0,
            "real_name": "string",
            "nick_name": "string",
            "org_user_code": "string",
            "gender": 0,
            "icon": "string",
            "org_id": 0,
            "org_name": "string",
            "node_id": 0,
            "node_name": "string",
            "status": "string",
            "identities": [
                {
                    "code": "string",
                    "name": "string"
                }
            ],
            "stations": [
                {
                    "station_id": "string",
                    "station_name": "string"
                }
            ],
            "ic_card": "string",
            "subjects": [
                {
                    "subject_id": "string",
                    "subject_name": "string"
                }
            ],
            "operate": "string",
            "tenant_id": "string",
            "stat_time_dimension": 0,
            "stat_period_code": "string",
            "stat_period_start_date": 0,
            "stat_period_end_date": 0
        }
    ]
}

错误时返回:

返回参数说明:

参数名 类型 说明
total long 总数
items EduUserVo 用户记录
#####EduUserVo
参数名 类型 说明
:—– :—– —–
user_id long 用户id(真实的用户id)
real_name string 用户姓名
nick_name string 昵称
org_user_code string 工号(学生是学号,教师是工号)
gender int 性别:1男 2女
icon string 头像
org_id long 组织id(学校id)
org_name string 组织名称(学校名称)
node_id long 节点标识(有可能是学校、班级、部门,一般学生是班级、教师是部门)
node_name string 节点名称 (有可能是学校、班级、部门,一般学生是班级、教师是部门)
status int 状态:0不可用 1可用
identities array[IdentityVo] 身份(学生、教师等)
stations array[StationVo] 岗位
ic_card string IC卡号
subjects array[SubjectVo] 任教学科
operate string 操作类型:CREATE、UPDATE、DELETE
stat_period_start_date int 统计开始日期
stat_period_end_date int 统计结束日期
#####IdentityVo
参数名 类型 说明
:—– :—– —–
code string 身份编码
name string 身份名称
#####StationVo
参数名 类型 说明
:—– :—– —–
station_id string 岗位编码
station_name string 岗位名称
#####SubjectVo
参数名 类型 说明
:—– :—– —–
subject_id string 学科标识
subject_name string 学科名称
作者:wangtc  创建时间:2023-10-08 10:41
最后编辑:hcx  更新时间:2023-11-21 03:09