# 基础数据

# 获取校区

# 接口名称 :

GetSchoolInfoList

# 接口说明 :

获取校区

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetSchoolInfoList (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"

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
schoolId	integer	└ 校区id
schoolName	string	└ 校区
schoolType	string	└ 校区类型
schoolAdd	string	└ 校区地址
tel1	string	└ 电话1
tel2	string	└ 电话2

请求正文：

请求示例（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.getSchoolInfoList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "schoolType": "@string",
      "schoolAdd": "@string",
      "tel1": "@string",
      "tel2": "@string"
    }
  ]
}

# 获取课程类别

# 接口名称 :

GetLessonClassList

# 接口说明 :

获取课程类别

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetLessonClassList (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"

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
lessonClassId	integer	└ 课程类别id
name	string	└ 课程类别名称
orderId	integer	└ 序号

请求正文：

请求示例（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.getLessonClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "lessonClassId": "@integer(60, 100)",
      "name": "@string",
      "orderId": "@integer(60, 100)"
    }
  ]
}

# 获取课程列表

# 接口名称 :

GetLessonList

# 接口说明 :

获取课程列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetLessonList (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"

请求参数：

参数名	是否必填	参数类型	参数描述
beginDate	是	datetime	└ 创建时间，查询开始时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00
endDate	是	datetime	└ 创建时间，查询结束时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00
schoolId	否	integer	└ 校区id，可选

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
lessonId	integer	└ 课程id
lessonName	string	└ 课程名称
lessonClassId	integer	└ 课程类别Id
lessonClassName	string	└ 课程类别名称
lessonMode	integer	└ 课程类型，1：班课，2：一对一
hidden	boolean	└ 课程状态，true：开售，false：停售
feeStandards	array	└ 课时包
feeStandardId	integer	└└ 收费标准编号
feeMode	integer	└└ 收费模式，1：按课时，2：按时间，3：按期
schoolId	integer	└└ 适用校区
schoolName	string	└└ 校区名称
price	number	└└ 价格
unit	number	└└ 收费单位，0：天，1：月，2：季，3：年
count	number	└└ 按期课时数量

请求正文：

{"beginDate":"@datetime","endDate":"@datetime","schoolId":"@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.getLessonList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "lessonId": "@integer(60, 100)",
      "lessonName": "@string",
      "lessonClassId": "@integer(60, 100)",
      "lessonClassName": "@string",
      "lessonMode": "@integer(60, 100)",
      "hidden": "@boolean",
      "feeStandards": [
        {
          "feeStandardId": "@integer(60, 100)",
          "feeMode": 1,
          "schoolId": "@integer(60, 100)",
          "schoolName": "@string",
          "price": "@integer(60, 100)",
          "unit": "@integer(60, 100)",
          "count": "@integer(60, 100)"
        }
      ]
    }
  ]
}

# 获取班级/一对一列表

# 接口名称 :

GetClassList

# 接口说明 :

获取班级/一对一列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetClassList (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条
schoolId	否	integer	└ 校区id，可选
lessonId	否	integer	└ 课程Id
beginDate	是	datetime	└ 创建日期，搜索开始时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00
endDate	是	datetime	└ 创建日期，搜索结束时间。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
classId	integer	└ 班级id
className	string	└ 班级名称
lessonName	string	└ 课程名称
lessonId	integer	└ 课程id
openDate	datetime	└ 开班时间。时间格式示例：2020-01-01T00:00:00
closeDate	datetime	└ 结班时间。时间格式示例：2020-01-01T00:00:00
status	integer	└ 班级状态，0：未开班，1：开班中，2：已结班
unitClassTimes	number	└ 每次课时消耗,学生扣除
teacherClasstime	number	└ 每次课时消耗,教师获得
teacherList	array	└ 教师列表
teacherId	integer	└└ 教师Id
teacherName	string	└└ 教师名称
maxStuCount	integer	└ 班级预招人数
stuCount	integer	└ 当前班级在读人数

请求正文：

{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","schoolId":"@integer(60, 100)","lessonId":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime"}

请求示例（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.getClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "classId": "@integer(60, 100)",
      "className": "@string",
      "lessonName": "@string",
      "lessonId": "@integer(60, 100)",
      "openDate": "@datetime",
      "closeDate": "@datetime",
      "status": "@integer(60, 100)",
      "unitClassTimes": "@integer(60, 100)",
      "teacherClasstime": "@integer(60, 100)",
      "teacherList": [
        {
          "teacherId": "@integer(60, 100)",
          "teacherName": "@string"
        }
      ],
      "maxStuCount": "@integer(60, 100)",
      "stuCount": "@integer(60, 100)"
    }
  ]
}

# 根据ID获取班级/一对一列表

# 接口名称 :

GetClassListByIds

# 接口说明 :

根据ID获取班级/一对一列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetClassListByIds (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"

请求参数：

参数名	是否必填	参数类型	参数描述
classIds	是	array	└ 班级ID数组

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
classId	integer	└ 班级id
className	string	└ 班级名称
lessonName	string	└ 课程名称
lessonId	integer	└ 课程id
openDate	datetime	└ 开班时间。时间格式示例：2020-01-01T00:00:00
closeDate	datetime	└ 结班时间。时间格式示例：2020-01-01T00:00:00
status	integer	└ 班级状态，0：未开班，1：开班中，2：已结班
unitClassTimes	number	└ 每次课时消耗,学生扣除
teacherClasstime	number	└ 每次课时消耗,教师获得
teacherList	array	└ 教师列表
teacherId	integer	└└ 教师Id
teacherName	string	└└ 教师名称
maxStuCount	integer	└ 班级预招人数
stuCount	integer	└ 当前班级在读人数

请求正文：

{"classIds":["@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.getClassListByIds(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "classId": "@integer(60, 100)",
      "className": "@string",
      "lessonName": "@string",
      "lessonId": "@integer(60, 100)",
      "openDate": "@datetime",
      "closeDate": "@datetime",
      "status": "@integer(60, 100)",
      "unitClassTimes": "@integer(60, 100)",
      "teacherClasstime": "@integer(60, 100)",
      "teacherList": [
        {
          "teacherId": "@integer(60, 100)",
          "teacherName": "@string"
        }
      ],
      "maxStuCount": "@integer(60, 100)",
      "stuCount": "@integer(60, 100)"
    }
  ]
}

# 获取员工列表

# 接口名称 :

GetHrDocList

# 接口说明 :

获取员工列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetHrDocList (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条
schoolId	否	integer	└ 校区id，必填
status	否	integer	└ 人事状态，0：未知，1：面试期，2：培训期，3：试用期，4：兼职员工，5：正式员工，6：转正失败，7：停薪留职，8：主动离职，9：被解聘

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
hrDocId	integer	└ 员工id
name	string	└ 姓名
sex	integer	└ 性别，0：未知，1：男，2：女
mobile	string	└ 手机号
isTeacher	boolean	└ 是否教师
hrStatus	integer	└ 人事状态
departmentList	array	└ 所在部门
departmentId	integer	└└ 部门Id
departmentName	string	└└ 部门名称
orgAccount	array	└ 机构账号

请求正文：

{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","schoolId":"@integer(60, 100)","status":0}

请求示例（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.getHrDocList(parameter [, parameter1, parameter2...])

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "hrDocId": "@integer(60, 100)",
      "name": "@string",
      "sex": 0,
      "mobile": "@string",
      "isTeacher": "@boolean",
      "hrStatus": 0,
      "departmentList": [
        {
          "departmentId": "@integer(60, 100)",
          "departmentName": "@string"
        }
      ],
      "orgAccount": [
        "@string"
      ]
    }
  ]
}

# 获取学员扩展属性

# 接口名称 :

GetStuInfoCustomExtendFields

# 接口说明 :

获取学员扩展属性

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuInfoCustomExtendFields (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"

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
column	string	└ 自定义字段Id
columnName	string	└ 字段名称
columnType	integer	└ 字段类型
required	boolean	└ 是否必填
extendAttributeItems	array	└ 下拉选项
id	integer	└└ 下拉选项序号
name	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);

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

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "column": "@string",
      "columnName": "@string",
      "columnType": 0,
      "required": "@boolean",
      "extendAttributeItems": [
        {
          "id": "@integer(60, 100)",
          "name": "@string"
        }
      ]
    }
  ]
}

# 获取咨询列表

# 接口名称 :

GetStuInfoList

# 接口说明 :

获取咨询列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuInfoList (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-01T00:00:00
endDate	是	datetime	└ 录入时间结束时间，时间跨度为30天（必填），时间格式示例：2020-01-01T00:00:00
schoolId	否	integer	└ 咨询校区ID（非必填）
stuName	否	string	└ 学员姓名（非必填）

返回参数：

参数名	类型	说明
code	integer	状态码
message	string	描述信息
data	array	返回数据信息
stuInfoId	integer	└ 学员ID
stuName	string	└ 学员姓名
sex	integer	└ 性别，0：未知，1：男，2：女
mainTel	string	└ 主要电话
minorTel	string	└ 次要电话
otherTel	string	└ 其他电话
mainTelRelationship	integer	└ 主要电话所属关系，1：母亲，5：父亲，9：自己，13：其他
minorTelRelationship	integer	└ 次要电话所属关系，1：母亲，5：父亲，9：自己，13：其他
otherTelRelationship	integer	└ 其他电话所属关系，1：母亲，5：父亲，9：自己，13：其他
interest	integer	└ 意向度，1：高，2：中，3：低，4：？
lessonClassId	integer	└ 第一意向课程类别Id
lessonClassName	string	└ 第一意向课程类别名称
secondLessonClassId	integer	└ 第二意向课程类别Id
secondLessonClassName	string	└ 第二意向课程类别名称
thirdLessonClassId	integer	└ 第三意向课程类别Id
thirdLessonClassName	string	└ 第三意向课程类别名称
schoolId	integer	└ 咨询校区
schoolName	string	└ 咨询校区
followUpState	integer	└ 跟进状态，1：待跟进，2：跟进中，3：已成交，4：已失效，5：已到访，6：已邀约，7：已试听；
classificationId	integer	└ 渠道分类Id
classificationName	string	└ 渠道分类
channelId	integer	└ 渠道Id
channelName	string	└ 渠道
remain	number	└ 余额
introduceStuInfoId	integer	└ 介绍人学员ID
introduceStuName	string	└ 介绍人学员姓名
addDate	datetime	└ 学员录入时间。时间格式示例：2020-01-01T00:00:00

请求正文：

{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime","schoolId":"@integer(60, 100)","stuName":"@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);

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

返回示例：

{
  "code": "@integer(60, 100)",
  "message": "@string",
  "data": [
    {
      "stuInfoId": "@integer(60, 100)",
      "stuName": "@string",
      "sex": 0,
      "mainTel": "@string",
      "minorTel": "@string",
      "otherTel": "@string",
      "mainTelRelationship": "@integer(60, 100)",
      "minorTelRelationship": "@integer(60, 100)",
      "otherTelRelationship": "@integer(60, 100)",
      "interest": 1,
      "lessonClassId": "@integer(60, 100)",
      "lessonClassName": "@string",
      "secondLessonClassId": "@integer(60, 100)",
      "secondLessonClassName": "@string",
      "thirdLessonClassId": "@integer(60, 100)",
      "thirdLessonClassName": "@string",
      "schoolId": "@integer(60, 100)",
      "schoolName": "@string",
      "followUpState": 1,
      "classificationId": "@integer(60, 100)",
      "classificationName": "@string",
      "channelId": "@integer(60, 100)",
      "channelName": "@string",
      "remain": "@integer(60, 100)",
      "introduceStuInfoId": "@integer(60, 100)",
      "introduceStuName": "@string",
      "addDate": "@datetime"
    }
  ]
}

← 获取Token 咨询信息 →