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

Version2.0预约挂号平台接口说明文档（web前置）Version2.0文文档档修修改改记记录录序号修订日期修订说明编写者审核者Version2.01概述1.1请求类1.1.1接口定义请求类统一接口为：http://[ip]:[port]/service/RPCweb前置采用rpc协议，所有请求和响应对象均必须实现javaSerializable序列化接口进行对象编解码。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。Version2.02.1.1公共部分2.1.1.1请求对象VoRequest序号对象属性长度是否必填类型描述1providerCode4YString服务商编号，由平台统一提供2operNo=15YString终端用户IP（网站等公网方式上送终端用户IP）或操作员编号（座席系统，上送操作员编号）3random4YString服务商验签所需的随机码，可由数字和字符组成4signYString服务商验签密码，规则详见（3.1验签）5hopistalId6YString医院编号，由平台统一定义（查询医院概要信息时，该值上送999999）2.1.1.2响应对象VoResponse序号对象属性长度是否必填类型描述1code4YString平台统一返回的枚举CODE值，详见（4枚举）2infoYString平台统一返回的枚举DESC值，详见（4枚举）3successYboolean平台统一返回请求是否成功；true：请求成功，false：请求失败Version2.02.1.2患者注册2.1.2.1方法名称registed()2.1.2.2请求对象PatientRegistedRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100100)2patientName20YString姓名3patientIdCard20YString证件号4patientIdCardType1YString证件号类型5patientMediCard24NString医保卡号6patientMediCardType1NString医保卡类型7patientMobile11YString手机号8patientTele12NString电话号码9patientAddr100NString联系地址10patientPostCode6NString邮编11patientSex1NString性别12patientNation2YString民族2.1.2.3响应对象PatientRegistedResponse（继承VoResponse）序号对象属性长度是否必填类型描述1patientId10YString返回患者平台唯一Id2.1.3患者预约2.1.3.1方法名称order()Version2.02.1.3.2请求对象PatientOrderRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100103)2patientId10YString平台唯一患者Id3numResourceId10YString平台唯一号源Id4tele25NString主叫号码2.1.3.3响应对象PatientOrderResponse（继承VoResponse）序号对象属性长度是否必填类型描述1takeCode8YString取号凭证编号2orderCode10YString平台订单流水号3missNumber1YInt爽约次数2.1.4取消预约2.1.4.1方法名称cancel()2.1.4.2请求对象PatientCancelRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100104)2takeCode8YString取号凭证编号3orderCode10YString平台订单流水号Version2.02.1.4.3响应对象PatientCancelResponse（继承VoResponse）无特殊返回值，返回统一响应对象。详见(4枚举)2.1.5患者修改2.1.5.1方法名称modify()2.1.5.2请求对象PatientModifyRequest（继承VoRequest）序号对象属性长度是否必填类型描述1tradeCode6YString注册交易码(100112)2patientId10YString平台唯一患者Id3patientName20YString姓名4PatientIdCardType1YString证件号类型5patientMediCard24NString医保卡号6patientMediCardType1NString医保卡类型7patientMobile11YString手机号8patientTele12NString电话号码9patientAddr100NString联系地址10patientPostCode6NString邮编11patientSex1NString性别12patientNation2YString民族2.1.5.3响应对象PatientModifyResponse（继承VoResponse）Version2.0无特殊返回值，返回统一响应对象。详见(4枚举)2.1.6查询医院概要信息2.1.6.1方法名称getSummaryHopistals()2.1.6.2请求对象SummaryHopistalRequest（继承VoRequest）序号对象属性长度是否必填类型描述1areaCode4YString区域编号2.1.6.3响应对象HopistalResponse（继承VoResponse）序号对象属性类型描述1ListHopistal对象集合返回对应区域的医院集合数据Hopistal序号对象属性类型描述1hospitalIdString医院Id2hospitalNameString医院名称3hospitalLevelString医院等级（0：三甲；1：三乙）4hospitalQualityString医院性质（0：公立；1：民营；2：合资；3：外资；4：其他）5hospitalTypeString医院类型（0：综合；1：专科）6hospitalAddrString医院地址7hospitalTeleString医院电话Version2.02.1.7查询医院详细信息2.1.7.1方法名称getDetailsHopistals()2.1.7.2请求对象DetailsHopistalRequest（继承VoResponse）无特殊请求值，统一请求对象。2.1.7.3响应对象HopistalResponse（继承VoResponse）序号对象属性类型描述1ListHopistal对象集合返回对应区域的医院集合数据Hopistal序号对象属性类型描述1hospitalIdString医院Id2hospitalNameString医院名称3hospitalLevelString医院等级（0：三甲；1：三乙）4hospitalQualityString医院性质（0：公立；1：民营；2：合资；3：外资；4：其他）5hospitalTypeString医院类型（0：综合；1：专科）6hospitalAddrString医院地址7hospitalTeleString医院电话8hospitalUrlString医院官网9HospitalDescString医院简介Version2.02.1.8查询科室概要信息2.1.8.1方法名称getSummaryDepartments()2.1.8.2请求对象SummaryDepartmentRequest（继承VoResponse）无特殊请求值，统一请求对象。2.1.8.3响应对象DepartmentResponse（继承VoResponse）序号对象属性类型描述1ListDepartment对象集合返回对应区域的医院集合数据Department序号对象属性类型描述1deptHisCodeString科室编号2deptNameString科室名称3deptStandardCodeString标准科室编号4deptStateInt科室状态（0：正常；1：删除）5deptParentString上级科室对应编号2.1.9查询科室详细信息2.1.9.1方法名称getDetailsDepartments()Version2.02.1.9.2请求对象DetailsDepartmentRequest（继承VoRequest）序号对象属性长度是否必填类型描述1deptCode20NString科室编号2deptName20NString科室名称注：上述请求对象二选一2.1.9.3响应对象DepartmentResponse（继承VoResponse）序号对象属性类型描述1ListDepartment对象集合返回对应区域的医院集合数据Department序号对象属性类型描述1deptHisCodeString科室编号2deptNameString科室名称3deptStandardCodeString标准科室编号4deptStateInt科室状态（0：正常；1：删除）5deptDescString科室描述6deptAgeLimitInt年龄限制（0：无限制；1：14周岁以上；2：18周岁以上）2.1.10查询医生概要信息2.1.10.1方法名称getSummaryDoctors()2.1.10.2请求对象SummaryDoctorRequest（继承VoResponse）Version2.0无特殊请求值，统一请求对象。2.1.10.3响应对象DoctorResponse（继承VoResponse）序号对象属性类型描述1ListDoctor对象集合返回对应区域的医院集合数据Doctor序号对象属性类型描述1docHisIdString医生编号2docNameString医生姓名3docSexString医生性别（0：女；1：男）4docTitleString医生职称5docEducationString医生学历6docStateInt医生状态（0：正常；1：删除）7docWorkTimeString医生开始工作时间（yyyy-MM-dd）2.1.11查询医生详细信息2.1.11.1方法名称getDetailsDoctors()2.1.11.2请求对象DetailsDoctorRequest（继承VoRequest）序号对象属性长度是否必填类型描述1docCode20NString医生编号2docName20NString医生姓名注：上述请求对象二选一Version2.02.1.11.3响应对象DoctorResponse（继承VoResponse）序号对象属性类型描述1ListDoctor对象集合返回对应区域的医院集合数据Doctor序号对象属性类型描述1docHisIdString医生编号2docNameString医生姓名3docSexString医生性别（0：女；1：男）4docTitleString医生职