Skip to content

A
aidapidesign
Commit 6e42bc18 by lichaogang
Options

add partner call api, add student_search api

parent 30a23366
Showing with 401 additions and 14 deletions
idapidesign/v1/app/08_get_school_class_list.md
......@@ -15,7 +15,7 @@ API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {osName}/{osVersion}/{appVersion}/{deviceSN}/{activeAccount}
X-Sign {String} rsa(activeAccount+'_'+timestamp) 加密
X-Sign {String} rsa(timestamp) 加密
### Form Parameters
......
idapidesign/v1/app/10_get_student_list.md
......@@ -15,7 +15,7 @@ API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {osName}/{osVersion}/{appVersion}/{deviceSN}/{activeAccount}
X-Sign {String} rsa(activeAccount+'_'+timestamp) 加密
X-Sign {String} rsa(timestamp) 加密
### Form Parameters
......
idapidesign/v1/app/11_get_student_latest_visions.md
......@@ -16,7 +16,7 @@ API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {osName}/{osVersion}/{appVersion}/{deviceSN}/{activeAccount}
X-Sign {String} rsa(activeAccount+'_'+timestamp) 加密
X-Sign {String} rsa(timestamp) 加密
### Form Parameters
......
idapidesign/v1/app/12_get_student_visions.md
......@@ -16,7 +16,7 @@ API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {osName}/{osVersion}/{appVersion}/{deviceSN}/{activeAccount}
X-Sign {String} rsa(activeAccount+'_'+timestamp) 加密
X-Sign {String} rsa(timestamp) 加密
### Form Parameters
......
idapidesign/v1/app/14_get_terminal_qrcode.md
......@@ -28,18 +28,15 @@ API请求参数
**Command**
curl -X POST \
-H "X-DeviceInformation: 5ebfdbca1a5d4dbd4a6cc8e835276779" \
-H "X-Sign: xxxxxxxx"
http://localhost:8080/v1/get_terminal_qrcode
curl -X GET \
-H "X-DeviceInformation: 11%2f22%2f96" \
-H "X-Sign: gsvC5MP2ASj9JsX0uauVpriye6xz1G3GIwY9I9JEhQdvsdJs+LHi4+AcVE9JHEApFlAbiNv3FjahOMymWslI8fXcmkaUBCb/tFT8zHn/YFE6yIyOOVMojoYTPSEYkSGmJN2tekru0nHiO7z5wS8DDbP680wfuzQPFJUxJyeDGb4=" \
http://localhost:8080/v1/get_terminal_qrcode
**Output**
{
"errno": 200,
"data": {
"qrCodeUrl": "http://weixin.qq.com/q/02j2sR9QJ4f2h1aRvgNt1Q"
},
"msg": "success"
"code": "200",
"msg": "success",
"data": "http://weixin.qq.com/q/02payj9BJ4f2h1efGpNt1a"
}
\ No newline at end of file
idapidesign/v1/app/17_student_search.md 0 → 100644
# 获取学生信息
## 修改记录
## 接口定义
/v1/student_search
GET
## Request
API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {osVersion}/{appVersion}/{deviceSN}
X-Sign {String} rsa(timestamp) 加密
### Form Parameters
keyword {String} 关键字，学号或姓名
limit {int} 默认：20
## Response
### Example
**Command**
curl -X GET \
-H "X-DeviceInformation: 11%2f22%2f96" \
-H "X-Sign: gsvC5MP2ASj9JsX0uauVpriye6xz1G3GIwY9I9JEhQdvsdJs+LHi4+AcVE9JHEApFlAbiNv3FjahOMymWslI8fXcmkaUBCb/tFT8zHn/YFE6yIyOOVMojoYTPSEYkSGmJN2tekru0nHiO7z5wS8DDbP680wfuzQPFJUxJyeDGb4=" \
http://localhost:8080/v1/student_search?keyword=李
**Output**
{
"data": [
{
"studentId": 31741,
"studentName": "李仁杰",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 573,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31740,
"studentName": "李明洋",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 573,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31725,
"studentName": "李恩逾",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 573,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31724,
"studentName": "李家雨",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 573,
"leftEye": 5.2,
"rightEye": 5.2,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31712,
"studentName": "李崟峰",
"gender": 1,
"age": 16,
"schoolId": 93,
"gradeId": 60,
"classId": 573,
"leftEye": 5.2,
"rightEye": 5.2,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31670,
"studentName": "李若驰",
"gender": 1,
"age": 16,
"schoolId": 93,
"gradeId": 60,
"classId": 572,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31669,
"studentName": "李佳峻",
"gender": 1,
"age": 16,
"schoolId": 93,
"gradeId": 60,
"classId": 572,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31668,
"studentName": "李昊枰",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 572,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31667,
"studentName": "李国运",
"gender": 1,
"age": 17,
"schoolId": 93,
"gradeId": 60,
"classId": 572,
"leftEye": 5.1,
"rightEye": 5.2,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31651,
"studentName": "李忠培",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 571,
"leftEye": 5,
"rightEye": 5,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31636,
"studentName": "李凌峰",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 571,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31634,
"studentName": "李金涛",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 571,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31572,
"studentName": "李世芳",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 570,
"leftEye": 5.1,
"rightEye": 5,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31571,
"studentName": "李启远",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 570,
"leftEye": 5.3,
"rightEye": 5.3,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31570,
"studentName": "李光华",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 570,
"leftEye": 5.2,
"rightEye": 5.2,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
},
{
"studentId": 31569,
"studentName": "李博",
"gender": 1,
"age": 15,
"schoolId": 93,
"gradeId": 25,
"classId": 570,
"leftEye": 5.1,
"rightEye": 5.1,
"studentNumber": "",
"distance": 0,
"updatedAt": "2019-01-10 17:47:20"
}
],
"errno": 200,
"msg": "success"
}
\ No newline at end of file
idapidesign/v1/partner/01_upload_examination_data.md 0 → 100644
# 上传学生体检信息
## 接口定义
/partner/upload_examination_data
POST
## Request
API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {deviceId}
X-LoginType {String} partner
X-Sign {String} aes(appKey_时间戳) 加密，密码是 appSecret，时间戳有效期是2个小时
### JSON Parameters
dataId 唯一ID,UUID
studentId 学生ID
height 身高
weight 体重
addTime 测量时间
## Response
### Example
签名
appSecret = "test123456"
appKey = "9de1f320964a11e9ad5f32001713d000"
timestamp = 1561363166
sign = base64(aes("9de1f320964a11e9ad5f32001713d000_1561363166",test123456))
sign = "U4w3+V6aufbsYFHb5jJRwwpV2TbUftLYYJmPUilnv1P/p0RIJs1D86WJaTXPO5aq"
设备ID: 11222
**Command**
curl -X POST \
-H "X-LoginType: partner" \
-H "X-DeviceInformation: 1122" \
-H "X-Sign: U4w3+V6aufbsYFHb5jJRwwpV2TbUftLYYJmPUilnv1P/p0RIJs1D86WJaTXPO5aq" \
-d '[{"dataId":"d7006674-9658-11e9-ad5f-32001713d000","studentId":111, "height":170, "weight": 70, "addTime":1561363166},
{"dataId":"d7006674-9658-11e9-ad5f-32001713d001","studentId":222, "height":180, "weight": 80, "addTime":1561363166}
]'
http://localhost:8080/partner/upload_examination_data
**Output**
{
"errno": 200,
"msg": "success"
"data":[
"d7006674-9658-11e9-ad5f-32001713d000",
"d7006674-9658-11e9-ad5f-32001713d001",
]
}
\ No newline at end of file
idapidesign/v1/partner/02_get_student_list.md 0 → 100644
# 获取学生信息
## 修改记录
## 接口定义
/partner/get_student_list
GET
## Request
API请求参数
### Head
X-DeviceInformation {String} 设备信息, 格式为: {deviceId}
X-LoginType {String} partner
X-Sign {String} aes(appKey_时间戳) 加密，密码是 appSecret，时间戳有效期是2个小时
### Form Parameters
page {int} 默认：1
limit {int} 默认：20
## Response
### Example
**Command**
curl -X GET \
-H "X-DeviceInformation: 11222" \
-H "X-Sign: U4w3+V6aufbsYFHb5jJRwwpV2TbUftLYYJmPUilnv1P/p0RIJs1D86WJaTXPO5aq" \
http://localhost:8080/partner/get_student_list?limit=3&page=1
**Output**
{
"errno": 200,
"msg": "success",
"data": {
"total": 100,
"list":[
{
"studentId": 50687,
"studentName": "郑笑莹",
"gender": 2,
"age": 0,
"grade": "1年级",
"class": "2班",
"updatedAt": "2019-04-23 16:01:51"
}
]
}
}
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment