设为首页收藏本站

莫言科技

 找回密码
 立即注册

QQ登录

只需一步,快速开始

旅游集散网(专业版) 全过程、自定制,轻松实现跨 旅游集散中心自助游

票务与调度系统(独立版) 整合旅游集散中心资源,提供 自助半自助游自定义套餐

旅游集散网(创业版) 面向有志创业的人士、基于云 计算理念提供的创业产品

旅游集散网(移动版) 敬请期待   

搜索
查看: 2568|回复: 0

Web服务参数说明

[复制链接]
发表于 2012-10-16 16:24:52 | 显示全部楼层 |阅读模式
AreaService

GetAllProvinces 获得全部省份列表
输入:string partnerId, string sign
输出:List<Area>
   Area属性:
     Id:Area对象的唯一标识
     ParentId:上一级地区的Id
     AreaName:地区名称

GetAreaById 根据Id查询地区详细信息
输入:int areaId, string partnerId, string sign
    areaId:地区Id
输出:Area

GetChildrenAreas  取得下级地区中的城市列表
输入:int parentId, string partnerId, string sign
    parentId:父级地区的Id
输出:List<Area>
    这里取得的下一级地区既包括行政区域也包括其他类型的地区,如上海的下一级地区包括杨浦区、浦东新区等,同时也包括上海旅游集散中心、黄浦旅游集散中心等非行政区域。

SearchAreas 查询符合areaType(ghetto/sightspot/getTicket/start)类型的地区列表
输入:string areaType, string partnerId, string sign
    areaType:ghetto-行政区域/sightspot-景点/getTicket-取票点/start-线路出发点
输出:List<Area>
   
SearchChildrenAreas 取得下级地区中的城市列表,按areaType(ghetto/sightspot/getTicket/start)类型区分
输入:string areaType, int parentId, string partnerId, string sign
输出:List<Area>

提示:如要取得某一地区的下级行政区域,可以通过SearchChildrenAreas("ghetto", parentId, partnerId, sign)获得。

MemberService

CheckEmail  *检查电子邮箱是否已被使用
暂未实现

CheckPhone  *检查手机号码是否已被使用
暂未实现

CheckUsername  检查用户名是否可用,可用则返回true
输入:string username, string partnerId, string sign
输出:bool

EditEmail  *修改电子邮箱
暂未实现

EditMember  编辑用户信息
输入:int memberId, string nick, string name, int gender, string birthday, string identityNum, string mobile, string phone, string email, int areaCode, string zip, string address, string partnerId, string sign
    memberId:Member对象的Id
    name:用户姓名,对应Member对象的realName属性
    gender:2-男、3-女
    birthday:形如"yyyy-MM-dd"的字符串
    identityNum:身份证号
    mobile:手机号
    phone:电话号码
    email:电子邮箱
    areaCode:地区代码,即Area对象的Id
    zip:邮政编码
    address:地址
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:bool

EditPassword  修改密码
输入:int memberId, string oldPassword, string newPassword, string partnerId, string sign
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:bool

EditPhone  *修改手机号码
暂未实现

GetMemberById  会员信息查询
输入:int memberId, string partnerId, string sign
输出:Member

Login  用户登录验证(注:得到返回值true后,需在自己网站建立登录凭据,如session或cookie)
输入:string username, string type, string password, string partnerId, string sign
    type:暂未用到,传入空字符串即可
输出:Member

Register  用户注册
输入:string username, string password, string phone, string email, string partnerId, string sign
    username:用户名,对应Member对象的Name属性
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:Member

ScoreService

AddScore  增加一条评分记录
输入:int memberId, int productId, string title, string content, int trafficScore, int hotelScore, int guideScore, int sightScore, string partnerId, string sign
    memberId:用户Member的Id
    productId:旅游产品的productId属性,如ProductCircuitry.productId
    title:标题
    content:内容
    int trafficScore, int hotelScore, int guideScore, int sightScore 需为[0, 5]之间的整数
    sign:MD5(partnerId前面的参数之和+partnerId+partnerKey)
输出:BlogArticle

DeleteScore  删除评分记录
输入:int scoreId, string partnerId, string sign
    scoreId:BlogArticle对象的Id
    sign:MD5(scoreId + partnerId + partnerKey)
输出:bool

GetScoreByProduct  查询旅游产品的评分列表
输入:int productId, DateTime? startDate, DateTime? endDate,  string orderBy, int startIndex, int pageSize, string partnerId, string sign
    productId:产品的productId属性
    startDate:起始日期,可以为null
    endDate:结束日期,可以为null
    orderBy:UPDATETIME、UPDATETIME_DESC
    startIndex:分页查询时的起始页序号(而非起始记录序号),从0开始
    pageSize:分页查询时每页的大小
输出: List<BlogArticle>
注:日期参数如果不设置时分秒则默认表示一天的开始时刻,而不是结束时刻,如2001-2-3表示2001-2-3 00:00:00,所以如果要查询2001年4月5日至2001年4月8日之间的评分记录,传入的startDate为2001-4-5这一天,endDate应为为2001-4-9这一天。

GetScoreByUser  查询用户的评分列表
输入:int memberId, DateTime? startDate, DateTime? endDate, string orderBy, int startIndex, int pageSize, string partnerId, string sign
    memberId:Member对象的Id属性,不是用户名
    orderBy:UPDATETIME、UPDATETIME_DESC
输出:List<BlogArticle>

ConsultService

AddConsult  创建一条咨询
输入:int memberId, int productId, string title, string content, string partnerId, string sign
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:ProductConsult
    ProductConsult属性:
        Ask:问题内容
        AskId:提问的Member的Id
        AskName:提问的用户名,及Member的name
        PublishTime:提问的时间
        Answer:回复内容,html代码        
        
DeleteConsult  删除咨询
输入:int consultId, string partnerId, string sign
    consultId:ProductConsult的Id
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:bool

GetConsultsByProduct  根据产品加载咨询记录
输入:int productId, DateTime? startDate, DateTime? endDate, string orderBy, int startIndex, int pageSize, string partnerId, string sign
    startDate、endDate:限定提问发生的时间范围
    orderBy:ASKTIME、ASKTIME_DESC、ANSWERTIME、ANSWERTIME_DESC
输出:List<ProductConsult>

GetConsultsByUser  根据用户加载咨询记录
输入:int memberId, DateTime? startDate, DateTime? endDate, string orderBy, int startIndex, int pageSize, string partnerId, string sign
    orderBy:ASKTIME、ASKTIME_DESC、ANSWERTIME、ANSWERTIME_DESC
输出:List<ProductConsult>

ReplyConsult  回复咨询
输入:int memberId, int consultId, string title, string content, string partnerId, string sign
    consultId:ProductConsult的Id
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:ProductConsult
注:经过回复咨询操作后,Id为consultId的咨询的answer属性值得到改变,
新answer=原answer+" " + 用户名 + "   " + 回复时间 + ":<br />" + content + "<br />"   

OrderService

AddOrder  生成订单
输入:int memberId,
        string out_trade_no,
        int payType, int sendType,
        decimal sendFee, decimal totalMoney,
        int area, string address, string zip,
        string name, string idCard, string mobile, string phone, string email,
        string tips, string earlyTime, string lastTime,
        ProductInOrder [] products,
        string partnerId, string sign
    out_trade_no:保存在自己网站数据库中订单记录的唯一标识Id,可为空
    payType:1-票到付款、2-支付宝、3-农行支付
    sendType:1-送票上门、2-现场取票
    sendFee:运费
    totalMoney:总价,包含运费
    area:收货地区Id
    address:收货地址
    zip:邮编
    name:姓名   
    idCard:身份证号
    mobile:手机
    phone:电话
    email:电子邮箱
    tips:其他需求
    earlyTime:期望最早收货时间
    lastTime:期望最晚收货时间
    ProductInOrder [] products:购买的产品列表
      ProductInOrder对象的属性:
        int productId; 产品productId
        int runId; 购买的班次Id
        int[] ticketId; 购买的班次下的票种列表
        int[] ticketNum; 购买的每种票的数量
        string[] hotel_day; 宾馆入住日期和退房日期
    sign:MD5(products前所有参数之和+src+partnerId+partnerKey)
       将products数组中所有对象的属性相加得到src:
        string src = "";
        foreach (ProductInOrder pio in products ) {
           src +=  pio.productId + pio.runId;
           foreach (int ticket in pio.ticketId)
              src += ticket;
           foreach (int ticket in pio.ticketNum)
              src += ticket;
           foreach (string day in pio.hotel_day)
             src += day;
       }
输出:OrderRs
    OrderRs的属性
       int orderId;生成的订单的Id
       string out_trade_no;
       decimal price;生成的订单的总价
       string sign;MD5(orderId+out_trade_no+price+partnerKey)
注:可以利用sign验证函数返回值是否来自旅游集散网。

DropOrder  取消订单
输入:int orderId, string out_trade_no, string reason, string partnerId, string sign
    orderId:集散网订单Id,即OrderDetal.Id
    reason:取消原因
    sign:MD5(partnerId前所有参数之和+partnerId+partnerKey)
输出:bool

EditShip  编辑配送信息
输入:int orderId,
        string out_trade_no,
        int sendType, decimal sendFee,
        int area, string address, string zip,
        string name, string idCard, string mobile, string phone, string email,
        string tips, string earlyTime, string lastTime,
        string partnerId, string sign
    sign:MD5(partnerId前所有参数之和+partnerId+partnerKey)
输出:OrderRs

GetOrderDetail  查询订单详细信息
输入:int orderId, string out_trade_no, string partnerId, string sign
输出:OrderDetail

GetOrderProducts  查询一个订单包含的产品列表
输入:int orderId, string out_trade_no, string partnerId, string sign
输出:List<OrderProducts>

GetOrders  分页查询自己网站的订单
输入:string orderState, string orderBy,  int startIndex, int pageSize, string partnerId, string sign
    orderState:未确认、待发货、待收款、已发货、已付款、已完成、已撤销
    orderBy:CREATETIME、CREATETIME_DESC、UPDATETIME、UPDATETIME_DESC、PAYTIME、PAYTIME_DESC、SENDTIME、SENDTIME_DESC、AREA、AREA_DESC、MONEY、MONEY_DESC
输出:List<OrderDetail>

GetOrdersByUser  分页查询自己网站用户的订单
输入:int memberId,  string orderState, string orderBy, int startIndex, int pageSize, string partnerId, string sign
输入:List<OrderDetail>

SearchOrders  分页分条件查询自己网站的订单
输入:decimal startPrice, decimal endPrice, DateTime? startDate, DateTime? endDate, string orderState, string orderBy, int startIndex, int pageSize, string partnerId, string sign
    startDate、endDate:限定订单生成的时间范围
输出:List<OrderDetail>

SearchOrdersByUser  分页分条件查询自己网站用户的订单
输入:int memberId, decimal startPrice, decimal endPrice, DateTime? startDate, DateTime? endDate, string orderState, string orderBy, int startIndex, int pageSize, string partnerId, string sign
输出:List<OrderDetail>

PaymentService

GetAlipayUrl 得到支付宝付款链接
输入:int orderId, string out_trade_no, string paymentType, string title, string description, string returnUrl, string partnerId, string sig
    orderId:旅游集散网保存的订单Id
    out_trade_no:本地数据库保存的订单编号
    title:支付链接说明
    description:支付页面信息说明
    returnUrl:用户支付完成后跳转的页面链接
    sign:MD5(partnerId前面的所有参数之和+partnerId+partnerKey)
输出:UrlRs
    url:生成的支付宝支付页面链接
    sign:MD5(url+partnerKey)
    可以通过验证sign值判断结果是否来自旅游集散网

CircuitryService

GetCircuitryBySearch  条件搜索
输入:string partnerId, string sign,int lStartPlace, int lEndPlace, string startDate, int nTraverType, string sDays, bool bActive, int nPageIndex, int nPageSize
    lStartPlace、lEndPlace:旅行开始和结束地区Id,如不限定则输入0
    startDate:开始日期,yyyy-MM-dd格式,如不限定则输入null
    nTraverType:32-火车班、64-汽车班、128-特惠、256-江苏游、512-浙江游、0-不限
    sDays:旅行天数
输出:List<CircuitryRecord>
    CircuitryRecord的图片名称为:ProductImgS(小图)和ProductImgB(大图),图片地址为:http://www.travelhub.cn/ticket/CircuitryMng/Circuitry_Image/ 加上图片名称。

GetCircurityById  查询单条记录
输入:string partnerId, string sign, int circuitryId
    circuitryId:Circuitry对象的Id,不是productId
输出:ProductCircuitry

GetRecommandCircuitry  各类推荐方式排序
输入:string partnerId, string sign, int type, int count
    type:1-推荐产品、2-热门产品、3-精品产品、4-特惠产品
    count:最多取出多少条
输出:List<ProductCircuitry>

GetRunDate  所有开班的日期列表
输入:string partnerId, string sign,int id
    id:Circuitry对象的Id
输出:List<string>
    表示日期的字符串数组,日期格式为yyyy-MM-dd

GetRunInfo  指定日期下某旅游产品开设的所有班次列表
输入:string partnerId, string sign,int iRoute, string sDate
    iRoute:Circuitry对象的Id
    sDate:指定日期,yyyy-MM-dd格式
输出:List<ProductCircuitryRun>
    ProductCircuitryRun的属性ticketId为"ticketId1/ticketId2/ticketId3.../",表示该班次下票种id的字符串拼接,字符串以“/”结尾

GetRunTick  指定的班次中可售票种列表
输入:string partnerId, string sign, string tickid
    tickid:ticketId的字符串拼接,id之间用“/”隔开,且以“/”结尾
输出:List<ProductCircuitryTicket>

TrafficService
GetTrafficBySearch(string partnerId, string sign,int iStartArea, int iTargetArea, string sStartDate, int iTrafficType, int nPageIndex, int nPageSize)
int iStartArea  起始地点id,不限定则为0
int iTargetArea 到达地点id,不限定则为0
string sStartDate 班次日期“yyyy-MM-dd”格式,必须限定
int iTrafficType 交通类型(1-飞机、2-火车、4-客车、8-轮船),不限定则为0

SightspotService
GetSightspotBySearch(string partnerId, string sign,int iAreaName, int iSightspotType, string sKeyword, int nPageIndex, int nPageSize)
int iAreaName  地点id,不限定则为0
int iSightspotType 景点类型(1-城市 2-海岛 4-古迹),不限定则为0
string sKeyword 景点关键字

HotelService
GetHotelBySearch(string partnerId, string sign,int iCity, string startDate, string endDate, string sHotelName, int iHotelType, int iHotelLevel, string priceStart, string priceEnd, int nPageIndex, int nPageSize)
int iCity 地点id,必须限定(注,由于数据有限,请输入52-舟山)
string startDate 入住时间,必须限定
string endDate 结束时间,必须限定
string sHotelName 酒店名称关键字
int iHotelType 酒店类型(1-酒店式公寓、2-度假型酒店),不限定则为0
int iHotelLevel 酒店星级(1-二星级、2-准三星级、3-三星级、4-准四星级、5-四星级、6-准五星级、7-五星级、8-度假村、9-国际连锁酒店、10-旅游饭店、11-商务宾馆),不限定则为0
string priceStart 最低价,必须限定
string priceEnd 最高价,必须限定


您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

小黑屋|手机版|Archiver|莫言科技 ( 沪ICP备12024970号-1  

GMT+8, 2018-2-19 03:51 , Processed in 0.101567 second(s), 23 queries .

Powered by Discuz! X3.2

© 2001-2013 Comsenz Inc.

快速回复 返回顶部 返回列表