WxCpSchoolUserService (WxJava - CP Java SDK 4.7.0 API)

所有已知实现类:

WxCpSchoolUserServiceImpl
```
public interface WxCpSchoolUserService
```
企业微信家校沟通相关接口. https://developer.work.weixin.qq.com/document/path/91638

作者:

Wang_Wong created on : 2022/6/18 9:10

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`WxCpBatchResultList`	`batchCreateParent(@NonNull WxCpBatchCreateParentRequest request)` 批量创建家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_parent?
`WxCpBatchResultList`	`batchCreateStudent(@NonNull WxCpBatchCreateStudentRequest request)` 批量创建学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_student?
`WxCpBatchResultList`	`batchDeleteParent(String... userIdList)` 批量删除家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_parent?
`WxCpBatchResultList`	`batchDeleteStudent(@NonNull WxCpBatchDeleteStudentRequest request)` 批量删除学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_student?
`WxCpBatchResultList`	`batchUpdateParent(@NonNull WxCpBatchUpdateParentRequest request)` 批量更新家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_parent?
`WxCpBatchResultList`	`batchUpdateStudent(@NonNull WxCpBatchUpdateStudentRequest request)` 批量更新学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_student?
`String`	`convertToOpenId(@NonNull String externalUserId)` 外部联系人openid转换企业和服务商可通过此接口，将微信外部联系人的userid（如何获取?）
`WxCpCreateDepartment`	`createDepartment(@NonNull WxCpCreateDepartmentRequest request)` 创建部门请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/create?
`WxCpBaseResp`	`createParent(@NonNull WxCpCreateParentRequest request)` 创建家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?
`WxCpBaseResp`	`createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List<Integer> departments)` 创建学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?
`WxCpBaseResp`	`deleteDepartment(Integer id)` 删除部门请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?
`WxCpBaseResp`	`deleteParent(@NonNull String userId)` 删除家长请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?
`WxCpBaseResp`	`deleteStudent(@NonNull String studentUserId)` 删除学生请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?
`WxCpAllowScope`	`getAllowScope(@NonNull Integer agentId)` 获取可使用的家长范围获取可在微信「学校通知-学校应用」使用该应用的家长范围，以学生或部门列表的形式返回。
`WxCpExternalContact`	`getExternalContact(@NonNull String externalUserId)` 获取外部联系人详情学校可通过此接口，根据外部联系人的userid（如何获取?）
`WxCpOauth2UserInfo`	`getSchoolUserInfo(@NonNull String code)` 获取家校访问用户身份该接口用于根据code获取家长或者学生信息请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?
`Integer`	`getSubscribeMode()` 获取关注「学校通知」的模式可通过此接口获取家长关注「学校通知」的模式：“可扫码填写资料加入”或“禁止扫码填写资料加入” 请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_subscribe_mode?
`WxCpSubscribeQrCode`	`getSubscribeQrCode()` 获取「学校通知」二维码学校可通过此接口获取「学校通知」二维码，家长可通过扫描此二维码关注「学校通知」并接收学校推送的消息。
`WxCpUserResult`	`getUser(@NonNull String userId)` 读取学生或家长请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get?
`WxCpOauth2UserInfo`	`getUserInfo(@NonNull String code)` 获取访问用户身份该接口用于根据code获取成员信息请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?
`WxCpUserListResult`	`getUserList(@NonNull Integer departmentId, Integer fetchChild)` 获取部门成员详情请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list?
`WxCpListParentResult`	`getUserListParent(@NonNull Integer departmentId)` 获取部门家长详情请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?
`WxCpDepartmentList`	`listDepartment(Integer id)` 获取部门列表请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/list?
`WxCpBaseResp`	`setArchSyncMode(@NonNull Integer archSyncMode)` 设置家校通讯录自动同步模式企业和第三方可通过此接口修改家校通讯录与班级标签之间的自动同步模式，注意，一旦设置禁止自动同步，将无法再次开启。
`WxCpBaseResp`	`setSubscribeMode(@NonNull Integer subscribeMode)` 设置关注「学校通知」的模式可通过此接口修改家长关注「学校通知」的模式：“可扫码填写资料加入”或“禁止扫码填写资料加入” 请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/set_subscribe_mode?
`WxCpSetUpgradeInfo`	`setUpgradeInfo(Long upgradeTime, Integer upgradeSwitch)` 修改自动升年级的配置请求方式： POST（HTTPS）请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/set_upgrade_info?
`WxCpBaseResp`	`updateDepartment(@NonNull WxCpUpdateDepartmentRequest request)` 更新部门请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/update?
`WxCpBaseResp`	`updateParent(@NonNull WxCpUpdateParentRequest request)` 更新家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?
`WxCpBaseResp`	`updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List<Integer> departments)` 更新学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?

- 方法详细资料
  - getUserInfo
```
WxCpOauth2UserInfo getUserInfo(@NonNull
                               @NonNull String code)
                        throws WxErrorException
```
    获取访问用户身份该接口用于根据code获取成员信息
    请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
    
    参数:
    
    code - the code
    
    返回:
    
    user info
    
    抛出:
    
    WxErrorException - the wx error exception
  - getSchoolUserInfo
```
WxCpOauth2UserInfo getSchoolUserInfo(@NonNull
                                     @NonNull String code)
                              throws WxErrorException
```
    获取家校访问用户身份该接口用于根据code获取家长或者学生信息
    请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
    
    参数:
    
    code - the code
    
    返回:
    
    school user info
    
    抛出:
    
    WxErrorException - the wx error exception
  - createStudent
```
WxCpBaseResp createStudent(@NonNull
                           @NonNull String studentUserId,
                           @NonNull
                           @NonNull String name,
                           @NonNull
                           @NonNull List<Integer> departments)
                    throws WxErrorException
```
    创建学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?access_token=ACCESS_TOKEN
    
    参数:
    
    studentUserId - the student user id
    
    name - the name
    
    departments - the departments
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchCreateStudent
```
WxCpBatchResultList batchCreateStudent(@NonNull
                                       @NonNull WxCpBatchCreateStudentRequest request)
                                throws WxErrorException
```
    批量创建学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_student?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchDeleteStudent
```
WxCpBatchResultList batchDeleteStudent(@NonNull
                                       @NonNull WxCpBatchDeleteStudentRequest request)
                                throws WxErrorException
```
    批量删除学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_student?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchUpdateStudent
```
WxCpBatchResultList batchUpdateStudent(@NonNull
                                       @NonNull WxCpBatchUpdateStudentRequest request)
                                throws WxErrorException
```
    批量更新学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_student?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - deleteStudent
```
WxCpBaseResp deleteStudent(@NonNull
                           @NonNull String studentUserId)
                    throws WxErrorException
```
    删除学生请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
    
    参数:
    
    studentUserId - the student user id
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - updateStudent
```
WxCpBaseResp updateStudent(@NonNull
                           @NonNull String studentUserId,
                           String newStudentUserId,
                           String name,
                           List<Integer> departments)
                    throws WxErrorException
```
    更新学生请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?access_token=ACCESS_TOKEN
    
    参数:
    
    studentUserId - the student user id
    
    newStudentUserId - the new student user id
    
    name - the name
    
    departments - the departments
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - createParent
```
WxCpBaseResp createParent(@NonNull
                          @NonNull WxCpCreateParentRequest request)
                   throws WxErrorException
```
    创建家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchCreateParent
```
WxCpBatchResultList batchCreateParent(@NonNull
                                      @NonNull WxCpBatchCreateParentRequest request)
                               throws WxErrorException
```
    批量创建家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_parent?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchDeleteParent
```
WxCpBatchResultList batchDeleteParent(@NonNull
                                      String... userIdList)
                               throws WxErrorException
```
    批量删除家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_parent?access_token=ACCESS_TOKEN
    
    参数:
    
    userIdList - the user id list
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - batchUpdateParent
```
WxCpBatchResultList batchUpdateParent(@NonNull
                                      @NonNull WxCpBatchUpdateParentRequest request)
                               throws WxErrorException
```
    批量更新家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_parent?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp batch result list
    
    抛出:
    
    WxErrorException - the wx error exception
  - getUser
```
WxCpUserResult getUser(@NonNull
                       @NonNull String userId)
                throws WxErrorException
```
    读取学生或家长请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
    
    参数:
    
    userId - the user id
    
    返回:
    
    user
    
    抛出:
    
    WxErrorException - the wx error exception
  - getUserList
```
WxCpUserListResult getUserList(@NonNull
                               @NonNull Integer departmentId,
                               Integer fetchChild)
                        throws WxErrorException
```
    获取部门成员详情请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID &fetch_child=FETCH_CHILD
    
    参数:
    
    departmentId - 获取的部门id
    
    fetchChild - 1/0：是否递归获取子部门下面的成员
    
    返回:
    
    user list
    
    抛出:
    
    WxErrorException - the wx error exception
  - getUserListParent
```
WxCpListParentResult getUserListParent(@NonNull
                                       @NonNull Integer departmentId)
                                throws WxErrorException
```
    获取部门家长详情请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id =DEPARTMENT_ID
    
    参数:
    
    departmentId - 获取的部门id
    
    返回:
    
    user list parent
    
    抛出:
    
    WxErrorException - the wx error exception
  - updateParent
```
WxCpBaseResp updateParent(@NonNull
                          @NonNull WxCpUpdateParentRequest request)
                   throws WxErrorException
```
    更新家长请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - deleteParent
```
WxCpBaseResp deleteParent(@NonNull
                          @NonNull String userId)
                   throws WxErrorException
```
    删除家长请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
    
    参数:
    
    userId - the user id
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - setArchSyncMode
```
WxCpBaseResp setArchSyncMode(@NonNull
                             @NonNull Integer archSyncMode)
                      throws WxErrorException
```
    设置家校通讯录自动同步模式企业和第三方可通过此接口修改家校通讯录与班级标签之间的自动同步模式，注意，一旦设置禁止自动同步，将无法再次开启。
    请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/set_arch_sync_mode?access_token=ACCESS_TOKEN
    
    参数:
    
    archSyncMode - 家校通讯录同步模式：1-禁止将标签同步至家校通讯录，2-禁止将家校通讯录同步至标签，3-禁止家校通讯录和标签相互同步
    
    返回:
    
    arch sync mode
    
    抛出:
    
    WxErrorException - the wx error exception
  - createDepartment
```
WxCpCreateDepartment createDepartment(@NonNull
                                      @NonNull WxCpCreateDepartmentRequest request)
                               throws WxErrorException
```
    创建部门
    请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/create?access_token=ACCESS_TOKEN
    
    参数:
    
    request - 请求参数对象
    
    返回:
    
    wx cp create department
    
    抛出:
    
    WxErrorException - the wx error exception
  - updateDepartment
```
WxCpBaseResp updateDepartment(@NonNull
                              @NonNull WxCpUpdateDepartmentRequest request)
                       throws WxErrorException
```
    更新部门
    请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/update?access_token=ACCESS_TOKEN
    
    参数:
    
    request - the request
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - deleteDepartment
```
WxCpBaseResp deleteDepartment(Integer id)
                       throws WxErrorException
```
    删除部门请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID
    
    参数:
    
    id - the id
    
    返回:
    
    wx cp base resp
    
    抛出:
    
    WxErrorException - the wx error exception
  - setSubscribeMode
```
WxCpBaseResp setSubscribeMode(@NonNull
                              @NonNull Integer subscribeMode)
                       throws WxErrorException
```
    设置关注「学校通知」的模式可通过此接口修改家长关注「学校通知」的模式：“可扫码填写资料加入”或“禁止扫码填写资料加入”
    请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/set_subscribe_mode?access_token=ACCESS_TOKEN
    
    参数:
    
    subscribeMode - 关注模式, 1:可扫码填写资料加入, 2:禁止扫码填写资料加入
    
    返回:
    
    subscribe mode
    
    抛出:
    
    WxErrorException - the wx error exception
  - getSubscribeMode
```
Integer getSubscribeMode()
                  throws WxErrorException
```
    获取关注「学校通知」的模式可通过此接口获取家长关注「学校通知」的模式：“可扫码填写资料加入”或“禁止扫码填写资料加入”
    请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_subscribe_mode?access_token=ACCESS_TOKEN
    
    返回:
    
    subscribe mode
    
    抛出:
    
    WxErrorException - the wx error exception
  - getExternalContact
```
WxCpExternalContact getExternalContact(@NonNull
                                       @NonNull String externalUserId)
                                throws WxErrorException
```
    获取外部联系人详情学校可通过此接口，根据外部联系人的userid（如何获取?），拉取外部联系人详情。
    请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid =EXTERNAL_USERID
    
    参数:
    
    externalUserId - 外部联系人的userid，注意不是学校成员的帐号
    
    返回:
    
    external contact
    
    抛出:
    
    WxErrorException - the wx error exception
  - getAllowScope
```
WxCpAllowScope getAllowScope(@NonNull
                             @NonNull Integer agentId)
                      throws WxErrorException
```
    获取可使用的家长范围获取可在微信「学校通知-学校应用」使用该应用的家长范围，以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。
    请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
    
    参数:
    
    agentId - the agent id
    
    返回:
    
    allow scope
    
    抛出:
    
    WxErrorException - the wx error exception
  - convertToOpenId
```
String convertToOpenId(@NonNull
                       @NonNull String externalUserId)
                throws WxErrorException
```
    外部联系人openid转换企业和服务商可通过此接口，将微信外部联系人的userid（如何获取?）转为微信openid，用于调用支付相关接口。暂不支持企业微信外部联系人（ExternalUserid为wo开头）的userid转openid。
    请求方式：POST（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/convert_to_openid?access_token=ACCESS_TOKEN
    
    参数:
    
    externalUserId - the external user id
    
    返回:
    
    string
    
    抛出:
    
    WxErrorException - the wx error exception
  - listDepartment
```
WxCpDepartmentList listDepartment(Integer id)
                           throws WxErrorException
```
    获取部门列表请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
    
    参数:
    
    id - the id
    
    返回:
    
    wx cp department list
    
    抛出:
    
    WxErrorException - the wx error exception
  - getSubscribeQrCode
```
WxCpSubscribeQrCode getSubscribeQrCode()
                                throws WxErrorException
```
    获取「学校通知」二维码学校可通过此接口获取「学校通知」二维码，家长可通过扫描此二维码关注「学校通知」并接收学校推送的消息。请求方式：GET（HTTPS）请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_subscribe_qr_code?access_token=ACCESS_TOKEN
    
    返回:
    
    subscribe qr code
    
    抛出:
    
    WxErrorException - the wx error exception
  - setUpgradeInfo
```
WxCpSetUpgradeInfo setUpgradeInfo(Long upgradeTime,
                                  Integer upgradeSwitch)
                           throws WxErrorException
```
    修改自动升年级的配置请求方式： POST（HTTPS）请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/set_upgrade_info?access_token=ACCESS_TOKEN
    
    参数:
    
    upgradeTime - the upgrade time
    
    upgradeSwitch - the upgrade switch
    
    返回:
    
    upgrade info
    
    抛出:
    
    WxErrorException - the wx error exception

接口 WxCpSchoolUserService

方法概要

方法详细资料

getUserInfo

getSchoolUserInfo

createStudent

batchCreateStudent

batchDeleteStudent

batchUpdateStudent

deleteStudent

updateStudent

createParent

batchCreateParent

batchDeleteParent

batchUpdateParent

getUser

getUserList

getUserListParent

updateParent

deleteParent

setArchSyncMode

createDepartment

updateDepartment

deleteDepartment

setSubscribeMode

getSubscribeMode

getExternalContact

getAllowScope

convertToOpenId

listDepartment

getSubscribeQrCode

setUpgradeInfo