Dvt-web接口文档.docx

DVT-web接口文档版本号修改内容修改时间修改人v.1.0产品模块，用户模块，系统模块，订单模块。2016-11-10朱文涛V1.0.11. 用户登录不提供用户名（昵称）登录，注册时也不需要填写用户名。2. 用户模块增加手机注册模块。3. 系统模块增加获取手机验证码。2016/11/15朱文涛1.产品模块1.1.产品表1.1.1.列表查询接口描述：查询产品的列表信息URL: /product/list.do方法: get参数: req=参数名类型描述响应：result:0,message:Success.,data:brandList:productId:3,brandId:1,refundRuleId:null,productSn:12345678,productName:马达京旅游套餐,productBrief:好玩好吃好享受,productImg:url,productThumb:url,productPrice:4500.0,promotePrice:4300.0,promoteStartTime:1477524034000,promoteEndTime:1477524034000,clickCount:null,isNew:Y,isOnsale:Y,period:五天四晚,apartment:公寓,apartmentNum:2,bedType:,createBy:1,createTime:1477524035000,updateBy:null,updateTime:null,isDelete:N,productDesc:null,date:2016-10-30T10:01:27.725+08:00参数名类型描述productIdInt产品id1.2.行程表（dvt_trip）1.2.1.列表查询描述：通过产品ID查询行程URL:/product/trip/findByProductId?productId=1方法: get参数: req=?productId=1参数名类型描述productIdLong产品ID响应： result: 0, message: Success., data: tripId: 1, productId: 1, tripDay: 0, tripPlace: , tripEvent: , tripBrief: , createBy: 0, createTime: 1478512921000, updateBy: null, updateTime: null, isDelete: N, tripDesc: , tripId: 2, productId: 1, tripDay: 0, tripPlace: , tripEvent: , tripBrief: , createBy: 0, createTime: 1478697372000, updateBy: null, updateTime: null, isDelete: N, tripDesc: , date: 2016-11-09T21:21:49.512+08:00参数名类型描述tripIdShort行程IDproductIdLong产品IDtripDayByte第几天tripPlaceString行程地点/入住地方（多个地方以“，”隔开）tripEventString行程活动/项目（多个项目以“，”隔开）tripBriefString行程简单描述createByLong创建者createTimeDate创建时间updateByLong修改者updateTimeDate修改时间isDeleteString是否已经删除，N：否，Y：删除tripDescString行程具体描述（富文本）1.3费用包含表（dvt_cost_includes）1.3.1列表查询描述：通过产品ID查询费用包含URL:/product/costIncludes/findByProductId.do?productId=1方法: get参数: req=?productId=1参数名类型描述productIdLong产品ID响应： result: 0, message: Success., data: includeId: 1, productId: 1, costTitle: 11, createBy: 0, createTime: 1478512842000, updateBy: null, updateTime: null, isDelete: N, costContent: 11 , includeId: 2, productId: 1, costTitle: 22, createBy: 0, createTime: 1478698914000, updateBy: null, updateTime: null, isDelete: N, costContent: 22 , date: 2016-11-09T21:42:20.524+08:00参数名类型描述includeIdShort费用包含IDproductIdLong产品IDcostTitleString费用标题createByLong创建者createTimeDate创建时间updateByLong修改者updateTimeDate修改时间isDeleteString是否已经删除，N：否，Y：删除costContentString费用内容1.4.产品属性表（dvt_attribute）1.3.1列表查询描述：通过产品ID查询费用包含URL:product/attribute/findByProductId?productId=1方法: get参数: req=?productId=1参数名类型描述productIdLong产品ID响应： result: 0, message: Success., data: attrId: 1, productId: 1, attrName: 阿德, sortOrder: 0, createBy: 0, createTime: 1478509810000, updateBy: null, updateTime: null, isDelete: N, attrValue: 阿三地方 , attrId: 2, productId: 1, attrName: 阿三地方, sortOrder: 0, createBy: 0, createTime: 1478700571000, updateBy: null, updateTime: null, isDelete: N, attrValue: 阿三地方 , date: 2016-11-09T22:09:48.244+08:00参数名类型描述attrIdShort商品属性IDproductIdLong产品IDattrNameString属性名称sortOrderByte排序依据，数字越大顺序越后，同数字ID在前的先显示createByLong创建者createTimeDate创建时间updateByLong修改者updateTimeDate修改时间isDeleteString是否已经删除，N：否，Y：删除attrValueString属性的值2.用户模板2.1.会员表(dvt_user)2.1.1.用户登录描述：用户登录,可以通过邮箱/手机号/昵称进行登录。URL: /user/login.do方法: post参数: req=email:,passwd:12345678或req= mobilepasswd:12345678参数名类型描述emailString邮箱，可选mobileString手机号码,可选nicknameString昵称,可选passwdString密码响应：result:0,message:Success.,data:userId:2,userName:null,nickname:金三顺,passwd:null,salt:null,digest:3d0efb48-f8db-4df7-b415-15d6e5a74a02,token:a450de2d-909f-41ea-8464-1e29e26acb23,gender:null,birthday:null,email:,telephone:null,mobileqq:null,webchat:null,regTime:1478142017000,validateCode:d79f6df428704d852483a90e6e687392,status:1,lastLogin:1478568781854,lastIp:null,visitCount:null,isDelete:N,forgetPsTime:null,forgetPsState:null,date:2016-11-08T17:33:02.323+08:00参数名类型描述userIdLong会员IDuserNameString会员姓名nicknameString昵称passwdString密码saltString盐(密码加密随机数)digestString登录凭证tokenString登录凭证genderByte性别，0：保密，1：男，2：女birthdayDate出生日期emailString邮箱telephoneString电话mobileString手机号码qqStringqq号webchatString微信号regTimeDate注册时间validateCodeString激活码statusByte激活状态，0：未激活，1：已激活lastLoginDate最后一次登录时间lastIpString最后一次登录IP地址visitCountShort登录次数isDeleteString是否已经删除 Y:已经删除 N：未删除forgetPsTimeDate忘记密码时间（发送修改密码链接时间）forgetPsStateByte1:正常 2：忘记密码2.1.2.获取登录用户信息接口描述：获取用户登录的信息URL: /user/getUserInfo.do方法: get参数: req=参数名类型描述无无无响应：result:0,message:Success.,data:userId:2,userName:null,nickname:金三顺,passwd:null,salt:null,digest:3d0efb48-f8db-4df7-b415-15d6e5a74a02,token:a450de2d-909f-41ea-8464-1e29e26acb23,gender:null,birthday:null,email:,telephone:null,mobileqq:null,webchat:null,regTime:1478142017000,validateCode:d79f6df428704d852483a90e6e687392,status:1,lastLogin:1478568781854,lastIp:null,visitCount:null,isDelete:N,forgetPsTime:null,forgetPsState:null,date:2016-11-08T17:33:02.323+08:00参数名类型描述userIdLong会员IDuserNameString会员姓名nicknameString昵称passwdString密码saltString盐(密码加密随机数)digestString登录凭证tokenString登录凭证genderByte性别，0：保密，1：男，2：女birthdayDate出生日期emailString邮箱telephoneString电话mobileString手机号码qqStringqq号webchatString微信号regTimeDate注册时间validateCodeString激活码statusByte激活状态，0：未激活，1：已激活lastLoginDate最后一次登录时间lastIpString最后一次登录IP地址visitCountShort登录次数isDeleteString是否已经删除 Y:已经删除 N：未删除forgetPsTimeDate忘记密码时间（发送修改密码链接时间）forgetPsStateByte1:正常 2：忘记密码2.1.3.用户注册接口描述：可以通过手机或者邮箱注册（目前只有邮箱注册）URL:/user/register.do方法: post参数: req=email:1122334,passwd:12345678或req= mobilepasswd:12345678参数名类型描述nicknameString昵称passwdString密码mobileString手机号，可选emailString邮箱，可选响应：result:0,message:Success.,date:2016-11-08T17:33:02.323+08:00参数名类型描述无无无2.1.3.用户激活接口描述：用户注册后通过激活成功才能登陆URL:/user/activate.do?email=1122334&validateCode=5c1be5345425915a7f00804c2c7056b6方法: get参数: req无参数名类型描述无无无响应：result: 10004,message: 激活成功！,date: 2016-11-08T20:58:30.219+08:00参数名类型描述无无无2.1.3.用户修改密码接口描述：用户修改密码URL: /user/changePw.do方法: post参数: req =oldPw:12345678,newPw:12345678参数名类型描述oldPwString原登录密码newPwString设置新的登录密码响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.1.3.用户忘记密码接口描述：用户忘记密码URL:/user/forgetPw.do?email=方法: get参数: req = ?email= 参数名类型描述emailString忘记密码邮箱响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.1.4.用户忘记密码链接校验接口描述：用户忘记密码链接校验URL:/user/forgetPwCheck.do?email=1122334&validateCode=5c1be5345425915a7f00804c2c7056b6方法: get参数: req =无参数名类型描述无无无响应：result: 0,message: Success.,data: validateCode: 0109752a4921f6597e1194e63a5e72c3,email: 1122334,date: 2016-11-09T14:32:56.279+08:00参数名类型描述emaiString忘记密码邮箱validateCodeString忘记密码唯一校验码2.1.5.用户忘记密码填写密码后提交接口描述：用户忘记密码，填写密码后提交。URL: /user/forgetPwSubmit.do方法: post参数: req =passwd:12345678,email:1122334,validateCode:0109752a4921f6597e1194e63a5e72c3参数名类型描述emaiString忘记密码邮箱validateCodeString忘记密码唯一校验码passwdString密码响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.1.6.手机注册接口描述：通过手机号注册URL: /user/registerMobile.do方法: post参数: req= passwd: 12345678, authAction: register, messageContent: 594222, mobile:数名类型描述passwdString密码authActionStringregister:注册手机验证码 （其他的还未定）messageContentString发送内容(验证码)mobile String手机号码响应：result:0,message:Success.,date:2016-11-08T17:33:02.323+08:00参数名类型描述无无无2.2.用户收货地址表2.2.1.添加收货地址接口描述：用户添加收货的地址URL:user/address/add.do方法: post参数: req = consignee: 朱文涛, province: 1, city: 1, district: 1, street: 黄土高坡, zipcode: 330000, mobile:数名类型描述consigneeString收件人姓名provinceShort省份，保存IDcityShort市，保存IDdistrictShort区（县），保存IDstreetString街道地址zipcodeString邮政编码mobileString手机号码telephoneString电话号码（可选）响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.2.2.修改收货地址接口描述：用户修改收货的地址URL:user/address/update.do方法: post参数: req = consignee: 朱文涛, province: 1, city: 1, district: 1, street: 黄土高坡, zipcode: 330000, mobile:数名类型描述adressIdLong地址IDconsigneeString收件人姓名，可选provinceShort省份，保存ID，可选cityShort市，保存ID，可选districtShort区（县），保存ID，可选streetString街道地址，可选zipcodeString邮政编码，可选mobileString手机号码，可选telephoneString电话号码（可选）响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.2.3.删除收货地址接口描述：用户删除收货的地址URL:user/address/delete.do?addressId=1方法: get参数: req =?addressId=1参数名类型描述addressIdString收件人姓名，可选响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.2.4.查询登录用户所有收货地址记录接口描述：通过用户查询该用户的所有收货地址URL:user/address/findByUserId.do方法: get参数: req =无参数名类型描述无无无响应： result: 0, message: Success., data: addressId: 2, consignee: 小小名, userId: 2, province: 1, city: 1, district: 1, street: 黄土高坡, zipcode: 330000, telephone: null, mobile:, addressId: 4, consignee: 朱文涛, userId: 2, province: 1, city: 1, district: 1, street: 黄土高坡, zipcode: 330000, telephone: null, mobile:, addressId: 6, consignee: 朱文涛, userId: 2, province: 1, city: 1, district: 1, street: 黄土高坡, zipcode: 330000, telephone: null, mobile:, date: 2016-11-09T16:27:07.928+08:00参数名类型描述addressIdLong地址IDconsigneeString收件人姓名，可选userIdLong用户ID(nul)provinceShort省份，保存ID，可选cityShort市，保存ID，可选districtShort区（县），保存ID，可选streetString街道地址，可选zipcodeString邮政编码，可选telephoneString电话mobileString手机号码，可选2.3.用户入住信息表2.3.1.添加用户入住信息接口描述：添加用户入住信息URL:user/userinfo/add.do方法: post参数: req = chineseName: 李玖哲, pinyinName: zhuwentao, gender: 1, birthday: 1478689363557, age: 1, mobile: email: 1322参数名类型描述chineseNameString姓名，中文pinyinNameShort姓名，拼音genderByte性别，0：男，1：女birthdayDate出生日期ageByte年龄mobileString手机号码emailString邮箱passportNoString护照号（可选）divingRankByte潜水等级（可选）divingCountByte潜水次数（可选）响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.3.2修改用户入住信息接口描述：修改用户入住信息URL:user/userinfo/update.do方法: post参数: req = userinfoId: 2, chineseName: 李玖哲, pinyinName: zhuwentao, gender: 1, birthday: 1478689363557, age: 1, mobile: email: 1322, passport_no: 223356, diving_rank: 1, diving_count: 2参数名类型描述userinfoIdLong会员信息IDchineseNameString姓名，中文（可选）pinyinNameShort姓名，拼音（可选）genderByte性别，0：男，1：女（可选）birthdayDate出生日期（可选）ageByte年龄（可选）mobileString手机号码（可选）emailString邮箱（可选）passportNoString护照号（可选）divingRankByte潜水等级（可选）divingCountByte潜水次数（可选）响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.3.3删除入住信接口描述：删除用户入住信息URL: user/userinfo/delete.do?userinfoId=1方法: get参数: req =?userinfoId=1参数名类型描述userinfoIdLong会员信息ID响应：result:0,message:Success.,date:2016-11-09T11:45:33.504+08:00参数名类型描述无无无2.3.4查询用户信息列表接口描述：通过登录的用户查询用户的用户入住信息URL:user/userinfo/findByUserId.do方法: get参数: req =无参数名类型描述无无无响应： result: 0, message: Success., data: userinfoId: 1, userId: 2, chineseName: , pinyinName: , gender: 0, birthday: 1478448000000, age: 0, mobile: , email: , passportNo: null, divingRank: null, divingCount: null, isDelete: N , userinfoId: 2, userId: 2, chineseName: 李玖哲, pinyinName: zhuwentao, gender: 1, birthday: 1478620800000, age: 1, mobile: email: 1322, passportNo: null, divingRank: null, divingCount: null, isDelete: N , userinfoId: 3, userId: 2, chineseName: 李玖哲, pinyinName: zhuwentao, gender: 1, birthday: 1478620800000, age: 1, mobile: email: 1322, passportNo: null, divingRank: null, divingCount: null, isDelete: N , date: 2016-11-09T20:28:26.719+08:00参数名类型描述userinfoIdLong会员信息IDUserIdLong用户IDchineseNameString姓名，中文pinyinNameShort姓名，拼音genderByte性别，0：男，1：女birthdayDate出生日期ageByte年龄mobileString手机号码emailString邮箱passportNoString护照号divingRankByte潜水等级divingCountByte潜水次数isDeleteString是否已经删除 Y:已删除 N:未删除3.订单模块3.1.订单-会员信息表(dvt_order_userinf)1.2.1.列表查询描述：通过订单ID查询订单-会员信息URL:order/orderUserinfo/findByOrderId.do?orderId=1方法: get参数: req=?orderId=1参数名类型描述orderIdLong订单ID响应： result: 0, message: Success., data: relId: 1, orderId: 1, chineseName: 朱文涛, pinyinName: zhuwentao, gender: 0, birthday: 1478016000000, age: 25, mobile: 131369360865, email: zhuwentao_1992163.com, passportNo: null, divingRank: null, divingCount: null , relId: 2, orderId: 1, chineseName: , pinyinName: , gender: 0, bi