校宝智慧校园API

# 招生

# 获取线索列表

# 接口名称 :

GetClueList

# 接口说明 :

根据创建时间筛选范围内的线索

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Clue/v2/GetClueList (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"

请求参数：

参数名 是否必填 参数类型 参数描述
key 否 string 搜索关键字
beginTime 是 datetime 开始时间，必填，时间格式示例：2020-01-01 00:00:00
endTime 是 datetime 结束时间，必填，时间格式示例：2020-01-01 00:00:00
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
id integer └└ 线索Id
name string └└ 中文名
eName string └└ 英文名
sex integer └└ 性别（1男，2女，0未知）
phone string └└ 手机号码
email string └└ 邮箱
birthDay datetime └└ 生日。时间格式示例：2020-01-01 00:00:00
credentialsType integer └└ 1表示身份证，2表示港澳通行证，3表示护照，4表示港澳居民来往内地通行证，5表示台湾居民来往大陆通行证，7表示台湾居民居住证，8表示绿卡，9港澳居民居住证，10香港永久性居民身份证，11澳门居民身份证，12台湾身份证，13香港居民身份证，6表示其他
credentialsNum string └└ 证件号码
intentionalStudySection integer └└ 申请学段（1小学，2初中，3高中，4幼儿园，5大学）
intentionalGrade integer └└ 申请年级（1一年级..13十三年级，30托班，31小班，32中班，33大班，34学前班，51大一..55大五）
currentGrade integer └└ 现就读年级（1一年级..13十三年级，30托班，31小班，32中班，33大班，34学前班，51大一..55大五）
createTime datetime └└ 创建时间。时间格式示例：2020-01-01 00:00:00
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "id": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string",
        "sex": 0,
        "phone": "@string",
        "email": "@string",
        "birthDay": "@datetime",
        "credentialsType": 0,
        "credentialsNum": "@string",
        "intentionalStudySection": 1,
        "intentionalGrade": 0,
        "currentGrade": 0,
        "createTime": "@datetime"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取线索详情

# 接口名称 :

GetClueDetail

# 接口说明 :

根据线索id获取线索详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Clue/v2/GetClueDetail (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"

请求参数：

参数名 是否必填 参数类型 参数描述
clueId 是 integer 线索Id，必填

返回参数：

参数名 类型 说明
data object 返回数据信息
id integer └ 线索Id
name string └ 中文名
eName string └ 英文名
sex integer └ 性别（1男，2女，0未知）
phone string └ 手机号码
email string └ 邮箱
birthDay datetime └ 生日。时间格式示例：2020-01-01 00:00:00
credentialsType integer └ 1表示身份证，2表示港澳通行证，3表示护照，4表示港澳居民来往内地通行证，5表示台湾居民来往大陆通行证，7表示台湾居民居住证，8表示绿卡，9港澳居民居住证，10香港永久性居民身份证，11澳门居民身份证，12台湾身份证，13香港居民身份证，6表示其他
credentialsNum string └ 证件号码
credentialsFamilyName string └ 证件姓
credentialsName string └ 证件名
intentionalStudySection integer └ 申请学段（1小学，2初中，3高中，4幼儿园，5大学）
intentionalGrade integer └ 申请年级（1一年级..13十三年级，30托班，31小班，32中班，33大班，34学前班，51大一..55大五）
currentGrade integer └ 现就读年级（1一年级..13十三年级，30托班，31小班，32中班，33大班，34学前班，51大一..55大五）
currentSchoolName string └ 现就读学校
graduationYear integer └ 毕业年份
registrationNumber string └ 报名序号
isAdmit boolean └ 是否录取
admitTime datetime └ 录取时间。时间格式示例：2020-01-01 00:00:00
isRegister boolean └ 是否注册
registerTime datetime └ 注册时间。时间格式示例：2020-01-01 00:00:00
studentId integer └ 学员Id，注册后生成学生id
createTime datetime └ 创建时间。时间格式示例：2020-01-01 00:00:00
familyInfos array └ 家长信息
name string └└ 姓名
phone string └└ 联系方式
email string └└ 邮箱
workUnit string └└ 工作单位
jobPosition string └└ 职位
isPrimaryContact boolean └└ 是否主联系人
familyType integer └└ 家长类型(爸爸1,妈妈2,爷爷3,奶奶4,外公5,外婆6,哥哥8,姐姐9,叔叔10,阿姨11,其他7)
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);

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

返回示例：

{
  "data": {
    "id": "@integer(60, 100)",
    "name": "@string",
    "eName": "@string",
    "sex": 0,
    "phone": "@string",
    "email": "@string",
    "birthDay": "@datetime",
    "credentialsType": 0,
    "credentialsNum": "@string",
    "credentialsFamilyName": "@string",
    "credentialsName": "@string",
    "intentionalStudySection": 1,
    "intentionalGrade": 0,
    "currentGrade": 0,
    "currentSchoolName": "@string",
    "graduationYear": "@integer(60, 100)",
    "registrationNumber": "@string",
    "isAdmit": "@boolean",
    "admitTime": "@datetime",
    "isRegister": "@boolean",
    "registerTime": "@datetime",
    "studentId": "@integer(60, 100)",
    "createTime": "@datetime",
    "familyInfos": [
      {
        "name": "@string",
        "phone": "@string",
        "email": "@string",
        "workUnit": "@string",
        "jobPosition": "@string",
        "isPrimaryContact": "@boolean",
        "familyType": 1
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

← 通用 →