接口描述
本接口用于新建会话和删除会话。每位患者一次问诊需要创建一次会话,会话UUID
和患者信息以及问诊信息一一对应。患者问诊结束以后可以删除会话。
概念介绍
session_uuid
会话uuid
,必须和患者以及门诊一一对应。expires_in
会话有效时间,默认24小时,单位:秒。目前session_uuid
的有效期通过返回的expire_in
来传达,如果用户没有在这个有效时间内结束会话,系统会自动清除会话。
创建会话
接口调用请求说明
请求地址:
https://openapi.macrocura.com/diagnosis/sessions/
请求方法:
POST
API
版本要求
- 详见版本发布
请求示例
POST https://openapi.macrocura.com/diagnosis/sessions/
请求参数
无
响应示例
{
"code": 2000,
"description": "success",
"session_uuid": "SESSION_UUID",
"expires_in": 86400
}
公共响应参数
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code | Number | 请求处理的状态码 | 2000 |
description | String | 请求处理的状态描述 | "success" |
results | Object | 请求处理的返回值,具体内容参照各章节"返回数据说明" | {} 或 [] |
返回数据说明
名称 | 类型 | 描述 |
---|---|---|
session_uuid | String | 会话的uuid |
expires_in | Number | 会话有效时间 |
删除会话
接口调用请求说明
请求地址:
https://openapi.macrocura.com/diagnosis/sessions/<SESSION_UUID>/
请求方法:
DELETE
API
版本要求
- 详见版本发布
请求示例
DELETE https://openapi.macrocura.com/diagnosis/sessions/<SESSION_UUID>/
响应示例
{
"code": 2000,
"description": "success",
"results": {}
}
公共响应参数
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code | Number | 请求处理的状态码 | 2000 |
description | String | 请求处理的状态描述 | "success" |
results | Object | 请求处理的返回值,具体内容参照各章节"返回数据说明" | {} 或 [] |