# 机构
类实例化:
OrgApi api = new OrgApi(String apiUrl, String accesskeyId, String publicKey);
# 获取机构校区信息
# 接口名称 :
getOrgSchools
# 接口说明 :
获取机构校区信息
参数:
参数名 | 是否必填 | 参数类型 | 参数描述 |
---|---|---|---|
v | 是 | string | 接口版本号 |
请求示例:
api.getOrgSchools(parameter [, parameter1, parameter2...])
返回示例:
{
"data": [
{
"id": "@integer(60, 100)",
"name": "@string",
"eName": "@string"
}
],
"state": 0,
"msg": "@string"
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
data | array | 返回数据信息 |
id | integer | undefined |
name | string | undefined |
eName | string | undefined |
state | integer | 返回码 |
msg | string | 描述信息 |
# 获取校区学年学期信息
# 接口名称 :
getSchoolSemesters
# 接口说明 :
获取校区学年学期信息
参数:
参数名 | 是否必填 | 参数类型 | 参数描述 |
---|---|---|---|
schoolId | 是 | integer | 校区Id,必填 |
v | 是 | string | 接口版本号 |
请求示例:
api.getSchoolSemesters(parameter [, parameter1, parameter2...])
返回示例:
{
"data": [
{
"schoolSemesterId": "@integer(60, 100)",
"year": "@integer(60, 100)",
"semester": "@integer(60, 100)",
"name": "@string",
"eName": "@string",
"startDate": "@datetime",
"endDate": "@datetime"
}
],
"state": 0,
"msg": "@string"
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
data | array | 返回数据信息 |
schoolSemesterId | integer | 学期Id |
year | integer | 学年,返回值为“2011”时则表示2011-2012学年 |
semester | integer | 学期,1表示第一学期,2表示第二学期 |
name | string | 学期信息 |
eName | string | 学期英文信息 |
startDate | string | 开始日期 |
endDate | string | 结束日期 |
state | integer | 返回码 |
msg | string | 描述信息 |
# 获取校区学段年级信息
# 接口名称 :
getSchoolGradeCodes
# 接口说明 :
获取校区学段年级信息
参数:
参数名 | 是否必填 | 参数类型 | 参数描述 |
---|---|---|---|
schoolId | 是 | integer | 校区Id,必填 |
v | 是 | string | 接口版本号 |
请求示例:
api.getSchoolGradeCodes(parameter [, parameter1, parameter2...])
返回示例:
{
"data": [
{
"studySection": 1,
"gradeCodes": [
0
]
}
],
"state": 0,
"msg": "@string"
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
data | array | 返回数据信息 |
studySection | integer | 学段Id,4表示幼儿园、1表示小学、2表示初中、3表示高中、5表示大学 |
gradeCodes | array | 年级Id,30表示托班、31表示小班、32表示中班、33表示大班、1表示一年级、2表示二年级、3表示三年级、4表示四年级、5表示五年级、6表示六年级、7表示七年级、8表示八年级、9表示九年级、10表示十年级、11表示十一年级、12表示十二年级、51表示大一、52表示大二、53表示大三、54表示大四、55表示大五 |
state | integer | 返回码 |
msg | string | 描述信息 |