通讯录

---

获取校区

接口名称 :

GetSchool

接口说明 :

通过CorpId，获取校区信息

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/School/v2/GetSchool (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

返回参数：

参数名	类型	说明
data	object	返回数据信息
id	integer	└ 学校Id
cName	string	└ 学校中文名称
eName	string	└ 学校英文名称
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

SchoolApi api = new SchoolApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getSchool(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "id": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string"
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取学段年级列表

接口名称 :

GetSchoolGradeCodes

接口说明 :

通过CorpId，获取校区内的学段、年级信息

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/School/v2/GetSchoolGradeCodes (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

返回参数：

参数名	类型	说明
data	array	返回数据信息
studySection	integer	└ 学段Id，4表示幼儿园、1表示小学、2表示初中、3表示高中、5表示大学
gradeCodes	array	└ 年级Id，0表示新生班、30表示托班、31表示小班、32表示中班、33表示大班、1表示一年级、2表示二年级、3表示三年级、4表示四年级、5表示五年级、6表示六年级、7表示七年级、8表示八年级、9表示九年级、10表示十年级、11表示十一年级、12表示十二年级、51表示大一、52表示大二、53表示大三、54表示大四、55表示大五
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

SchoolApi api = new SchoolApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getSchoolGradeCodes(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "studySection": 1,
      "gradeCodes": [
        0
      ]
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取行政班列表

接口名称 :

GetAdministrativeClassList

接口说明 :

通过年级Id，获取对应年级下新生、在读的行政班列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Class/v2/GetAdministrativeClassList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
gradeCode	否	integer	年级Id，选填，如果不填，默认为全部年级
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
classId	integer	└└ 班级Id
cName	string	└└ 班级中文名
eName	string	└└ 班级英文名
gradeCode	integer	└└ 年级Id
studySection	integer	└└ 学段Id
schoolId	integer	└└ 学校Id
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

ClassApi api = new ClassApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getAdministrativeClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "classId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "gradeCode": 0,
        "studySection": 1,
        "schoolId": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取行政班详情

接口名称 :

GetAdministrativeClassDetail

接口说明 :

通过班级Id，获取行政班详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Class/v2/GetAdministrativeClassDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
classId	integer	└ 班级Id
cName	string	└ 班级中文名
eName	string	└ 班级英文名
classCode	string	└ 班级编号
gradeCode	integer	└ 年级Id，行政班的所属年级
entranceYear	integer	└ 班级入学年份
studySection	integer	└ 学段Id
schoolId	integer	└ 归属学校Id
classRoomId	integer	└ 教室场地Id
classTeacherId	array	└ 班主任Ids
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

ClassApi api = new ClassApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getAdministrativeClassDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "classId": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string",
    "classCode": "@string",
    "gradeCode": 0,
    "entranceYear": "@integer(60, 100)",
    "studySection": 1,
    "schoolId": "@integer(60, 100)",
    "classRoomId": "@integer(60, 100)",
    "classTeacherId": [
      "@integer(60, 100)"
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取选修班列表

接口名称 :

GetElectiveClassList

接口说明 :

通过年级Id，获取未结班的选修班列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Class/v2/GetElectiveClassList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
gradeCode	否	integer	年级Id，选填，如果不填，默认为全部年级
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
classId	integer	└└ 班级Id
cName	string	└└ 班级中文名
eName	string	└└ 班级英文名
isOpenEnroll	boolean	└└ 是否开放报名，true表示开放，false表示不开放
gradeCode	array	└└ 年级Ids
studySection	integer	└└ 学段Id
schoolId	integer	└└ 学校Id
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

ClassApi api = new ClassApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getElectiveClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "classId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "isOpenEnroll": "@boolean",
        "gradeCode": [
          0
        ],
        "studySection": 1,
        "schoolId": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取选修班详情

接口名称 :

GetElectiveClassDetail

接口说明 :

通过班级Id，获取选修班详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Class/v2/GetElectiveClassDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
classId	integer	└ 班级Id
cName	string	└ 班级中文名
eName	string	└ 班级英文名
classCode	string	└ 班级编号
gradeCode	array	└ 年级Ids，选修班的可用年级
studySection	integer	└ 学段Id
schoolId	integer	└ 归属学校Id
classRoomId	integer	└ 教室场地Id
classTeacherId	array	└ 指导老师Ids
isOpenEnroll	boolean	└ 是否开放报名，true表示开放，false表示不开放
genderLimit	integer	└ 性别限制，只有开放报名后才会出现限制男/女，1表示不限，2表示男，3表示女
availableNumber	integer	└ 计划人数
charge	number	└ 收费金额，为0时表示不收费
remark	string	└ 备注信息
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

ClassApi api = new ClassApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getElectiveClassDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "classId": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string",
    "classCode": "@string",
    "gradeCode": [
      0
    ],
    "studySection": 1,
    "schoolId": "@integer(60, 100)",
    "classRoomId": "@integer(60, 100)",
    "classTeacherId": [
      "@integer(60, 100)"
    ],
    "isOpenEnroll": "@boolean",
    "genderLimit": 1,
    "availableNumber": "@integer(60, 100)",
    "charge": "@integer(60, 100)",
    "remark": "@string"
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取班级学生列表

接口名称 :

GetClassStudentList

接口说明 :

通过班级Id，获取班级内当前在班的学生列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Student/v2/GetClassStudentList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
studentId	integer	└└ 学生Id
cName	string	└└ 学生中文名
eName	string	└└ 学生英文名
enterTime	datetime	└└ 加入时间。时间格式示例：2020-01-01 00:00:00
stuNumber	string	└└ 学生在读学籍的学号
schoolId	integer	└└ 学校Id
studySection	integer	└└ 学生在读学籍的学段Id
administrativeClassGradeCode	integer	└└ 学生所属行政班年级Id
administrativeClassId	integer	└└ 学生所属行政班Id
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

StudentApi api = new StudentApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getClassStudentList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "studentId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "enterTime": "@datetime",
        "stuNumber": "@string",
        "schoolId": "@integer(60, 100)",
        "studySection": 1,
        "administrativeClassGradeCode": 0,
        "administrativeClassId": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取学生详情

接口名称 :

GetStudentDetail

接口说明 :

通过学生Id，获取学生详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Student/v2/GetStudentDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
studentId	是	integer	学生Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
studentId	integer	└ 学生Id
cName	string	└ 学生中文名
eName	string	└ 学生英文名
namePinYin	string	└ 学生拼音
sex	integer	└ 学生性别，0表示未知，1表示男，2表示女
birthday	datetime	└ 出生日期。时间格式示例：2020-01-01 00:00:00
country	string	└ 国籍名称
nation	string	└ 民族名称
phone	string	└ 手机号码
email	string	└ 邮箱
stuNumber	string	└ 学生在读学籍的学号
schoolId	integer	└ 学校Id
studySection	integer	└ 学生在读学籍的学段Id
administrativeClassGradeCode	integer	└ 学生所属行政班年级Id
administrativeClassId	integer	└ 学生所属行政班Id
credentialsType	integer	└ 证件类型，1表示身份证，2表示港澳通行证，3表示护照，4表示港澳居民来往内地通行证，5表示台湾居民来往大陆通行证，7表示台湾居民居住证，8表示绿卡，6表示其他
credentialsNum	string	└ 证件号码
electiveClassIds	array	└ 学生所属选修班Ids，为null时表示没有所属选修班
isGetAccommodation	boolean	└ 是否住宿
accommodationType	integer	└ 住宿类型0走读，1住宿，2半走读
isRideSchoolBus	boolean	└ 是否乘坐校车
avatar	string	└ 头像
mealTypes	array	└ 用餐类型
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

StudentApi api = new StudentApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStudentDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "studentId": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string",
    "namePinYin": "@string",
    "sex": 0,
    "birthday": "@datetime",
    "country": "@string",
    "nation": "@string",
    "phone": "@string",
    "email": "@string",
    "stuNumber": "@string",
    "schoolId": "@integer(60, 100)",
    "studySection": 1,
    "administrativeClassGradeCode": 0,
    "administrativeClassId": "@integer(60, 100)",
    "credentialsType": 0,
    "credentialsNum": "@string",
    "electiveClassIds": [
      "@integer(60, 100)"
    ],
    "isGetAccommodation": "@boolean",
    "accommodationType": 0,
    "isRideSchoolBus": "@boolean",
    "avatar": "@string",
    "mealTypes": [
      "@string"
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取家长详情

接口名称 :

GetFamily

接口说明 :

通过学生Id，获取家长详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Student/v2/GetFamily (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
studentId	是	integer	学生Id，必填

返回参数：

参数名	类型	说明
data	array	返回数据信息
name	string	└ 姓名
relationship	integer	└ 家长类型(爸爸1,妈妈2,爷爷3,奶奶4,外公5,外婆6,哥哥8,姐姐9,叔叔10,阿姨11,其他7)
phone	string	└ 手机号码
email	string	└ Email
workUnit	string	└ 工作单位
positions	string	└ 职位
qualifications	integer	└ 家长学历(0未知 1小学,2初中,3高中,4专科,5本科,6硕士研究生,7博士研究生,8其他)
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

StudentApi api = new StudentApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getFamily(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "name": "@string",
      "relationship": 1,
      "phone": "@string",
      "email": "@string",
      "workUnit": "@string",
      "positions": "@string",
      "qualifications": 0
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取部门列表

接口名称 :

GetDepartments

接口说明 :

通过CorpId，获取校区所属机构内所有部门信息

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Department/v2/GetDepartments (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

返回参数：

参数名	类型	说明
data	array	返回数据信息
departmentId	integer	└ 部门Id
name	string	└ 部门名称
parentId	integer	└ 父部门Id，根部门时为0
schoolId	integer	└ 部门所属校区Id，所属机构时为0
departmentType	integer	└ 部门类型，1表示校区，2表示部门
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

DepartmentApi api = new DepartmentApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getDepartments(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "departmentId": "@integer(60, 100)",
      "name": "@string",
      "parentId": "@integer(60, 100)",
      "schoolId": "@integer(60, 100)",
      "departmentType": 1
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取部门员工列表

接口名称 :

GetDepartmentUserList

接口说明 :

通过部门Id，获取部门下所有员工列表，包括该部门的所有子部门员工

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/User/v2/GetDepartmentUserList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
departmentId	是	integer	部门Id，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
orgUserId	integer	└└ 员工Id
cName	string	└└ 员工中文名
eName	string	└└ 员工英文名
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

UserApi api = new UserApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getDepartmentUserList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "orgUserId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

---

获取员工详情

接口名称 :

GetUserDetail

接口说明 :

通过员工Id，获取在职员工详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/User/v2/GetUserDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名	是否必填	参数类型	参数描述
orgUserId	是	integer	员工Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
orgUserId	integer	└ 员工Id
cName	string	└ 员工中文名
eName	string	└ 员工英文名
sex	integer	└ 员工性别，0表示未知，1表示男，2表示女
phone	string	└ 手机号码
email	string	└ 邮箱
hireDate	datetime	└ 入职日期。时间格式示例：2020-01-01 00:00:00
departmentIds	array	└ 所属部门Ids
admin	boolean	└ 是否管理员
msgCN	string	中文异常信息
msgEN	string	英文异常信息
state	integer	返回码
msg	string	描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

UserApi api = new UserApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getUserDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "orgUserId": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string",
    "sex": 0,
    "phone": "@string",
    "email": "@string",
    "hireDate": "@datetime",
    "departmentIds": [
      "@integer(60, 100)"
    ],
    "admin": "@boolean"
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}