# 学员信息
# 获取学员花名册列表
# 接口名称 :
GetEnrolledStuinfoListBySearch
# 接口说明 :
获取学员花名册列表
请求地址：
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| stuName | 否 | string | └ 学员姓名 |
| telphone | 否 | string | └ 手机号码 |
| stuInfoIds | 否 | array | └ 学员ID |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| stuInfoId | integer | └ 学员ID |
| stuName | string | └ 学员姓名 |
| sex | integer | └ 性别，0：未知，1：男，2：女 |
| mainTelRelationship | integer | └ 主要电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| mainTel | string | └ 主要电话 |
| enrollInfoStatus | integer | └ 学员报读状态，1：在读，2：停课，3：结课 |
| sphHome | boolean | └ 是否关注校宝家 |
| arrearage | number | └ 欠款 |
| remain | number | └ 余额 |
| birthDate | datetime | └ 生日。时间格式示例：2020-01-01T00:00:00 |
| pubSchoolName | string | └ 公立校 |
| channelName | string | └ 渠道名称 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","stuName":"@string","telphone":"@string","stuInfoIds":["@integer(60, 100)"]}
请求示例（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);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getEnrolledStuinfoListBySearch(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"stuInfoId": "@integer(60, 100)",
"stuName": "@string",
"sex": 0,
"mainTelRelationship": "@integer(60, 100)",
"mainTel": "@string",
"enrollInfoStatus": 1,
"sphHome": "@boolean",
"arrearage": "@integer(60, 100)",
"remain": "@integer(60, 100)",
"birthDate": "@datetime",
"pubSchoolName": "@string",
"channelName": "@string"
}
]
}
# 获取学员报读列表
# 接口名称 :
GetStuDocList
# 接口说明 :
获取学员报读列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuDocList (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| beginDate | 否 | datetime | └ 报名日期，开始时间，（必填） 。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| endDate | 否 | datetime | └ 报名日期，结束时间，时间跨度为30天（必填）。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| schoolId | 否 | integer | └ 报读校区ID（非必填） |
| status | 否 | integer | └ 学员状态 |
| lessonId | 否 | integer | └ 报读课程 |
| stuinfoIds | 否 | array | └ 学员id |
| lessThanTimes | 否 | integer | └ 小于等于课时数/天数 |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| id | integer | └ id |
| stuId | integer | └ 学员Id |
| stuName | string | └ 学员姓名 |
| lessonId | integer | └ 报读课程Id |
| lessonName | string | └ 报读课程名称 |
| mainTel | string | └ 主要电话 |
| minorTel | string | └ 次要电话 |
| otherTel | string | └ 其他电话 |
| mainTelRelationship | integer | └ 主要电话所属关系 |
| minorTelRelationship | integer | └ 次要电话所属关系 |
| otherTelRelationship | integer | └ 其他电话所属关系 |
| mode | integer | └ 模式 班课/一对一，1：班课，2：一对一 |
| allClassTimes | number | └ 购买课时 |
| usedClassTimes | number | └ 已用课时 |
| unusedClassTimes | number | └ 未用课时 |
| allTime | integer | └ 购买时间（单位天） |
| unusedTime | integer | └ 未用时间（单位天） |
| totalTuition | number | └ 总学费 |
| totalActualIncome | number | └ 实缴学费 |
| usedTuition | number | └ 已用学费 |
| tuition | number | └ 剩余学费 |
| arrearage | number | └ 欠费金额 |
| schoolName | string | └ 报读校区 |
| status | integer | └ 报读状态，-1：无，1：在读，2：转出，3：退费，4：停课，5：结课，6：复课，7：停课 |
| feeMode | integer | └ 收费模式，1：按课时，2：按时间，3：按期 |
| enrollAt | datetime | └ 报名日期。时间格式示例：2020-01-01T00:00:00 |
| expiryDate | datetime | └ 有效期至。时间格式示例：2020-01-01T00:00:00 |
| recentClassDate | datetime | └ 最近上课日期 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 | ||
| recentSuspendClassDate | datetime | └ 最近停课时间 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 | ||
| recentEndClassDate | datetime | └ 最近结课时间 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime","schoolId":"@integer(60, 100)","status":1,"lessonId":"@integer(60, 100)","stuinfoIds":["@integer(60, 100)"],"lessThanTimes":"@integer(60, 100)"}
请求示例（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);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStuDocList(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"id": "@integer(60, 100)",
"stuId": "@integer(60, 100)",
"stuName": "@string",
"lessonId": "@integer(60, 100)",
"lessonName": "@string",
"mainTel": "@string",
"minorTel": "@string",
"otherTel": "@string",
"mainTelRelationship": "@integer(60, 100)",
"minorTelRelationship": "@integer(60, 100)",
"otherTelRelationship": "@integer(60, 100)",
"mode": 1,
"allClassTimes": "@integer(60, 100)",
"usedClassTimes": "@integer(60, 100)",
"unusedClassTimes": "@integer(60, 100)",
"allTime": "@integer(60, 100)",
"unusedTime": "@integer(60, 100)",
"totalTuition": "@integer(60, 100)",
"totalActualIncome": "@integer(60, 100)",
"usedTuition": "@integer(60, 100)",
"tuition": "@integer(60, 100)",
"arrearage": "@integer(60, 100)",
"schoolName": "@string",
"status": 1,
"feeMode": 1,
"enrollAt": "@datetime",
"expiryDate": "@datetime",
"recentClassDate": "@datetime",
"recentSuspendClassDate": "@datetime",
"recentEndClassDate": "@datetime"
}
]
}
# 根据学员ID获取学员报读列表
# 接口名称 :
GetStuDocListByIds
# 接口说明 :
根据学员ID获取学员报读列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuDocListByIds (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| stuinfoIds | 是 | array | └ 学员id |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| id | integer | └ id |
| stuId | integer | └ 学员Id |
| stuName | string | └ 学员姓名 |
| lessonId | integer | └ 报读课程Id |
| lessonName | string | └ 报读课程名称 |
| mainTel | string | └ 主要电话 |
| minorTel | string | └ 次要电话 |
| otherTel | string | └ 其他电话 |
| mainTelRelationship | integer | └ 主要电话所属关系 |
| minorTelRelationship | integer | └ 次要电话所属关系 |
| otherTelRelationship | integer | └ 其他电话所属关系 |
| mode | integer | └ 模式 班课/一对一，1：班课，2：一对一 |
| allClassTimes | number | └ 购买课时 |
| usedClassTimes | number | └ 已用课时 |
| unusedClassTimes | number | └ 未用课时 |
| allTime | integer | └ 购买时间（单位天） |
| unusedTime | integer | └ 未用时间（单位天） |
| totalTuition | number | └ 总学费 |
| totalActualIncome | number | └ 实缴学费 |
| usedTuition | number | └ 已用学费 |
| tuition | number | └ 剩余学费 |
| arrearage | number | └ 欠费金额 |
| schoolName | string | └ 报读校区 |
| status | integer | └ 报读状态，-1：无，1：在读，2：转出，3：退费，4：停课，5：结课，6：复课，7：停课 |
| feeMode | integer | └ 收费模式，1：按课时，2：按时间，3：按期 |
| enrollAt | datetime | └ 报名日期。时间格式示例：2020-01-01T00:00:00 |
| expiryDate | datetime | └ 有效期至。时间格式示例：2020-01-01T00:00:00 |
| recentClassDate | datetime | └ 最近上课日期 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 | ||
| recentSuspendClassDate | datetime | └ 最近停课时间 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 | ||
| recentEndClassDate | datetime | └ 最近结课时间 |
| 时间格式示例：2020-01-01T00:00:00。时间格式示例：2020-01-01T00:00:00 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","stuinfoIds":["@integer(60, 100)"]}
请求示例（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);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStuDocListByIds(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"id": "@integer(60, 100)",
"stuId": "@integer(60, 100)",
"stuName": "@string",
"lessonId": "@integer(60, 100)",
"lessonName": "@string",
"mainTel": "@string",
"minorTel": "@string",
"otherTel": "@string",
"mainTelRelationship": "@integer(60, 100)",
"minorTelRelationship": "@integer(60, 100)",
"otherTelRelationship": "@integer(60, 100)",
"mode": 1,
"allClassTimes": "@integer(60, 100)",
"usedClassTimes": "@integer(60, 100)",
"unusedClassTimes": "@integer(60, 100)",
"allTime": "@integer(60, 100)",
"unusedTime": "@integer(60, 100)",
"totalTuition": "@integer(60, 100)",
"totalActualIncome": "@integer(60, 100)",
"usedTuition": "@integer(60, 100)",
"tuition": "@integer(60, 100)",
"arrearage": "@integer(60, 100)",
"schoolName": "@string",
"status": 1,
"feeMode": 1,
"enrollAt": "@datetime",
"expiryDate": "@datetime",
"recentClassDate": "@datetime",
"recentSuspendClassDate": "@datetime",
"recentEndClassDate": "@datetime"
}
]
}
# 获取学员分班列表
# 接口名称 :
GetStuDocClassList
# 接口说明 :
获取学员分班列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuDocClassList (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| stuInfoIds | 否 | array | └ 学员ID |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| stuDocId | integer | └ 学员分班档案ID |
| classId | integer | └ 班级ID |
| className | string | └ 班级名称 |
| stuInfoId | integer | └ 学员ID |
| stuName | string | └ 学员姓名 |
| lessonId | integer | └ 课程ID |
| lessonName | string | └ 课程名称 |
| classRoomId | integer | └ 教室ID |
| classRoom | string | └ 教室 |
| isUped | boolean | └ 是否升期 |
| stuFeeDocId | integer | └ 学员报读学费账户ID |
| schoolId | integer | └ 校区ID |
| schoolName | string | └ 校区名称 |
| addDate | datetime | └ 分班日期。时间格式示例：2020-01-01T00:00:00 |
| status | string | └ 分班状态名称 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","stuInfoIds":["@integer(60, 100)"]}
请求示例（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);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStuDocClassList(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"stuDocId": "@integer(60, 100)",
"classId": "@integer(60, 100)",
"className": "@string",
"stuInfoId": "@integer(60, 100)",
"stuName": "@string",
"lessonId": "@integer(60, 100)",
"lessonName": "@string",
"classRoomId": "@integer(60, 100)",
"classRoom": "@string",
"isUped": "@boolean",
"stuFeeDocId": "@integer(60, 100)",
"schoolId": "@integer(60, 100)",
"schoolName": "@string",
"addDate": "@datetime",
"status": "@string"
}
]
}