routeId标识

接口名称

接口说明

JB7EYW

通讯录-获取部门列表

参数：

1. pid：【非必传】部门父id（为空时默认查询单位下第一层的部门信息）

返回结果：

正确返回：

         "data": [{

                  "category": "Z01",  部门排序权值

                  "children": [],

                  "createtime": 1553584970842,  创建时间

                  "creatorid": 22329933,  部门创建人唯一标识

                  "custom": 0,  0单位通讯录 1自建 2自部门

                  "fid": 68920,  所属单位fid

                  "id": 316711,  部门唯一标识

                  "level": 1,   部门所属层级

                  "name": "默认部门",  部门名称

                  "open": 0,  是否是公开部门，1为是，0为否，

如果是，那么这个部门本单位所有人可见

                  "pid": -1,  部门父级唯一id

                  "ppath": "00000001KOF",  部门路径

              "privilege": 0, 是否是特权部门，1为是，0为否，

如果是，那么这个部门下人可以看到所有部门

                  "rootdept": 316711,  所在根部门唯一标识

                  "usercount": 1  部门下的用户数

         },{

     ......

}]

遇错返回：

"data":"失败"  错误说明

JB7Hf9

通讯录-创建部门

参数：

1.name：【必传】部门名称（传递过程中需进行URLEncoder编码）

2. pid：【非必传】此部门的上级部门的id，如果要建的这个部门就是根部门，那么此参数传-1或不传

3. privilege：【非必传】是否是特权部门。默认为0 ( 1为是，0为否，如果是，那么这个部门下人可以看到所有部门)

4. open：【非必传】是否是公开部门。默认为0（1为是，0为否，如果是那么这个部门本单位所有人可见）

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JB7HtB

通讯录-修改部门

参数：

1.name：【必传】部门名称（传递过程中需进行URLEncoder编码）

2. deptid：【必传】要修改的部门的id

3. category：【非必传】根据英文字母和数字的排序字段4. privilege：【非必传】是否是特权部门。默认为0 ( 1为是，0为否，如果是，那么这个部门下人可以看到所有部门)

5. open：【非必传】是否是公开部门。默认为0（1为是，0为否，如果是那么这个部门本单位所有人可见）

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JB7Hx9

通讯录-删除部门

参数：

1. deptid：【非必传】要删除的部门的id，不传时删除单位下所有部门

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JBEAcu

向部门里添加人员（可批量）

参数：

1.puids：【非必传】用户唯一标识uid的数组，比如puids=123,2342,879090（当puids不为为空时，以puid数组添加。当puids为空时，以uid数组添加。二者必有其一）

2.uids：【非必传】用户唯一标识uid的数组，比如puids=123,2342,879090（此uid是学习通uid）

3. deptid：【必传】部门id

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JBFGXH

删除某个部门下的人员（可批量）

参数：

1.userids：【必传】用户唯一标识uid的集合，JSONArray里面是一个个的用户uid，例：[1721,123,44]

2. deptid：【必传】部门id

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JBEBeQ

修改用户信息

参数：

1.uid：【必传】用户信息唯一标识

2. displaynam：【必传】要修改的用户真实姓名

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JC9Dxp

通讯录-移动部门（将一个部门及其子部门以及人员移动其他部门或根目录下[异步执行]）

参数：

1.deptId：【必传】要操纵的部门唯一标识id

2. pid：【非必传】要移动到的目标部门唯一标识id，为空时默认移动至此单位通讯录根目录

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

JCGFJl

用户账号移除单位（支持移除具体某个学工号）

参数：

1.uid：【必传】用户信息唯一标识

2.operatorUid：【必传】用户移除操作-操作人uid

3. uname：【非必传】用户学工号，不为空时表示指定只冻结此学工号；

返回结果：

正确返回：

         "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

KAEH7C

单位用户检索

参数：

1.keyword ：【非必传】检索词,支持姓名和学工号模糊搜索，手机号精确搜索

2. group1 ：【非必传】第1级组织架构id 默认-1 支持多组织架构，逗号隔开

3. group2 ：【非必传】第2级组织架构id 默认-1 支持多组织架构，逗号隔开

4. group3 ：【非必传】第3级组织架构id 默认-1 支持多组织架构，逗号隔开

5. group4 ：【非必传】第4级组织架构id 默认-1 支持多组织架构，逗号隔开

6. group5 ：【非必传】第5级组织架构id 默认-1 支持多组织架构，逗号隔开

7. showdept ：【非必传】true 显示全部门名称 false不显示

8. offset ：【非必传】起始位置，默认从0开始

9. limit ：【非必传】获取条数，默认10，

10. roleids ：【非必传】角色 支持多角色，逗号隔开

11. userids ：【非必传】用户uid   支持多个uid，逗号隔开

12. currlogintime ：【非必传】默认-1全部  1激活

返回结果：

正确返回：

         "data": {

                  "total": 总数,

                  "json": [{

                           "fid": 单位fid,

                           "role": [],角色（多个）,

                           "schoolType": 高校类型,

                           "userid": 用户userid,

                           "dxfid":读秀fid,

                           "isDeleted": 是否删除，0未删除，1删除,

                           "areaName":地区,

                           "schoolYear": 入学年份,

                           "personid": 用户id,

                           "isCertify": 认证状态 0未认证 1认证,

                           "createtime": 创建时间,

                           "currLoginTime": 激活时间,

                           "group4": [],教学组织架构

                           "group3": [],教学组织架构

                           "group5": [],教学组织架构

                           "alias_name": 学工号,

                           "group2": [],教学组织架构

                           "realname": 姓名,

                           "group1": [],教学组织架构

                           "pinyin":姓名拼音,

                           "areaId": ,区域id

                           "phone": 手机号,

                           "username": 用户账号,

                           "status": ,状态，2代表冻结

                           "isLeaveSchool": 是否离校 1代表离校

                  }],

                  "status": true

         }

遇错返回：

             "data":"失败"  错误说明

参数：

1.uid ：【必传】通知发送人uid

2. content ：【必传】通知正文（换行使用\n）

3. noticeId ：【非必传】通知id

4. title ：【非必传】通知标题

5. logo_url ：【非必传】通知图标url

6. logo ：【非必传】通知图标(如果logo_url为空，可以上传图片logo)

7. logo_url2 ：【非必传】通知图标url（接收方）

8. logo2 ：【非必传】通知图标(如果logo_url为空，可以上传图片logo)（接收方）

9. isRtf ：【非必传】是否是富文本，1/0-是/否

10. rtf_content ：【非必传】富文本内容,有格式规定，请勿随意传入

11. files ：【非必传】通知图片列表

12. files_url ：【非必传】图片地址列表；当多个地址时以;区分

13. touids ：【非必传】通知接收人uid列表(以,分割)不建议单次超过500个。如1011,1290,78。（touids和tobbsids不能同时为空）

14. users ：【非必传】通知接收人uid列表人员信息json数组[{"puid":,"name":,"fid":,"phone":}]

15. tobbsids ：【非必传】通通知接收小组bbsid列表(以,分割)。（touids和tobbsids不能同时为空）

16. todeptids ：【非必传】通知部门id列表（json结构：[{deptId:,deptName:},...]）

17. toclazzids ：【非必传】mooc班级id，多个id使用英文逗号分隔

18. tocc ：【非必传】抄送人json数组[{"type":1,"puid":,"name":"人名"},{"type":2,"circleId":,"name":"小组名"},{"type":3,"deptId":,"name":"部门名"},{"type":4,"clazzId":,"name":"课程名"}]

19. replyFloor ：【非必传】被回复通知层级逗号“,”分割的通知id

20. tag ：【非必传】标签（来源是泛雅的课程时，标签格式："courseId"+courseId）

21. moocUrl ：【非必传】mooc镜像域名

22. source_type ：【非必传】来源类型:
1:话题
2:笔记
3:专题
4:报纸
5:网络阅读
6:期刊
7:小组
10:课程作业
14:课程通知
15:应用内提醒
1000:信件
4000:办公相关
50000:用户修改密码后的系统通知

23. attachment ：【非必传】附件json数组(格式参考学习通附件文档，文档地址：http://cloud.ananas.chaoxing.com/view/fileview?appId=1000&objectid=3234a5a0de30d679ef54a9fc9a53871b 或在线文档 https://document.chaoxing.com/web/#/3?page_id=44 附件为json数组)

24. sourceUrl ：【非必传】资源地址-将会自动跳转并且标记已读（考虑兼容旧版客户端，建议附件中添加web卡片附件）

25. uuid ：【非必传】发通知时传递的全部有意义参数组合在一起后生成的MD5值

26. flag ：【非必传】course_activity:课程活动通知

27. noticeTarget ：【非必传】通知接收人所属班级
[{
"classId": 123456,
"studentIds": [
100001,
100002,
100003
]
},
{
"classId": 123457,
"studentIds": [
200001,
200002
]
}]
classId:班级id
studentIds:通知接收人puid

28. letter_mode ：【非必传】信件模式:0：评论模式，1：回复模式

29.allow_comments ：【非必传】是否允许评论:0：允许，1：不允许

30. showRead ：【非必传】是否显示已读0-显示，1-不显示

31. visible ：【非必传】是否可见 0-全部可见，1-接收人可见

32. cparams ：【非必传】通客户端定义json字符串参数,作存储(合理控制长度)

33. files_url ：【非必传】图片地址列表；当多个地址时以;区分

返回结果：

正确返回：

         "data": {

                  "content": 通知内容,

                  "count_all": ,全部

                  "count_read": ,已读

                  "createrId": ,

                  "createrName":通知发送人姓名,

                  "createrPuid": 通知发送人uid,

                  "id": 通知id,

                  "idCode": ,

                  "insertTime": 通知创建时间,

                  "isRtf": 是否富文本，

                  "personStatus": ,

                  "sendTime": 通知发送时间,

                  "source": ,

                  "sourceType": ,

                  "status": ,

                  "top":

         }

遇错返回：

L6UGOi

撤回通知

参数：

1. puid ：【必传】通知发送人puid
2. noticeId ：【非必传】通知id，（noticeId和sid不能同时为空）
3. sid ：【非必传】通知加密id，（sid和noticeId不能同时为空）

返回结果：

正确返回：

          "data":"成功"  

遇错返回：

             "data":"失败"  错误说明

参数：

1. puid ：【必传】用户唯一puid
2. noticeId ：【必传】通知唯一id

返回结果：

正确返回：

          "data":"成功"  

遇错返回：

参数：

1. deptId：【必传】要查询的部门唯一标识id

返回结果：

正确返回：

         "data":{

                  "list": {

                           "managers": [{

                                    "name": 主管姓名,

                                    "nick": 主管昵称,

                                    "puid":主管唯一uid ,

                                    "sex":主管性别（1男 0女-1：保密 ）

                           }]

                  }

         }

遇错返回：

             "data":"失败"  错误说明

参数：

1. deptId ：【必传】部门id
2. puids ：【必传】管理员用户puid字符串，多个以英文逗号分隔，一次最多20个

3. manager ：【必传】1、设置管理员；0、取消管理员

返回结果：

正确返回：

          "data":"成功"  

遇错返回：

L2MIoE

根据管理员uid获取管理员管理的部门

参数：

1.puid ：【必传】管理员uid

2. pageSize ：【必传】每页获取的数据量，默认50，最大300

3. offsetValue ：【非必传】偏移查询参数，第一次调用不用传，后面调用传接口返回的lastValue

返回结果：

正确返回：

         "data":{

        "lastValue": ,

        "lastPage": 最后页数,

        "pageSize": 每页数量,

        "list": [

            {

                "category": ,

                "children": 子部门,

                "createtime": 创建时间,

                "creatorid": 创建人uid,

                "custom": ,

                "fid": 所在单位fid,

                "fullpinyin": 名称拼音,

                "id": 部门id,

                "level": 层级,

                "name": 部门名称,

                "open": ,

                "pid": 父级id,

                "ppath": 层级体现,

                "privilege": ,

                "rootdept": ,

                "simplepinyin": ,

                "subdeptcount": ,

                "usercount":

            }

        ]

         }

遇错返回：

             "data":"失败"  错误说明

L31F2g

根据人员uid和单位fid查询用户所在的部门信息

参数：

1. puid ：【必传】人员UID
2. cpage ：【非必传】当前页码，默认为1
3. pageSize ：【非必传】页码长度，默认10, 每页最多取100条

返回结果：

正确返回：

    "data": [

        {

            "category": ,

            "children": 子部门,,

            "createtime": 创建时间,

            "creatorid": 创建人uid,

            "custom":

            "fid": 所在单位fid,

            "fullpinyin": 部门名称拼音,

            "id": 部门id,

            "level":层级,

            "name": 部门名称,

            "open":

            "pid": 父级id,

            "ppath":层级体现,

            "privilege":

            "rootdept":

            "simplepinyin":

            "subdeptcount":

            "usercount":

            "utime":

        }

    ]

遇错返回：

             "data":"失败"  错误说明

W1CtfG

通讯录—根据部门获取用户信息

参数：

deptid（非必须）：string，部门id；

puid（必须）：long，操作者uid；

offsetValue（非必须）：string，偏移分页参数（用了此参数则不用cpage），第一次调用时候不传，第二次及以后调用时传接口返回的 lastValue值；

offsetAuxValue（非必须）：string，偏移分页辅助参数，第一次调用时候不传，第二次及以后调用时传接口返回的 lastAuxValue值（目前sortByCategory需要使用）；

pageSize（非必须）：string，每页显示的条数，默认为100，最大1000

返回结果：

整体结构：

result=1表示接口调用成功，获取的信息放入data节点中,

result=0表示调用失败，失败描述信息放入errorMsg节点中

msg描述：

data中节点描述

list: 用户数据

lastValue：最后一条记录的值，下次调用接口时用

lastPage：是否是最后一页（1、是；0、不是）

W2L7nf

组织架构—获取单位组织架构

参数：

Gid（非必须）：gid传0或者不传代表获取第一级组织架构

Offset：起始位置，默认从0开始

Limit：获取条数，默认10

Fields：（必须）要返回的字段=id,groupname,gid

serviceId（非必须）：架构id，默认为0，不传的时候查默认架构

返回结果：

成功:

{

"data": [{

"gid": 73062,（上一级id）

"id": 1486714,

"sort": 1489175,

"groupname": "牡丹江培训技术学校"

}, {

"gid": 73062,

"id": 1526873,

"groupname": "北京协和医学院护理学院"

}],

"count": 738

}