订单下单接口

使用开放平台进行单个下单操作,该接口调用成功即预约成功

请求URL:

https://m-api.lejian.com/open-api/V2/order/book?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN

请求协议:HTTPS
请求方式:POST
需要签名: 是
URL参数:
参数名 是否必须 类型 说明
accessToken string 当前有效的accessToken
nonce string 当前有效的nonce
sign string 数据sign值

关于nonce和sign请查看 数据签名

POST参数示例
  1. {
  2. "examDate":"2017-09-18",
  3. "examTimeIntervalId":1020,
  4. "mealId":"12878",
  5. "mobile":"18668182661",
  6. "examAccountName":"测试A",
  7. "idType":1,
  8. "idCard":"220102199003077434",
  9. "married":1,
  10. "gender":0,
  11. "age":30,
  12. "nationality":"汉族",
  13. "orderPrice":17500,
  14. "department":"部门",
  15. "companyId":442134
  16. }
参数名 是否必须 类型 说明
examDate string 体检日期(格式:yyyy-mm-dd)
examTimeIntervalId int 体检时段,取返回值period,参考套餐可约时间查询
mealId int 套餐id
mobile string 体检人手机号码
idCard string 体检人证件号
examAccountName string 体检人姓名
married int 婚否,0:未婚,1:已婚 注:女性套餐的部分项目只有已婚女性才能做
gender int 性别 0:男 1:女
age int 年龄
nationality string 民族 例:汉族,苗族
companyId int 单位, 默认为空,特殊逻辑情况下,每天健康这边会提供
department string 部门
orderPrice int 订单价格
itemIds array(Integer) 加项的体检项目id集合
idType int 证件类型 默认身份证 1:身份证 2:护照 3:军官证 4:港澳身份证 注意:检查机构是否支持2,3,4请查看体检中心查询接口的返回值supportMultipleCertificate

返回示例:

正确时返回:

  1. {
  2. "success":"T",
  3. "data":{
  4. "examDate":"2017-09-18 12:00:00",
  5. "hospitalId":23,
  6. "hospitalName":"浙江省中医院下沙院区体检中心",
  7. "items": [
  8. {
  9. "name":"血压",
  10. "price":0
  11. }
  12. ],
  13. "mealName":"普通入职体检(男)"
  14. "orderNum":"20170822194904339001236",
  15. "orderPrice":17500,
  16. "orderStatus":"unpay"
  17. },
  18. "msg":"success"
  19. }

返回参数说明:

参数名 类型 说明
hospitalName String 体检中心名称
hospitalId int 体检中心id
mealName string 套餐名称
orderPrice int 订单价格
orderNum string 订单号
examDate string 体检日期
status int 订单状态
items JSONObject 订单单项

订单状态对照表

状态 说明
unpay 未付款
success 预约成功
unexamined 用户预约成功后未去体检中心体检
cancel 订单取消
examined 用户体检完成,但是有退款产生
finish 用户体检完成

主要异常场景:
1、下单失败,原因:{0}
注意:此处失败的原因常见为:人数不足、性别不符、婚否不符等

  1. {
  2. "success":"F",
  3. "errCode":"201006",
  4. "msg":"Order book fail,reason:{0}" //0为具体异常信息
  5. }

2、入参必传字段为空

  1. {
  2. "success":"F",
  3. "errCode":"201003",
  4. "msg":"Book fields is null: {0}" //0为具体异常信息
  5. }

3、渠道账户余额不足,需要充值

  1. {
  2. "success":"F",
  3. "errCode":"201012",
  4. "msg":"balance not enough"
  5. }

备注:

文档更新时间: 2022-09-28 10:20