医院接入文档 - Powered by MinDoc

1、获取极速预约订单

请求URL
https://api.mytijian.com/open-api/V2/ws/order/immediateOrder?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 否
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken

POST参数示例

{
    "needHisExamineeNum":true //是否需要返回体检编号
}

正确返回示例:

{   "msg":"success",
    "success":"T"
    "data":[
        {
            "onlinePayMoney":0,
            "dynamicAttributes":{
                "birthDay":"1990-12-11",
                "gender":0,
                "hasInvoice":"0",
                "marriageStatus":"",
                "batchId":"4150660",
                "operatorName":"运维测试",
                "examPeriod":"7:00-8:00",
                "retireStatus":"",
                "healthLevel":"",
                "hospitalId":197,
                "position":"",
                "myMealId":447168,
                "age":28
            },
            "needPaperReport":true,
            "orderMoney":39,
            "examDate":1530547200000,
            "hisCompId":"000374",
            "orderId":4402379,
            "examItemExportDto":[
                {
                    "originalPrice":300,
                    "hisId":"000007",
                    "price":100,
                    "typeToMeal":1
                },
                {
                    "originalPrice":700,
                    "hisId":"000012",
                    "price":100,
                    "typeToMeal":1
                }
            ],
            "orderNum":"20180703141944364002053",
            "remark":"{"remarks":"","timeRemarks":""}",
            "examCompany":"个人改",
            "accountCompanyExportDto":{
                "owner":"运维测试2",
                "name":"个人改"
            },
            "examinerExportDto":{
                "addAccountType":"idCard",
                "idCard":"360681199012115715",
                "name":"黄伟",
                "department":"",
                "group":"分组1"
            },
            "deleteItemSnapList": [
                {
                    "originalPrice": 6800,
                    "payInfoSnapshotDtoList": [],
                    "hisId": "000022",
                    "typeToMeal": 0
                }
            ]
            "companyId":1585,
            "offlinePayMoney":39,
            "exportDiscount":"0.3",
            "payType":"现金",
            "retire":"",
            "hisCompName":"个人",
            "mealName":"基础套餐",
            "vip":"否",
            "operator": "qatest",
            "operatorId": 206499,
            "hisExamineeNum": "Csa-num" // Csa--->2022.3.4 增加，惠州三院内网体检号返回。
            "examItemPayInfoSnapshotDtoList":[
            {
            "examItemId":,
            "payInfoSnapshotDtoList":[
            {
            "payType":,
            "payAmount":,
            "payTypeName":
            }
            ]
            }
            ]//如果医院开了线上拆单的配置,   订单中每个项目就会有examItemPayInfoSnapshotDtoList 这个信息. 
        }
    ]
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述信息
data	List（OrderExportDto）	OrderExportDto对象集合

OrderExportDto返回参数说明:

参数名	类型	说明
orderId	int	订单id
orderNum	String	订单号
examDate	Date	体检日期
payType	String	支付类型
mealName	String	套餐名称
orderMoney	double	订单金额
vip	String	VIP
onlinePayMoney	double	线上支付金额
offlinePayMoney	double	线下支付金额
companyId	int	每天健康库单位id
examCompany	int	每天健康库单位名称
hisCompId	String	his系统单位编码
hisCompName	String	his系统单位名称
needPaperReport	boolean	是否需要纸质报告
exportDiscount	String	导出折扣
remark	String	备注信息
retire	String	在职状态
operator	String	下单人名称
operatorId	Integer	下单人id
hisExamineeNum	String	体检号
examinerExportDto	ExaminerExportDto	体检人信息
deleteItemSnapList	list	已删除的体检项目
accountCompanyExportDto	AccountCompanyExportDto	挂账单位信息
examItemExportDto	List(ExamItemExportDto)	添加项集合
dynamicAttributes	Map（String, Object）	动态属性
examItemPayInfoSnapshotDtoList	List	如果医院开了线上拆单的配置, 订单中每个项目就会有examItemPayInfoSnapshotDtoList 这个信息.
cardPayAmount	integer	卡支付金额
mealClassifyName	string	套餐体检类型

ExaminerExportDto对象说明:

参数名	类型	说明
name	String	体检人姓名
addAccountType	String	添加账户类型（idCard:按身份证导入,employeeNo:按员工号导入,passport:按护照添加,officeCert:按军官证添加,hmCard:按港澳身份证添加,other:其他方式导入）
idCard	String	体检人身份证号
mobile	String	体检人手机号码
department	String	体检人所属部门
healthNum	String	保健号
healthLevel	String	保健级别
employeeId	String	员工号
group	String	所在组
marriageStatus	int	婚姻状况(0:未婚，1：已婚)
address	String	体检人住址

AccountCompanyExportDto对象说明:

参数名	类型	说明
name	String	挂账单位
owner	String	介绍人

ExamItemExportDto对象说明:

参数名	类型	说明
hisId	String	医院项目ID
originalPrice	int	项目原价
price	int	项目折后价
typeToMeal	int	该项目针对套餐的关系 1：套餐内项目 2：套餐内删除项 3：新增项
multiChooseId	String	多选一组id 只有是多选一单项，才会有这个值
mergeItemParentId	int	合并项父id 只有是多选一单项，并且是合并项还有这个值
payInfoSnapshotDtoList	List	单项支付信息快照

dynamicAttributes动态属性说明:

参数名	类型	说明
myMealId	String	mytijian套餐id
examPeriod	String	体检时间端
batchId	String	订单批次
hasInvoice	String	是否需要发票
hospitalId	String	体检中心id
operatorName	String	预约人姓名
gender	String	性别
age	String	年龄
birthDay	String	出生日期
position	String	职级
retireStatus	String	退休状态
healthLevel	String	保健级别
marriageStatus	String	婚姻状态
adjustPrice	String	调整价格
idcardImage	String	身份证照片
address	String	体检人地址
managerLoginId	String	客户经理登陆ID
tradePayRecord	String	交易支付记录
tradeMethod	String	交易方式
outOrderId	String	三方交易单号
payAmount	String	支付金额
mealClassify	String	套餐分类
socialSecurity	String	社保号
cardHolderInfo	String	卡持有人信息前缀
customerRank	String	vip客户级别
nationality	String	民族信息
cardSupportMulti	String	是否是多次卡
cardBalance	String	卡余额
cardInitialAmount	String	卡初始金额
orderCreateTime	String	订单创建时间
busiType	String	单位业务类型
examCode	String
isMotherCard	String	该卡类型是否为母卡
postCode	String	邮编
addPackageNames	String	加项包名称集合
mealType	int	套餐类型：1 单位套餐，2 收藏套餐，3 官方套餐，4 推荐套餐，5 平台套餐
totalWorkingYear	int	总工龄-年
totalWorkingMonth	int	总工龄-月
touchYear	int	接毒接害工龄 -年
touchMonth	int	接毒接害工龄-月
hazardFactors	string	职业病危害因素-职检
examType	int	职检类别-职检 1 上岗 2 在岗 3 离岗
touchBeginTime	string	开始接触时间 eg : 2023-05-06
emailExamReport	boolean	是否邮寄报告 true : 邮寄，false不邮寄
hospitalAreaId	int	体检院区id，开通新版院区的体检中心有这个字段

PayInfoSnapshotDto & ExamItemPayInfoSnapshotDto 对象属性说明:

参数名	类型	说明
payType	Integer	支付类型
payAmount	long	支付金额
payTypeName	String	支付方式名称

ExamItemPayInfoSnapshotDto多一个examItemId—->平台单项id

2、获取正常导单订单

请求URL
https://api.mytijian.com/open-api/V2/ws/order/normalOrder?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 否
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken

POST参数示例

{"pageSize":20}

参数名	是否必须	类型	说明
pageSize	是	int	每次取数据数量

正确返回示例:

同极速预约

返回参数说明:

同极速预约

3、回写订单同步结果信息

请求URL
https://api.mytijian.com/open-api/V2/ws/order/orderSyncLog?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "orderSyncLogParams":[
        {
            "operator":"auto",
            "hospitalId":197,
            "orderNum":"20180703141944364002053",
            "errorCode":1,
            "errorText":"导入成功"
        }
    ]
}

参数名	是否必须	类型	说明
orderSyncLogParams	是	OrderSyncLogConllectionParam	订单同步集合参数

OrderSyncLogConllectionParam对象说明：

参数名	是否必须	类型	说明
orderSyncLogParams	是	List（OrderSyncLogParam）	订单同步结果集合

OrderSyncLogParam对象说明：

参数名	是否必须	类型	说明
id	否	Integer	主键
orderId	否	Integer	订单号
operator	是	String	操作员，默认使用 “auto”
createTime	否	Date	创建时间
updateTime	否	Date	更新时间
hospitalId	否	Integer	医院ID
orderNum	是	String	订单号
errorCode	是	Integer	结果码
errorText	是	String	结果说明

正确返回示例:

{
  "msg": "success",
  "success": "T"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

3、获取订单中删除的单项

请求URL
https://api.mytijian.com/open-api/V2/ws/order/exportDeleteItem?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 否
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken

POST参数示例

{"orderNum":"20xxxxxx"}

参数名	是否必须	类型	说明
orderNum	是	string	订单号

正确返回示例:

{   "msg":"success",
    "success":"T"
    "data":[
        {
        "hisItemId":"123",
        "name":"单项名称",
        "originPrice":1000
          },
           {
        "hisItemId":"124",
        "name":"单项名称",
        "originPrice":1000
          }
    ]
}

返回参数说明

参数名	是否必须	类型	说明
hisItemId	是	string	内网单项id
name	是	Integer	单项名称
originPrice	是	int	单项原价、单位分

4. 根据订单号集合获取可导订单

请求URL
https://api.mytijian.com/open-api/V2/ws/order/getOrderByOrderNums?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 否
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken

POST参数示例

{"orderNums":["20xxxxxx",'223232323']}

参数名	是否必须	类型	说明
orderNums	是	array	订单号集合

正确返回示例:

参考 获取极速预约订单返回值

文档更新时间: 2024-01-25 16:39

导单服务

1、获取极速预约订单

POST参数示例

返回参数说明:

OrderExportDto返回参数说明:

ExaminerExportDto对象说明:

AccountCompanyExportDto对象说明:

ExamItemExportDto对象说明:

dynamicAttributes动态属性说明:

PayInfoSnapshotDto & ExamItemPayInfoSnapshotDto 对象属性说明:

2、获取正常导单订单

POST参数示例

返回参数说明:

3、回写订单同步结果信息

POST参数示例

OrderSyncLogConllectionParam对象说明：

OrderSyncLogParam对象说明：

返回参数说明:

3、获取订单中删除的单项

POST参数示例

4. 根据订单号集合获取可导订单

POST参数示例