12580电影频道接口规范[V22]-20130722.doc

广东移动12580信息资讯互动中心电影频道接口规范 V2.22010-07-0312580电影频道接口规范 第 39 页 中数通信息有限公司声 明本文档所有权和解释权归中数通信息有限公司与广东移动通信有限责任公司共有，未经书面许可，不得复制或向第三方公开。修订历史日期修改内容版本号作者2010-03-18初稿1.0吴明锋2010-05-20增加无线城市适用的规范1.1吴明锋2010-05-21调整了部分方法名称获取影院方法参数增加区号1.2吴明锋2010-06-30修改了锁定/解锁座位接口修改订单确认方法1.3吴明锋2011-01-19增加了“补发二维码”的方法1.4吴明锋2011-03-02增加“查询用户余额”、“发送短信”方法修改“获取影院对应日期排期”方法，返回值增加优惠信息修改“获取影院”方法，返回值增加影院地址和联系电话修改“获取对应日期的影片信息”方法，返回值增加影片编号1.5吴明锋2011-03-29重命名“订单查询”方法为“订单状态查询”，并且修改了传入参数，返回值增加了订购渠道1.5.1吴明锋2011-04-07增加了一个“查询订购历史”方法增加一个“查询用户号码品牌”的方法1.5.2吴明锋2011-11-23增加一个新的“锁定座位的方法（带订单号）”增加一个新的“订单确认的方法（已支付）”1.6林永傍2011-11-30在getCinemaShows方法中增加4个价格字段1.6.1林永傍2012-07-03增加兑票信息同步接口1.7李奔2012-08-03增加2.1.5 获取对应日期的影片信息（含图片）1.8郭星2012-09-13将手机支付的锁位和银联支付的锁位合并新增统一锁位接口2.2.15 allLockSeat2.2.16 mobileOrderConfirm1.9郭星2012-11-07增加会员信息查询接口getMemberInfo1.9.1郭星2013-1-6方法getMoviesPhoto返回值增加值FirstDate，修改2.1.3:删除赠票和限购营销价格，增加营销活动明细2.0郭星2013-3-112.1.1获取影院 返回值增加地市区域和商圈名称和影院介绍；增加2.2.18 兑票通票接口（根据时间段查询兑票结果）增加2.2.19 获取电影图片接口2.1郭星2013-07-232.1.5 getMoviesPhoto返回值增加值胶片类型，语种，接口名称，IMAX新增接口 2.1.6 获取影院销售总票数2.2郭星2.2.3，2.2.4，2.2.5，2.2.12，以后不用了文档目录修订历史2文档目录31.接口协议52.接口定义52.1.基础信息同步接口52.1.1.获取影院52.1.2.获取影院对应影厅62.1.3.获取影院对应日期排期72.1.4.获取对应日期的影片信息102.1.5.获取对应日期的影片信息(含图片)112.1.6.获取影院销售总票数122.2.实时交互接口132.2.1.获取排期可售座位数132.2.2.获取对应排期座位状态142.2.3.下订单(手机支付暂时没用)162.2.4.锁定/解除锁定座位（手机支付锁位暂时不用）192.2.5.订单确认（手机支付和订单确认暂时不用）212.2.6.订单状态查询222.2.7.查询订购历史232.2.8.补发二维码252.2.9.查询账户余额262.2.10.查询用户号码品牌262.2.11.发送短信272.2.12.锁定/解除锁定座位（带订单号）（银联支付锁位）282.2.13.订单确认（已支付）（银联支付后再调订单确认）302.2.14.兑票同步接口312.2.15.统一锁定座位（带订单号）（手机支付和银联支付锁位合并）322.2.16.订单确认（带订单号-手机支付和订单确认）352.2.17.会员信息查询接口362.2.18.兑票同步接口(新)362.2.19.获取电影图片接口(用Base64加密)373.返回代码及其描述384.校验信息生成391. 接口协议接口采用webservice形式，以XML格式传输数据2. 接口定义2.1. 基础信息同步接口2.1.1. 获取影院接口名称getCinemas参数名类型说明1userIdString接口访问账号 202userPassString接口访问密码 203cityCodeString影院所在城市区号(该值为空字符串时表示获取所有影院) 54verifyInfoString校验信息返回值 0 XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXXXXXXXXXXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXXXXXXXXXXXXXXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述CinemaCodeString影院编号 50CinemaNameString影院名称 50CityCodeString电影院所在城市区号 5CreateDateString电影院授权日期 格式（yyyy-mm-dd） PartnerCodeString影院系统合作商编号 20PartnerNameString影院系统合作商名称 40CinemaAddressString影院地址 512CinemaPhoneString影院联系电话 64BusareaNameString商圈名称 50CityAreaString地市区域 50CinemaDiscString影院简介 20482.1.2. 获取影院对应影厅接口名称getHalls参数名类型说明1userIdString接口访问账号2userPassString接口访问密码3partnerCodeString影院系统合作商编号4cinemaCodeString影院编号5verifyInfoString校验信息返回值 0 XXXX XXXX XXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述PartnerCodeString影院系统合作商编号CinemaCodeString影院编号HallCodeString影厅编号HallNameString影厅名称VipFlgString贵宾厅标记（Y/N）2.1.3. 获取影院对应日期排期接口名称getCinemaShows参数名类型说明1userIdString接口访问账号2userPassString接口访问密码3partnerCodeString影院系统合作商编号4cinemaCodeString影院编号5showDateString排期日期 格式（yyyy-mm-dd）6verifyInfoString校验信息返回值 0 XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXXXXXXXX XXXXXXXX XXXXXXXX XXXX XXXXXXXXXXXXXXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowCodeString排期编号ShowDateString排期日期(yyyy-MM-dd)ShowTimeString排期时间(hhmm)TotalTimeString片长FilmNoString影片编号FilmNameString影片名称HallCodeString影厅编号HallNameString影厅名称StandPriceNumber接口标准价格（只用于参考)SellPriceNumber该排期接口销售价格（为空或不存在表示该排期不可售）SellDiscountNumber销售折扣（只用于参考)CustPriceString自定价格StanPriceString12580标准价格（自定价格不适用的情况下则用用该价格）prfString该排期是否有优惠活动（0:有; 1:没有）CityCodesString进行优惠活动的城市区号（有多个时以逗号分隔，-1表示不限范围）StartTimeString优惠开始时间（yyyy-mm-dd HH:mi:ss）EndTimeString优惠结束时间（yyyy-mm-dd HH:mi:ss）PreferentialNameString活动名称PreferentialTypeString优惠类型(1:买票送票，2包场，3订电影票赠送通票)PreferentialInfoString优惠信息(如果PreferentialType=1，PreferentialInfo的取值形式是 X:Y,表示买X张票送Y张票;所以实际的订单总金额应该结合排期销售价格和优惠信息来计算，比如某个排期有买1送1的优惠活动，如果某个客户买了2张票，那订单总金额应该只算1张票的价格)ActivityPriceString营销活动价格NumLimitString1个号码限购次数TongpiaoNameString通票名称（只有PreferentialType=3时才会有值,否则为空）StateString排期状态(0 :可售; 1 不可售)2.1.4. 获取对应日期的影片信息接口名称getMovies参数名类型说明1userIdString接口访问账号2userPassString接口访问密码5dateString日期 格式（yyyy-mm-dd）6verifyInfoString校验信息返回值 0 XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述DateString日期 格式(yyyy-MM-dd)FilmNoString影片编号FilmNameString影片名称FilmTypeString影片类型TotalTimeString影片时长DirectorString导演StarringString主演FilmAreaString影片地区FilmBriefString影片简介2.1.5. 获取对应日期的影片信息(含图片)接口名称getMoviesPhoto参数名类型说明1userIdString接口访问账号2userPassString接口访问密码5dateString日期 格式（yyyy-mm-dd）6verifyInfoString校验信息返回值 0 XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述DateString日期 格式(yyyy-MM-dd)FilmNoString接口影片编号FilmNameString影片名称(标准影片名称)FilmTypeString影片类型TotalTimeString影片时长DirectorString导演StarringString主演FilmAreaString影片地区FilmBriefString影片简介photoAddString图片地址，图片目录FirstDateString首映时间 格式(yyyy-MM-dd)Film12580IdString12580电影编码（用于获取电影图片）FilmJpTypeString胶片类型LanguagesString语种InterfaceNameString接口影片名称IMAXString是否IMAX电影(0代表非imax电影，1代表imax电影)2.1.6. 获取影院销售总票数影院销售总票数接口。12580查询所有影院订票成功的总销售票数接口名称getCinemaSaleAmount参数名类型可空说明1userIdStringN接口访问账号2userPassStringN接口访问密码3cinemaCodeStringY影院编号4verifyInfoStringN校验信息返回值 0XXXX XXXX XXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述(1-该电影(时间段)下没有图片)CinemaCodeString影院编号CinemaNameString影院名称CinemaCityString影院地市CinemaAreaString影院区域TicketCountString影院总票数2.2. 实时交互接口2.2.1. 获取排期可售座位数接口名称getShowsSeatAmount参数名参数值（XML格式字符串）1pXmlString XXXXXXXX XXX XXX XXXX参数值描述XML标记类型描述UserIdString接口访问账号UserPassString接口访问密码PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowDateString排期日期(yyyy-MM-dd)ShowString排期编号HallCodeString影厅编号VerifyInfoString检验信息返回值 0 XXXX XXXX XXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowDateString排期日期(yyyy-MM-dd)ShowCodeString排期编号SeatAmountNumber对应排期的座位总数量ValidSeatAmountNumber对应排期的座位可售数量2.2.2. 获取对应排期座位状态接口名称getShowsSeatState参数名类型说明1userIdString接口访问账号2userPassString接口访问密码3partnerCodeString影院系统合作商编号4cinemaCodeString影院编号5showCodeString排期编号6showDateString排期日期 格式（yyyy-mm-dd）7verifyInfoString校验信息返回值 0 XXXX XXXXXXXXXXXXXXXXXXXXXXXX XXX XXXXXXX XXXXXXXXXXXXXXXXXXXXXXXX XXX XXXXXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowDateString排期日期(yyyy-MM-dd)SeatCodeString座位编号SeatAreaCodeString坐区号GraphRowString屏幕行（用于座位画图）GraphColString屏幕列（用于座位画图）SeatRowString坐行（用于显示）SeatColString坐列（用于显示）DamageFlgString座位维修标记（Y/N）LoveIndString情侣座标记(0普通座 1情侣首座位 2情侣第二个座位 注：情侣座需要两个一起销售)SeatStateString状态 (满天星状态：-1不可售,0可售,1已售,3可预订,4选中,7-已锁定,9验收) (火凤凰状态：-1不可售,0可售,1已售,3锁定)(卖座网状态：-1不可售,0可售,7-已锁定)2.2.3. 下订单(手机支付暂时没用)说明：下订单有两种方式： 1、直接调用本接口(wifiOrderTicket)方法，锁定座位/支付/支付确认在一个请求中完成2、或是先调用lockSeats锁定座位，锁定座位返回成功后，如果用户确认要支付，再调用orderConfirm完成支付和订单确认，即在锁定座位后、支付前可以有一个确认的过程接口名称wifiOrderTicket参数名参数值（XML格式字符串）1pXmlString XXXXXXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXXXX XXX XXX参数值描述XML标记类型描述UserIdString接口访问账号UserPassString接口访问密码PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowCodeString排期编号LockSeat要预定的座位SeatCodeString座位编号SeatRowString坐行SeatColString坐列SeatAreaCodeString坐区号SellPriceNumber销售票价OrderIdString接口调用者系统的订单IDTicketCountNumber购票数量FreeTicketCountNumber赠票数量(如果有优惠活动，该值需填实际送票数)RecvMobileString订票的手机号码VerifyInfoString检验信息返回值 0 XXXX XXXX XXXX XXXX XXX XXXX XXXX XXXX XXXX XXXX XXXX 返回值描述XML标记类型描述ResultCodeString0:表示成功 非0数字:失败(具体数字表示错误代码)ErrorMsgString错误描述OrderIdString接口调用者系统的订单IDOrderId12580String12580系统订单IDMoneyNumber订单总金额RecvMobileString订票的手机号码ValidCodeString订单验证码PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowCodeString排期编号LockSeat锁定的座位SeatCodeString座位编号SeatRowString坐行SeatColString坐列SeatAreaCodeString坐区号SellPriceNumber销售票价2.2.4. 锁定/解除锁定座位（手机支付锁位暂时不用）接口名称lockSeats参数名参数值（XML格式字符串）1pXmlString XXXXXXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXXXX XXX XXX参数值描述XML标记类型描述UserIdString接口访问账号UserPassString接口访问密码PartnerCodeString影院系统合作商编号CinemaCodeString影院编号ShowCodeString排期编号LockedTypeString锁定/释放标记(0锁定座位 1释放座位)LockSeat要预定的座位SeatCodeStr