# 学生

类实例化：

StudentApi api = new StudentApi(String apiUrl, String accesskeyId, String publicKey);

# 获取学生详情

# 接口名称 :

getStudentDetail

# 接口说明 :

获取学生详情

参数：

参数名	是否必填	参数类型	参数描述
studentId	是	integer	学生Id，必填
v	是	string	接口版本号

请求示例：

api.getStudentDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "namePinYin": "@string",
    "sex": 0,
    "birthday": "@datetime",
    "country": "@string",
    "nation": "@string",
    "phone": "@string",
    "email": "@string",
    "remark": "@string"
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	学生中文名
eName	string	学生英文名
namePinYin	string	学生拼音
sex	integer	员工性别，0表示未知，1表示男，2表示女
birthday	string	出生日期
country	string	国籍名称
nation	string	民族名称
phone	string	手机号码
email	string	邮箱
remark	string	备注
state	integer	返回码
msg	string	描述信息

# 通过用户名获取学生详情

# 接口名称 :

getStudentDetailByLoginName

# 接口说明 :

通过用户名获取学生详情

参数：

参数名	是否必填	参数类型	参数描述
loginName	是	string	学生Id，必填
v	是	string	接口版本号

请求示例：

api.getStudentDetailByLoginName(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "namePinYin": "@string",
    "sex": 0,
    "birthday": "@datetime",
    "country": "@string",
    "nation": "@string",
    "phone": "@string",
    "email": "@string",
    "remark": "@string"
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	学生中文名
eName	string	学生英文名
namePinYin	string	学生拼音
sex	integer	员工性别，0表示未知，1表示男，2表示女
birthday	string	出生日期
country	string	国籍名称
nation	string	民族名称
phone	string	手机号码
email	string	邮箱
remark	string	备注
state	integer	返回码
msg	string	描述信息

# 创建学生

# 接口名称 :

createStudent

# 接口说明 :

创建学生

参数：

参数名	子级	二级	参数类型	是否必填	参数描述
student				否	--
	schoolId		integer	是	校区Id
	studySection		integer	是	学段 1 小学 2初中 3高中 4幼儿园 5 大学
	entranceYear		integer	否	入学年份
	stuNumber		string	否	学号
	graduateSchoolName		string	否	毕业学校
	cName		string	是	中文名
	cNameSpelling		string	否	拼音
	eName		string	否	英文名
	sex		integer	是	性别 1男 2女
	birthDay		string	否	出生日期
	birthPlace		string	否	出生地
	countryId		integer	否	国籍
	nationId		integer	否	民族
	credentialsType		integer	是	证件类别 1:身份证 2:港澳通行证 3:护照 4:港澳居民来往内地通行证 5:台湾居民来往大陆通行证
	credentialsNum		string	是	证件号码
	contactInformation		string	是	手机号码
	email		string	否	电子邮箱
	isGetAccommodation		boolean	是	是否住宿,默认：是
	remark		string	否	备注
	familyInfos			是	家长信息
		name	string	否	家长姓名
		stuFamilyType	integer	是	家长类型：1-爸爸，2-妈妈，3-爷爷，4-奶奶，5-外公，6-外婆，7-其他
		famPhone	string	是	家长手机号码
		famEmail	string	否	家长邮箱
		famWorkUnit	string	否	工作单位
		famJobPosition	string	否	家长职位
		famEduBackground	integer	否	家长学历(0未知 1小学,2初中,3高中,4专科,5本科,6硕士研究生,7博士研究生,8其他)
v			string	是	接口版本号

请求示例：

api.createStudent(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": "@integer(60, 100)",
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	integer	返回数据信息
state	integer	返回码
msg	string	描述信息

# 更新学生信息

# 接口名称 :

updateStudent

# 接口说明 :

更新学生信息

参数：

参数名	子级	二级	是否必填	参数类型	参数描述
loginName			是	string	(必填)登录名
schoolId			是	integer	(必填)校区id
studySection			是	integer	(必填)学段
updateStudentInfo			是		(必填)学生信息
	entranceYear		否	integer	入学年份
	stuNumber		否	string	学号
	graduateSchoolName		否	string	毕业学校
	cName		是	string	中文名
	cNameSpelling		否	string	拼音
	eName		否	string	英文名
	sex		是	integer	性别 1男 2女
	birthDay		否	string	出生日期
	birthPlace		否	string	出生地
	countryId		否	integer	国籍
	nationId		否	integer	民族
	credentialsType		是	integer	证件类别 1:身份证 2:港澳通行证 3:护照 4:港澳居民来往内地通行证 5:台湾居民来往大陆通行证
	credentialsNum		是	string	证件号码
	contactInformation		是	string	手机号
	email		否	string	电子邮箱
	isGetAccommodation		否	boolean	是否住宿,默认true住宿
	remark		否	string	备注
	familyInfos		否		家长信息
		name	否	string	家长姓名
		stuFamilyType	是	integer	家长类型：1-爸爸，2-妈妈，3-爷爷，4-奶奶，5-外公，6-外婆，7-其他
		famPhone	是	string	家长手机号码
		famEmail	否	string	家长电子邮件
		famWorkUnit	否	string	家长工作单位
		famJobPosition	否	string	家长职位
		famEduBackground	否	integer	家长学历(0未知 1小学,2初中,3高中,4专科,5本科,6硕士研究生,7博士研究生,8其他)
v			是	string	接口版本号

请求示例：

api.updateStudent(parameter [, parameter1, parameter2...])

返回示例：

{
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
state	integer	返回码
msg	string	描述信息

← 日程员工 →