Changes between Version 11 and Version 12 of yimei1.0.0_api


Ignore:
Timestamp:
03/16/2015 02:45:58 PM (11 years ago)
Author:
caomenglin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • yimei1.0.0_api

    v11 v12  
    233233 
    234234---------- 
    235  
    236 == 获取用户资料 ==  
    237  
    238 > getUsuerInfo 
    239  
    240 **说明** 
    241  
    242 >获取用户的资料 
    243  
    244 **提交方式** 
    245  
    246 >GET 
    247  
    248 **数据来源** 
    249  
    250 > 整形库编辑后台 
    251  
    252 **参数** 
    253  
    254 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    255 ||common_session_id||用户标识||String||""||是|| 
    256  
    257 **返回** 
    258  
    259 {{{#!java 
    260 { 
    261   status:0, 
    262   msg:”请求成功”, 
    263   data:{  
    264     phoneNum:”13588888888”, 
    265     username:”昵称”, 
    266     percent:50, 
    267     headUrl:"", 
    268     sex:"男", 
    269     birthday:"1990-09-21", 
    270     age:70, 
    271     city:"广东广州", 
    272     useProject:" 1, 2", 
    273     likeProject:" 1, 2", 
    274     signature:"个性签名",  
    275     noUse:2, 
    276     score:123 
    277     } 
    278 } 
    279  
    280 }}} 
    281  
    282 **返回参数说明** 
    283 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    284 ||= percent =||= 资料完善的百分比=||= age =||=年龄段=|| 
    285 ||= useProject =||= 整过的项目=||= likeProject =||=喜欢的项目=|| 
    286 ||= noUse =||= 未消费的数量=||= score =||=用户总积分=|| 
    287  
    288 ---------- 
    289 == 完善用户资料 ==  
    290  
    291 > updateUserInfo 
    292  
    293 **说明** 
    294  
    295 >完善用户资料 
    296  
    297 **提交方式** 
    298  
    299 >POST 
    300  
    301 **数据来源** 
    302  
    303 > 整形库编辑后台 
    304  
    305 **参数** 
    306  
    307 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    308 || common_session_id ||用户ID||String||""||是|| 
    309 ||nickname ||昵称||String||""||否|| 
    310 ||sex ||性别||String||""||否|| 
    311 ||birthday ||生日||String||""||否|| 
    312 ||age ||年龄段||int||""||否|| 
    313 ||city ||城市||String||""||否|| 
    314 ||likeProject ||感兴趣的项目||String||""||否|| 
    315 ||useProject ||整过的项目||String||""||否|| 
    316 ||signature  ||个性签名||String||""||否|| 
    317  
    318 **返回** 
    319  
    320 {{{#!java 
    321 { 
    322   status:0, 
    323   msg:”请求成功” 
    324 } 
    325  
    326 }}} 
    327  
    328  
    329 ---------- 
    330  
    331235== 提交感兴趣的项目 ==  
    332236 
     
    363267 
    364268---------- 
     269 
     270 
    365271== 首页数据接口 ==  
    366272 
     
    373279**提交方式** 
    374280 
    375 > POST 
     281> GET 
    376282 
    377283**数据来源** 
     
    564470**提交方式** 
    565471 
    566 > POST 
     472> GET 
    567473 
    568474**数据来源** 
     
    670576 
    671577---------- 
    672  
    673 == 提交订单 ==  
    674  
    675 > createOrder 
    676  
    677 **说明** 
    678  
    679 >抢购后生成订单  
    680  
    681 **提交方式** 
    682  
    683 >POST 
    684  
    685 **数据来源** 
    686  
    687 > 整形库编辑后台 
    688  
    689 **参数** 
    690  
    691 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    692 ||common_session_id||用户标识||String||""||是|| 
    693 ||activitiesID||活动||String||""||是|| 
    694 ||total||购买数量|| int ||""||是|| 
    695 ||price||单价|| int ||""||是|| 
    696 ||phoneNum||手机号||String||""||是|| 
    697 ||needScore||所需积分||String||""||否|| 
    698 ||useScore||兑换的积分||String||""||是|| 
    699 ||orderID||定单号:从订单详情页支付时需要传ID来修改消费的积分|| String ||""||否|| 
    700  
    701  
    702 **返回** 
    703  
    704 {{{#!java 
    705 { 
    706   status:0, 
    707   msg:”请求成功”, 
    708   data:{ 
    709     orderID:"12424234234", 
    710     score:"100", 
    711     password:"123456,123124,432423" 
    712  
    713   } 
    714 } 
    715 }}} 
    716  
    717 **返回参数说明** 
    718 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    719 ||= score =||= 奖励的积分=||= password =||= 消费密码=|| 
    720  
    721 ---------- 
    722 == 获取用户订单 ==  
    723  
    724 > getUserOrderList 
    725  
    726 **说明** 
    727  
    728 >获取我的订单 
    729  
    730 **提交方式** 
    731  
    732 >GET 
    733  
    734 **数据来源** 
    735  
    736 > 整形库编辑后台 
    737  
    738 **参数** 
    739  
    740 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    741 ||pageNo||页数||int||1||是|| 
    742 ||pageSize||页面大小||int||4||是|| 
    743 ||common_session_id ||用户标识||String||""||是|| 
    744 ||orderType ||订单类型//1:全部,2:未消费,3:已消费,4:待付款||int||""||是|| 
     578== 获取案例列表 ==  
     579 
     580> getExampleList 
     581 
     582**说明** 
     583 
     584>获取案例列表 
     585 
     586**提交方式** 
     587 
     588>GET 
     589 
     590**数据来源** 
     591 
     592> 整形库编辑后台 
     593 
     594**参数** 
     595 
     596||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
     597||pageNo||页数||int||1||是|||| 
     598||pageSize||页面大小||int||3||是|||| 
     599||age||年龄段||int||""||否|||| 
     600||likeProject||项目||String||""||否|||| 
     601||positionID||部位ID||String||""||否|||| 
     602||projectID||项目ID||String||""||否|||| 
     603||doctorID||医生ID||String||""||否||医生主页中会根据医生来获取案例|| 
     604||businessID||医院ID||String||""||否||医院主页中会根据医院来获取案例|| 
     605 
    745606 
    746607**返回** 
     
    753614  pageSize: 20, 
    754615  total: 100, 
    755   data:[{ 
    756     orderID:"123442342", 
    757     imageUrl:””,  
    758     title:”订单标题”,  
    759     priceTotal:600, 
    760     total:2, 
    761     failureTime:”2015-04-04”,  
    762     endTime:”2015-04-04”,  
    763     useTime:”2015-04-04”,  
    764     delayTime:”2015-04-04”,  
    765     orderTime:”2015-04-04”, 
    766     state:1, 
    767     showOrderID:"23423432", 
    768     activitiesID:’111111’ 
    769    }] 
     616  data:[{  
     617    exampleID:””,  
     618    title:””,  
     619    desc:””,  
     620    imageUrl””,  
     621    username:"小美",  
     622    time:"2015-01-24", 
     623    essence:1,  
     624    publicationPhoto:1  
     625    beginTime:”” 
     626    } 
     627  ] 
    770628} 
    771629 
     
    774632**返回参数说明** 
    775633||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    776 ||priceTotal||总价||failureTime||失效时间,未付款时用到|| 
    777 ||useTime ||消费时间||endTime ||活动结束时间|| 
    778 ||delayTime||消费最后期限||state||1:待付款,2:未消费,3:已消费,4:已过期,5:已失效,6:已晒单|| 
    779 || showOrderID||晒单ID|| orderTime ||下单时间|| 
    780 ---------- 
    781 == 获取订单详情 ==  
    782  
    783 > getOrderInfo 
    784  
    785 **说明** 
    786  
    787 >获取订单详情 
    788  
    789 **提交方式** 
    790  
    791 >GET 
    792  
    793 **数据来源** 
    794  
    795 > 整形库编辑后台 
    796  
    797 **参数** 
    798  
    799 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    800 ||pageNo||页数||int||1||是|| 
    801 ||pageSize||页面大小||int||4||是|| 
    802 ||orderID ||订单||int||""||是|| 
    803  
    804 **返回** 
    805  
    806 {{{#!java 
    807 { 
    808   status:0, 
    809   msg:”请求成功”, 
    810   pageNo: 1,  
    811   pageSize: 20, 
    812   total: 100, 
    813   data:{ 
    814     phoneNum:"13588888888", 
    815     userTotalScore:1000, 
    816     canUseScore:300, 
    817     pwd:[{ 
    818        password:”111111”, 
    819        state:1, 
    820        showPhotoID:”” 
    821       }] 
    822    } 
    823 } 
    824  
    825 }}} 
    826  
    827 **返回参数说明** 
    828 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    829 || canUseScore ||本交活动可以消费的积分,去支付时需要用到|| userTotalScore ||用户总积分|| 
    830 || password ||消费密码|| showPhotoID ||晒单ID|| 
    831  
    832 ---------- 
    833  
     634||= essence =||=是否精华:1:是,0:否=||= publicationPhoto =||= 是否晒单:1:是,0:否=|| 
     635 
     636---------- 
     637 
     638== 获取晒单/案例详细信息(web页) ==  
     639 
     640> getExampleInfo 
     641 
     642**说明** 
     643 
     644>获取案例详情信息,返回的标签点击后要做处理 
     645 
     646**提交方式** 
     647 
     648>GET 
     649 
     650**数据来源** 
     651 
     652> 整形库编辑后台 
     653 
     654**参数** 
     655 
     656||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     657||exampleID||案例ID||String||""||是|| 
     658 
     659**返回** 
     660 
     661{{{#!java 
     662{ 
     663  status:0, 
     664  msg:”请求成功”, 
     665  data:{  
     666    html:””, 
     667    } 
     668} 
     669 
     670}}} 
     671 
     672 
     673---------- 
    834674== 医院主页(web) ==  
    835675 
     
    1133973 
    1134974---------- 
    1135 == 获取案例列表 ==  
    1136  
    1137 > getExampleList 
    1138  
    1139 **说明** 
    1140  
    1141 >获取案例列表 
     975 
     976== 提交订单 ==  
     977 
     978> createOrder 
     979 
     980**说明** 
     981 
     982>抢购后生成订单  
    1142983 
    1143984**提交方式** 
     
    1151992**参数** 
    1152993 
    1153 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
    1154 ||pageNo||页数||int||1||是|||| 
    1155 ||pageSize||页面大小||int||3||是|||| 
    1156 ||likeProject||项目||String||""||否|||| 
    1157 ||positionID||部位ID||String||""||否|||| 
    1158 ||projectID||项目ID||String||""||否|||| 
    1159 ||doctorID||医生ID||String||""||否||医生主页中会根据医生来获取案例|| 
    1160 ||businessID||医院ID||String||""||否||医院主页中会根据医院来获取案例|| 
    1161  
     994||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     995||common_session_id||用户标识||String||""||是|| 
     996||activitiesID||活动||String||""||是|| 
     997||total||购买数量|| int ||""||是|| 
     998||price||单价|| int ||""||是|| 
     999||phoneNum||手机号||String||""||是|| 
     1000||needScore||所需积分||String||""||否|| 
     1001||useScore||兑换的积分||String||""||是|| 
     1002||orderID||定单号:从订单详情页支付时需要传ID来修改消费的积分|| String ||""||否|| 
     1003 
     1004 
     1005**返回** 
     1006 
     1007{{{#!java 
     1008{ 
     1009  status:0, 
     1010  msg:”请求成功”, 
     1011  data:{ 
     1012    orderID:"12424234234", 
     1013    score:"100", 
     1014    password:"123456,123124,432423" 
     1015 
     1016  } 
     1017} 
     1018}}} 
     1019 
     1020**返回参数说明** 
     1021||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     1022||= score =||= 奖励的积分=||= password =||= 消费密码=|| 
     1023 
     1024---------- 
     1025== 获取用户订单 ==  
     1026 
     1027> getUserOrderList 
     1028 
     1029**说明** 
     1030 
     1031>获取我的订单 
     1032 
     1033**提交方式** 
     1034 
     1035>GET 
     1036 
     1037**数据来源** 
     1038 
     1039> 整形库编辑后台 
     1040 
     1041**参数** 
     1042 
     1043||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     1044||pageNo||页数||int||1||是|| 
     1045||pageSize||页面大小||int||4||是|| 
     1046||common_session_id ||用户标识||String||""||是|| 
     1047||orderType ||订单类型//1:全部,2:未消费,3:已消费,4:待付款||int||""||是|| 
    11621048 
    11631049**返回** 
     
    11701056  pageSize: 20, 
    11711057  total: 100, 
    1172   data:[{  
    1173     exampleID:””,  
    1174     title:””,  
    1175     desc:””,  
    1176     imageUrl””,  
    1177     username:"小美",  
    1178     time:"2015-01-24", 
    1179     essence:1,  
    1180     publicationPhoto:1  
    1181     beginTime:”” 
    1182     } 
    1183   ] 
     1058  data:[{ 
     1059    orderID:"123442342", 
     1060    imageUrl:””,  
     1061    title:”订单标题”,  
     1062    priceTotal:600, 
     1063    total:2, 
     1064    failureTime:”2015-04-04”,  
     1065    endTime:”2015-04-04”,  
     1066    useTime:”2015-04-04”,  
     1067    delayTime:”2015-04-04”,  
     1068    orderTime:”2015-04-04”, 
     1069    state:1, 
     1070    showOrderID:"23423432", 
     1071    activitiesID:’111111’ 
     1072   }] 
    11841073} 
    11851074 
     
    11881077**返回参数说明** 
    11891078||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    1190 ||= essence =||=是否精华:1:是,0:否=||= publicationPhoto =||= 是否晒单:1:是,0:否=|| 
    1191  
    1192 ---------- 
    1193  
    1194 == 获取晒单/案例详细信息(web页) ==  
    1195  
    1196 > getExampleInfo 
    1197  
    1198 **说明** 
    1199  
    1200 >获取案例详情信息,返回的标签点击后要做处理 
    1201  
    1202 **提交方式** 
    1203  
    1204 >GET 
    1205  
    1206 **数据来源** 
    1207  
    1208 > 整形库编辑后台 
    1209  
    1210 **参数** 
    1211  
    1212 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    1213 ||exampleID||案例ID||String||""||是|| 
    1214  
    1215 **返回** 
    1216  
    1217 {{{#!java 
    1218 { 
    1219   status:0, 
    1220   msg:”请求成功”, 
    1221   data:{  
    1222     html:””, 
    1223     } 
    1224 } 
    1225  
    1226 }}} 
    1227  
    1228  
    1229 ---------- 
     1079||priceTotal||总价||failureTime||失效时间,未付款时用到|| 
     1080||useTime ||消费时间||endTime ||活动结束时间|| 
     1081||delayTime||消费最后期限||state||1:待付款,2:未消费,3:已消费,4:已过期,5:已失效,6:已晒单|| 
     1082|| showOrderID||晒单ID|| orderTime ||下单时间|| 
     1083---------- 
     1084== 获取订单详情 ==  
     1085 
     1086> getOrderInfo 
     1087 
     1088**说明** 
     1089 
     1090>获取订单详情 
     1091 
     1092**提交方式** 
     1093 
     1094>GET 
     1095 
     1096**数据来源** 
     1097 
     1098> 整形库编辑后台 
     1099 
     1100**参数** 
     1101 
     1102||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     1103||pageNo||页数||int||1||是|| 
     1104||pageSize||页面大小||int||4||是|| 
     1105||orderID ||订单||int||""||是|| 
     1106 
     1107**返回** 
     1108 
     1109{{{#!java 
     1110{ 
     1111  status:0, 
     1112  msg:”请求成功”, 
     1113  pageNo: 1,  
     1114  pageSize: 20, 
     1115  total: 100, 
     1116  data:{ 
     1117    phoneNum:"13588888888", 
     1118    userTotalScore:1000, 
     1119    canUseScore:300, 
     1120    pwd:[{ 
     1121       password:”111111”, 
     1122       state:1, 
     1123       showPhotoID:”” 
     1124      }] 
     1125   } 
     1126} 
     1127 
     1128}}} 
     1129 
     1130**返回参数说明** 
     1131||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     1132|| canUseScore ||本交活动可以消费的积分,去支付时需要用到|| userTotalScore ||用户总积分|| 
     1133|| password ||消费密码|| showPhotoID ||晒单ID|| 
     1134 
     1135---------- 
     1136 
    12301137== 获取用户积分 ==  
    12311138 
     
    12601167    canGetScore:5, 
    12611168    monthIn:110, 
    1262     monthOut:50 
     1169monthOut:50, 
     1170hasGetScore:1 
    12631171   } 
    12641172} 
     
    12701178|| scoreTotal ||用户总积分|| days ||连续签到天数|| 
    12711179|| monthIn ||近一个月进账|| monthOut ||近一个月支出|| 
    1272 || canGetScore||今天可领积分|||||| 
     1180|| canGetScore||今天可领积分|| hasGetScore ||1:已签到,0:未签到|| 
    12731181---------- 
    12741182== 获取历史积分 ==  
     
    13201228 
    13211229---------- 
     1230== 获取用户资料 ==  
     1231 
     1232> getUsuerInfo 
     1233 
     1234**说明** 
     1235 
     1236>获取用户的资料 
     1237 
     1238**提交方式** 
     1239 
     1240>GET 
     1241 
     1242**数据来源** 
     1243 
     1244> 整形库编辑后台 
     1245 
     1246**参数** 
     1247 
     1248||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     1249||common_session_id||用户标识||String||""||是|| 
     1250 
     1251**返回** 
     1252 
     1253{{{#!java 
     1254{ 
     1255  status:0, 
     1256  msg:”请求成功”, 
     1257  data:{  
     1258    phoneNum:”13588888888”, 
     1259    username:”昵称”, 
     1260    percent:50, 
     1261    headUrl:"", 
     1262    sex:"男", 
     1263    birthday:"1990-09-21", 
     1264    age:70, 
     1265    city:"广东广州", 
     1266    useProject:" 1, 2", 
     1267    likeProject:" 1, 2", 
     1268    signature:"个性签名",  
     1269    noUse:2, 
     1270    score:123 
     1271    } 
     1272} 
     1273 
     1274}}} 
     1275 
     1276**返回参数说明** 
     1277||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     1278||= percent =||= 资料完善的百分比=||= age =||=年龄段=|| 
     1279||= useProject =||= 整过的项目=||= likeProject =||=喜欢的项目=|| 
     1280||= noUse =||= 未消费的数量=||= score =||=用户总积分=|| 
     1281 
     1282---------- 
     1283== 完善用户资料 ==  
     1284 
     1285> updateUserInfo 
     1286 
     1287**说明** 
     1288 
     1289>完善用户资料 
     1290 
     1291**提交方式** 
     1292 
     1293>POST 
     1294 
     1295**数据来源** 
     1296 
     1297> 整形库编辑后台 
     1298 
     1299**参数** 
     1300 
     1301||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     1302|| common_session_id ||用户ID||String||""||是|| 
     1303||nickname ||昵称||String||""||否|| 
     1304||sex ||性别||String||""||否|| 
     1305||birthday ||生日||String||""||否|| 
     1306||age ||年龄段||int||""||否|| 
     1307||city ||城市||String||""||否|| 
     1308||likeProject ||感兴趣的项目||String||""||否|| 
     1309||useProject ||整过的项目||String||""||否|| 
     1310||signature  ||个性签名||String||""||否|| 
     1311 
     1312**返回** 
     1313 
     1314{{{#!java 
     1315{ 
     1316  status:0, 
     1317  msg:”请求成功” 
     1318} 
     1319 
     1320}}} 
     1321 
     1322 
     1323---------- 
     1324 
    13221325== 签到 ==  
    13231326