预约挂号web前置接口说明文档V2.0.doc

Version 2.0预约挂号平台接口说明文档（web前置）文档修改记录序号修订日期修订说明编写者审核者1概述1.1请求类1.1.1接口定义请求类统一接口为：http:/ip:port/service/RPCweb前置采用rpc协议，所有请求和响应对象均必须实现java Serializable序列化接口进行对象编解码 。1.1.2接口描述ip：服务接口主机IP，由平台统一提供。port：服务接口主机端口，由平台统一提供。URL：固定格式。1.2通知类1.2.1接口定义服务商提供http方式回调请求地址，平台会根据跟地址向服务商发起通知。1.2.2接口描述1、服务商需要向平台提供固定的ip，port，url。2、url：服务商提供，固定回调地址。例如：http:/ip:port/notify/notify.htm3、若服务商更改此URL地址，必须通知平台更新，否则无法通知成功。2详解2.1请求类1)请求类方法请求的时候，公共部分请求对象(VoRequest)为所有请求对象的必填项。2)请求类方法响应的时候，公共部分响应对象(VoResponse)为所有响应对象的返回项。3)请求类统一调用接口名为：TransPort。2.1.1公共部分请求对象VoRequest序号对象属性长度是否必填类型描述1providerCode4YString服务商编号，由平台统一提供2operNo=15YString终端用户IP（网站等公网方式上送终端用户IP）或操作员编号（座席系统，上送操作员编号）3random4YString服务商验签所需的随机码，可由数字和字符组成4signYString服务商验签密码，规则详见（3.1验签）5hopistalId6YString医院编号，由平台统一定义（查询医院概要信息时，该值上送999999）响应对象VoResponse序号对象属性长度是否必填类型描述1code4YString平台统一返回的枚举CODE值，详见（4枚举）2infoYString平台统一返回的枚举DESC值，详见（4枚举）3successYboolean平台统一返回请求是否成功；true：请求成功，false：请求失败2.1.2患者注册方法名称registed()请求对象PatientRegistedRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100100)2patientName20YString姓名3patientIdCard20YString证件号4patientIdCardType1YString证件号类型5patientMediCard24NString医保卡号6patientMediCardType1NString医保卡类型7patientMobile11YString手机号8patientTele12NString电话号码9patientAddr100NString联系地址10patientPostCode6NString邮编11patientSex1NString性别12patientNation2YString民族响应对象PatientRegistedResponse（继承VoResponse）序号对象属性长度是否必填类型描述1patientId10YString返回患者平台唯一Id2.1.3患者预约方法名称order()请求对象PatientOrderRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100103)2patientId10YString平台唯一患者Id3numResourceId10YString平台唯一号源Id4tele25NString主叫号码响应对象PatientOrderResponse（继承VoResponse）序号对象属性长度是否必填类型描述1takeCode8YString取号凭证编号2orderCode10YString平台订单流水号3missNumber1YInt爽约次数2.1.4取消预约方法名称cancel()请求对象PatientCancelRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100104)2takeCode8YString取号凭证编号3orderCode10YString平台订单流水号响应对象PatientCancelResponse（继承VoResponse）无特殊返回值，返回统一响应对象。详见(4枚举)2.1.5患者修改方法名称modify()请求对象PatientModifyRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100112)2patientId10YString平台唯一患者Id3patientName20YString姓名4PatientIdCardType1YString证件号类型5patientMediCard24NString医保卡号6patientMediCardType1NString医保卡类型7patientMobile11YString手机号8patientTele12NString电话号码9patientAddr100NString联系地址10patientPostCode6NString邮编11patientSex1NString性别12patientNation2YString民族响应对象PatientModifyResponse（继承VoResponse）无特殊返回值，返回统一响应对象。详见(4枚举)2.1.6查询医院概要信息方法名称getSummaryHopistals()请求对象SummaryHopistalRequest（继承VoRequest）序号对象属性长度是否必填类型描述1areaCode4YString区域编号响应对象HopistalResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Hopistal序号对象属性类型描述1hospitalIdString医院Id2hospitalNameString医院名称3hospitalLevelString医院等级（0：三甲；1：三乙）4hospitalQualityString医院性质（0：公立；1：民营；2：合资；3：外资；4：其他）5hospitalTypeString医院类型（0：综合；1：专科）6hospitalAddrString医院地址7hospitalTeleString医院电话2.1.7查询医院详细信息方法名称getDetailsHopistals()请求对象DetailsHopistalRequest（继承VoResponse）无特殊请求值，统一请求对象。响应对象HopistalResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Hopistal序号对象属性类型描述1hospitalIdString医院Id2hospitalNameString医院名称3hospitalLevelString医院等级（0：三甲；1：三乙）4hospitalQualityString医院性质（0：公立；1：民营；2：合资；3：外资；4：其他）5hospitalTypeString医院类型（0：综合；1：专科）6hospitalAddrString医院地址7hospitalTeleString医院电话8hospitalUrlString医院官网9HospitalDescString医院简介2.1.8查询科室概要信息方法名称getSummaryDepartments()请求对象SummaryDepartmentRequest（继承VoResponse）无特殊请求值，统一请求对象。响应对象DepartmentResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Department序号对象属性类型描述1deptHisCodeString科室编号2deptNameString科室名称3deptStandardCodeString标准科室编号4 deptStateInt科室状态（0：正常；1：删除）5deptParentString上级科室对应编号2.1.9查询科室详细信息方法名称getDetailsDepartments()请求对象DetailsDepartmentRequest（继承VoRequest）序号对象属性长度是否必填类型描述1deptCode20NString科室编号2deptName20NString科室名称注：上述请求对象二选一响应对象DepartmentResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Department序号对象属性类型描述1deptHisCodeString科室编号2deptNameString科室名称3deptStandardCodeString标准科室编号4 deptStateInt科室状态（0：正常；1：删除）5deptDescString科室描述6deptAgeLimitInt年龄限制（0：无限制；1：14周岁以上；2：18周岁以上）2.1.10查询医生概要信息方法名称getSummaryDoctors()请求对象SummaryDoctorRequest（继承VoResponse）无特殊请求值，统一请求对象。响应对象DoctorResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Doctor序号对象属性类型描述1docHisIdString医生编号2docNameString医生姓名3docSexString医生性别（0：女；1：男）4docTitleString医生职称5docEducationString医生学历6docStateInt医生状态（0：正常；1：删除）7docWorkTimeString医生开始工作时间（yyyy-MM-dd）2.1.11查询医生详细信息方法名称getDetailsDoctors()请求对象DetailsDoctorRequest（继承VoRequest）序号对象属性长度是否必填类型描述1docCode20NString医生编号2docName20NString医生姓名注：上述请求对象二选一响应对象DoctorResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回对应区域的医院集合数据Doctor序号对象属性类型描述1docHisIdString医生编号2docNameString医生姓名3docSexString医生性别（0：女；1：男）4docTitleString医生职称5docEducationString医生学历6docStateInt医生状态（0：正常；1：删除）7docResumeString医生简历8docPhotoString医生照片 9docDescString医生介绍 10docWorkTimeString医生开始工作时间（yyyy-MM-dd）2.1.12查询排班信息方法名称getSchemes()请求对象SchemeRequest（继承VoRequest）序号对象属性长度是否必填类型描述1deptCode20NString科室编号2docName20NString医生姓名响应对象SchemeResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回排班集合数据Scheme序号对象属性类型描述1schemeIdLong排班Id2docNameString医生姓名3docTitleString医生职称4schemeWeekInt星期序列5amCountInt上午可预约数6pmCountInt下午可预约数7amResRemainingInt上午剩余号源 8pmResRemainingInt下午剩余号源 9regFeeInt挂号费用（单位：分）10amStateInt上午挂号状态（0：可预约；1：停诊；2：暂停）11pmStateInt下午挂号状态（0：可预约；1：停诊；2：暂停）12deptNameString科室名称13docHisIdString医生Id14takeAddrString取号地点（如果改值为空，则不显示，否则提示患者）2.1.13查询号源信息方法名称getNumResources()请求对象NumResourceRequest（继承VoRequest）序号对象属性长度是否必填类型描述1schemeId10YString排班Id2resDate8YString就诊日期（yyyyMMdd）3resTimeSign1YString状态（0：上午；1：下午）响应对象NumResourceResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回排班集合数据NumResource序号对象属性类型描述1numIdLong号源Id2resNumberInt号源序号3resTimeString号源预约取号时间NumResource序号对象属性类型描述1numIdLong号源Id2resNumberInt号源序号3resTimeString号源预约取号时间2.1.14查询患者信息方法名称getPatients()请求对象PatientRequest（继承VoRequest）序号对象属性长度是否必填类型描述1patientIdCard20NString患者证件号2patientName20NString患者姓名3patientMobile11NString患者手机号4patientTele12NString患者电话注：上述请求对象四选一响应对象PatientResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回患者集合数据Patient序号对象属性类型描述1patientIdLong患者Id2patientNameString患者姓名3patientIdCardTypeInt证件类型（0：身份证；1：军官证；2：驾驶证；3：护照；4：台胞证；港澳证）4patientIdCardString证件号5patientSexString性别6patientMediCardString医保卡号7patientMediCardTypeInt医保卡类型（0：省医保；1：市医保；2：市民卡；3：农保）8patientMediFlagInt医保卡校验（0：未校验；1：已校验正确；2：已校验错误）9patientMobileString手机号10patientTeleString电话号码11patientAddrString联系地址12patientPostCodeString邮编13registerTimeString注册时间14patientStateInt患者状态（0：正常；1：黑名单；2：注销）15patientNationString患者民族2.1.15查询停诊信息方法名称getStopSchemes()请求对象StopSchemeRequest（继承VoRequest）序号对象属性长度是否必填类型描述1seachDate8YString查询停诊时间（yyyyMMdd）2docName20NString医生姓名3schemeId10NString排班Id响应对象StopSchemeResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回停诊集合数据StopScheme序号对象属性类型描述1deptNameString科室名称2docNameString医生姓名3stopStartTimeString停诊开始时间（yyyyMMdd）4stopEndTimeString停诊结束时间（yyyyMMdd）5weekInt星期索引6stopTimeSignInt停诊时段（0：全天；1：上午；2：下午）7updateTimeString停诊提交时间8orderSumInt该停诊已预约数量9schemeIdString停诊排班Id10hospitalNameString医院名称2.1.16查询停诊预约信息方法名称getStopSchemeOrders()请求对象StopSchemeOrderRequest（继承VoRequest）序号对象属性长度是否必填类型描述1seachDate8YString查询停诊时间（yyyyMMdd）2schemeId10NString排班Id响应对象StopSchemeOrderResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回停诊预约集合数据StopSchemeOrder序号对象属性类型描述1patientNameString患者姓名2patientMobileString手机号3deptNameString科室名称4docNameString医生姓名5orderDateString预约时间6orderTimeSignString状态（0：上午；1：下午）7orderNumberInt预约序号8schemeIdString排班Id9orderIdString预约订单Id2.1.17 查询预约信息方法名称getOrders()请求对象OrdersRequest（继承VoRequest）序号对象属性长度是否必填类型描述1patientIdCard20YString证件号响应对象OrderResponse（继承VoResponse）序号对象属性类型描述1List对象集合返回预约订单集合数据Order序号对象属性类型描述1orderIdString预约订单流水号2hospitalNameString医院名称3deptNameString科室名称4docNameString医生姓名5orderDateString预约时间6orderTimeSignInt状态（0：上午；1：下午）7orderNumberInt预约序号8visitTimeString就诊时间9orderStateInt订单状态（0：成功；1：锁定；2：失败；3：退号；4：挂号中）10hospitalIdString医院Id2.1.18查询预约信息（单笔）方法名称getOrder()请求对象OrderRequest（继承VoRequest）序号对象属性长度是否必填类型描述1orderId10YString平台预约订单流水号响应对象OrderResponse（继承VoResponse）序号对象属性类型描述1Order对象返回预约订单数据Order序号对象属性类型描述1OptimeString预约时间（yyyyMMdd）2hospitalNameString医院名称3deptNameString科室名称4docNameString医生姓名5orderDateString预约时间6orderTimeSignInt状态（0：上午；1：下午）7orderNumberInt预约序号8takeCodeString取号密码9providerIdString服务商编号10operNoString操作员编号（根据服务商上送请求返回）2.2通知类2.2.1停诊通知接口设置接口定义：服务商提供http方式回调请求地址，平台会根据跟地址向服务商发起通知交易。接口描述：服务商需要向平台提供固定ip、port和url 。注：若服务商修改该url，必须通知平台url：服务商提供，固定回调地址，平台根据该url向服务商发起通知。具体格式，例如：http:/ip:port/notify/notify.htm接口说明1、通知方式：平台以http get方式，根据服务商提供的固定url向服务商发起停诊通知。2、通知内容：序号元素名称类型描述1hospitalIdString医院id2schemeIdString排班id3stopSignString停诊标志 0：上午停诊；1：下午停诊；2：全天注：服务商接收到数据后可根据 1 查询停诊排班已预约记录获得相关信息3、通知返回：服务商接收到平台通知业务处理成功则返回success，失败返回error。平台获得服务商返回值，若返回值为success则表示通知成功。否则若返回值为error，平台会不间断的向服务商发送请求，每次发送累积时间为15分钟（即第一次失败15分钟后再次发送，第二次失败后30分钟后再次发送，以此类推），直至服务商返回值为success为止。3安全3.1授权步骤一：由服务商主动发起访问授权申请，或平台提供访问授权。步骤二：服务商提供给平台管理员唯一请求IP、通知回调URL接口、访问相关医院权限，由平台做审核。步骤三：审核通过后，平台管理员会设置相关服务商信息。提供给服务商，平台唯一的服务商编号、服务商密码、客户端DEMO（可选择客户端API，目前只支持JAVA版本，开发环境JDK1.6）、接口文档、测试环境地址。3.2验签3.2.1验签说明1、web前置采用SHA1算法进行加密签名