检测报告检索
获取 H5 应用指定的用户检测报告数据。
请求
请求地址
https://www.ai-tongue.com/backend/check/i/report/query
请求方法
POST
请求头
Authorization: bearer {access_token}access_token 替换为 获取企业应用 access_token 获取到的授权令牌
请求体
请求体格式为 JSON
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
apiVersion |
number |
是 | 接口版本号。固定值：20240815 |
thirdId |
string |
否 | 第三方用户唯一标识 |
start |
string |
否 | 检测报告开始时间 |
end |
string |
否 | 检测报告结束时间 |
nextPageKey |
string |
否 | 查询页的起始位置，若为空则默认为首页 |
注：
nextPageKey 使用说明：
- 当前接口支持分页功能，即每次最多响应50条记录。
- 客户第一次请求分页数据时，将
nextPageKey设置为空。 - 客户判断响应内容
hasMore为真时，需要将响应的nextPageKey做为下一个请求的入参来获取下一页数据，直到hasMore为假。
时间支持一些常用格式，包括：
yyyy-MM-dd HH:mm:ssyyyy/MM/dd HH:mm:ssyyyy.MM.dd HH:mm:ssyyyy年MM月dd日 HH时mm分ss秒yyyy-MM-ddyyyy/MM/ddyyyy.MM.ddyyyy-MM-dd HH:mmyyyy-MM-dd HH:mm:ss.SSSyyyyMMddHHmmssyyyyMMddHHmmssSSSyyyyMMdd
请求示例
Java OkHttp
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
String content = "{\"apiVersion\":20240815,\"start\":\"2022-01-04 17:00:00\",\"end\":\"2025-01-05 17:00:00\",\"thirdId\":\"19988887777\",\"nextPageKey\":\"Gd4OWRTRBXqHmvprWpcjDg==\"}";
RequestBody body = RequestBody.create(mediaType, content);
Request request = new Request.Builder()
.url("https://www.ai-tongue.com/backend/check/i/report/query")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTQyNzc2NjYsInVzZXJfbmFtZSI6ImNsb3VkYXBwIiwianRpIjoiYjBhOTJmODctN2Y3ZS00MzAwLWJmNjAtYjI5MWMzYzc4ZTkxIiwiY2xpZW50X2lkIjoiY2xvdWRhcHAiLCJzY29wZSI6WyIqIl19.ErrQnNxPszq8r_3jGU63cI_GRLJvAQmB8LxgMmlLn1Y")
.build();
Response response = client.newCall(request).execute();
响应
响应体
响应体格式为 JSON
| 参数 | 类型 | 描述 |
|---|---|---|
code |
number |
0 为成功，其他为失败，参考 错误码 - H5 应用检测报告检索 API |
msg |
string |
响应结果描述 |
data |
array |
详见报告检索结果 |
报告检索结果
| 参数 | 类型 | 描述 |
|---|---|---|
hasMore |
boolean |
是否有下一页 |
nextPageKey |
string |
下一页的起始位置，若没有下一页则为空 |
rows |
array |
详见报告结果明细 |
报告结果明细
| 参数 | 类型 | 描述 |
|---|---|---|
name |
string |
检测人名称 |
phone |
string |
检测人手机号 |
email |
string |
检测人邮箱 |
sex |
number |
检测人性别（1男，2女） |
age |
number |
检测人年龄 |
time |
string |
检测时间 |
pdf |
string |
检测 PDF 报告 URL |
healthIndex |
number |
健康指数，其值越大表示健康状态越好 |
constitutionNames |
string |
体质 |
symptomName |
string |
证型，进一步判断体质（constitutionNames）的结果，更为准确体现用户的真实体质 |
thirdId |
string |
第三方用户唯一标识 |
响应示例
{
"code": 0,
"msg": "成功",
"data": {
"hasMore": true,
"nextPageKey": "Gd4OWRTRBXqHnvprWxcjDg==",
"rows": [
{
"name": "张三",
"phone": "13344445555",
"email": null,
"sex": 1,
"age": 42,
"time": "2023-03-08 08:23:13",
"pdf": "https://labelsys-images.oss-cn-hangzhou.aliyuncs.com/tongueFile/check/2023/03/87d76220-085e-4d2e-9fd7-9f5a01da1940.pdf",
"healthIndex": 100.0,
"constitutionNames": "气虚",
"symptomName": "胃气虚证",
"thirdId": "13344445555"
},
{
"name": "李四",
"phone": "19988887777",
"email": null,
"sex": 2,
"age": 29,
"time": "2023-03-08 08:15:44",
"pdf": "https://labelsys-images.oss-cn-hangzhou.aliyuncs.com/tongueFile/check/2023/03/0653430b-079d-4cf2-8c04-b085bc24b6c3.pdf",
"healthIndex": null,
"constitutionNames": "气虚",
"symptomName": "",
"thirdId": "19988887777"
}
]
}
}