附录

附录1 OAuth2 API说明

            (1) 获取授权码:

接口功能 获取授权码
url https://server url/auth/oauth/authorize
参数 client_id :应用向平台预先申请的client_id 
scope :app向am请求的属性,可以根据具体情况增加或者减少,中间用空格分割(URL编码后是加号)。
redirect_uri :认证完成并且用户对app授权后返回的地址,此地址可以得到grant_code授权码。
response_type固定为code
返回值

grant_code :授权码。

获取方式,例如request.getParameter("code")

http请求方式GET

http请求方式

GET

(2) 获取token:

接口功能 获得token
url https://server url /auth/oAuth/token
参数 client_id :应用向平台预先申请的client_id
client_secret:应用密钥
grant_type: 授权模式“authorization_code”授权码模式
code:授权码
state:状态
redirect_uri :认证完成并且用户对app授权后返回的地址,此地址可以得到grant_code授权码。
返回值 token:授权令牌

http请求方式

POST

(3) 获取返回用户信息内容的服务:

接口功能 获取用户基本信息
url 服务上下文(context):/user/get_user_Info_phone

参数

请求实例

JSONObject userJsonObj = api.sendCommand("/user/get_user_Info_phone", "1.0", "get", null);

返回值

JSONObject 

结果范例:

{"result":{"uid":201,"nick_name":"系统管理员",

"user_type":8,"status":1,"user_id":"admin","avatar":"http://localhost:8082/DocCenterService/image?photo_id=473","ctime":1442988597}}

报错范例:

{"result":{"error":"XXX错误"}}

结果说明:

uid,用户id

nick_name,用户昵称

user_type,用户类型,8:教师,9:学生

status,用户状态,0:未激活,1:正常,2:锁定,3:删除

Avatar,用户头像

ctime,账号创建时间

http请求方式

GET

(4) 获取教师相关信息的服务;

接口功能 获取教师相关信息的服务
url /user/get_teacher_basicInfo
参数
请求示例

JSONObject basicStuDataJsonObj =

 api.sendCommand("/user/get_teacher_basicInfo","1.0","get",null);

返回值

类型:JSONObject 

结果范例:

{"result":{"xxjgid":"001","xxjgid_zh":"济东中学","rjkc":"语文","rjxd_zh":"普通高中","rjxd":"PG","xxssjyjdm":"370000000000"}}

结果说明:

学校id:xxjgid

学校名称:xxjgid_zh

学校所属教育局12位码:xxssjyjdm

任教课程:rjkc

任教学段代码:rjxd

任教学段:rjxd_zh

报错范例

{"result":{"error":"未查询到教师信息,请确认是否教师用户"}}

http请求方式

GET

(5) 获取学生相关信息的服务;

接口功能

获取学生相关信息的服务

url

/user/get_student_basicInfo

参数

请求示例

JSONObject basicStuDataJsonObj =

 api.sendCommand("/user/get_student_basicInfo","1.0","get",null);

返回值

类型:JSONObject 

结果范例:

{"result":{"xxnjxx_zh":"2016级","xxbjxxid":"20160103","xxjbxxid":"1","xxnjxxid":"1","xxbjxx_zh":"三班","xxjbxx_zh":XXXX小学","xxssjyjdm":"370000000000"}}

结果说明:

学校id:xxjbxxid

学校名称:xxjbxx_zh

学校所属教育局12位码:xxssjyjdm

年级信息id:xxnjxxid

年级名称:xxnjxx_zh

班级信息id:xxbjxxid

班级名称:xxbjxx_zh

报错范例

{"result":{"error":"未查询到学生,请确认是否学生"}}

http请求方式

GET