文档中心 > API类目 > 阿里健康-本地医疗-通用预约服务

qimen.alibaba.alihealth.medical.reservation.cancel (取消预约)

取消预约

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
isvReservationRecordId String 必须 10000123 isv预约记录id
alihealthReservationRecordId String 可选 2000111111 健康预约记录id
cancellationReasonDetail String 可选 CUSTOMER_CANCEL_RESERVATION 取消原因明细
causedByModification Boolean 可选 true 是否是修改预约触发的取消,服务商可以根据这个字段判断后续的流程是确认/拒绝取消还是确认/拒绝修改
modificationInfo ModificationInfo 可选 修改信息
  • └ scheduledTime
  • String
  • 可选
  • 2012-11-08 18:10:48
  • 修改后的预约开始时间
  • └ scheduledFinishTime
  • String
  • 可选
  • 2024-04-16 01:45:05
  • 修改后的预约结束时间
  • consumerAddress
  • ConsumerAddress
  • 可选
  • 修改后的预约服务地址,加密处理,解密方式同预约接口
  • └ districtCode
  • String
  • 可选
  • 330106
  • 区域码
  • └ address
  • String
  • 可选
  • 阿里巴巴
  • 地址
  • └ cityName
  • String
  • 可选
  • 杭州市
  • 城市名
  • └ districtName
  • String
  • 可选
  • 西湖区
  • 区域名
  • └ countryCode
  • String
  • 可选
  • 100000
  • 国家码
  • └ provinceCode
  • String
  • 可选
  • 330000
  • 省份码
  • └ cityCode
  • String
  • 可选
  • 330100
  • 城市码
  • └ latitude
  • String
  • 可选
  • 10.8
  • 纬度
  • └ countryName
  • String
  • 可选
  • 中华人民共和国
  • 国家名
  • └ provinceName
  • String
  • 可选
  • 浙江省
  • 省份名
  • └ longitude
  • String
  • 可选
  • 55.13
  • 经度

响应参数

名称 类型 示例值 描述
resultStatus String ACCEPT 取消预约结果,值是以下几种: SUCCESS:取消预约成功。 FAIL:取消预约失败。 UNKNOWN:未知。 ACCEPT: 收到取消预约请求,需要二次确认。此时预约状态为取消中/修改中(如果是修改导致的取消则为修改中),需要isv调alibaba.alihealth.medical.reservation.cancellation.confirm/reject接口确认/拒绝取消预约,或者调alibaba.alihealth.medical.reservation.modification.confirm/reject接口确认/拒绝修改。拒绝取消/修改后原来的预约信息不变
resultCode String RESERVATION_CANCELING 结果码,由isv定义并返回
resultMsg String 取消预约中 结果消息

请求示例

{"modificationInfo":{"scheduledFinishTime":"2024-04-16 01:45:05","consumerAddress":{"districtCode":"330106","address":"阿里巴巴","cityName":"杭州市","districtName":"西湖区","countryCode":"100000","provinceCode":"330000","cityCode":"330100","latitude":"10.8","countryName":"中华人民共和国","provinceName":"浙江省","longitude":"55.13"},"scheduledTime":"2012-11-08 18:10:48"},"isvReservationRecordId":"10000123","causedByModification":true,"alihealthReservationRecordId":"2000111111","cancellationReasonDetail":"CUSTOMER_CANCEL_RESERVATION"}

响应示例

{
    "resultStatus":"ACCEPT",
    "resultCode":"RESERVATION_CANCELING",
    "resultMsg":"取消预约中"
}

验签示例

{"resultStatus":"UNKNOWN","resultCode":"sign-check-failure","resultMsg":"Illegal request"}

错误码解释

错误码 错误描述 解决方案
response-body-parse-error
isp.http-closed

API工具

FAQ

返回
顶部