[[TOC]]

= 医美1.0.0接口文档 = 

== 首页数据接口 == 

> index

**说明**

> 获取首页数据，包括焦点图（最多5条）、特色展示（2条）、活动专场（3条）、猜你喜欢（3条）、推荐案例（3条）

**提交方式**

> POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||city||城市||String||""||否||
||project||项目||String||""||否||
||age||年龄段||int||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    listFocus:[{
      type:1,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      focusTitle:””,
      url:”” ,
      contentID:””
    }],
    show:[{
      showTitle:”一元秒杀”,
      showDesc:”有积分就是任性”,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      url:””,
      type:””,
      contentID:””
    }],
    activities[{
      title:”新年美肤专场，水嫩肌肤换出来”,
      imageUrl:””,
      activitiesID:””
    }],
    guessYouLike[{
      likeID:””,
      title:””,
      typeName:””,
      imageUrl””,
      price:999,
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100,
      isEnd:1 
    }],
    example:[{
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }]
  }
}
}}}


----------
== 提交感兴趣的项目 == 

> addLikeProject

**说明**

>用于提交引导页中感兴趣的项目，卸载APP后再次提交时，覆盖添加

**提交方式**

> POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||age||年龄段||String||""||否||
||project||项目列表||String||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}
}}}


----------
== 优惠活动 == 

> getDiscountActivities

**说明**

>获取优惠活动列表

**提交方式**

> POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||
||project||项目||String||""||否||
||age||年龄段||int||""||否||
||city||城市||String||""||否||
||specialID||专场||String||""||否||
||order||排序||String||"1"||否||
||businessID||商家||String||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{ 
    activitiesID:””, 
    title:””, 
    typeName:””, 
    imageUrl””, 
    price:999, 
    discountPrice:1,
    businessName:”深圳广济医疗美容医院”, 
    doctor:”陈柯”, 
    beginTime:””, 
  buyTotal:100, 
  isEnd:1
    }
  ]
}

}}}


----------
== 获取活动详情 == 

> getActivitesInfo

**说明**

>获取活动详情 

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||activitiesID||活动||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    businessID:"商家ID",
    html:""
  }
}
}}}


----------
== 抢购 == 

> quicklyBuy

**说明**

>获取活动详情 

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||""||是||
||activitiesID||活动||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    total:1
  }
}
}}}


----------
== 生成订单 == 

> createOrder

**说明**

>抢购后生成订单 

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||""||是||
||activitiesID||活动||String||""||是||
||total||购买数量|| int ||""||是||
||price||单价|| int ||""||是||
||totalPrice||总价|| int ||""||是||
||phoneNum||手机号||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    orderID:"12424234234"
  }
}
}}}


----------
== 积分兑换 == 

> scoreConvert

**说明**

>支付时采用积分换取需要调用积分兑换 

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||score||分数||int||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}
}}}


----------
== 支付通知 == 

> payNotice

**说明**

>支付成功后通知后台 

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||orderID||订单号||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    score:"100",
    password:"123456,123124,432423"
  }
}
}}}


----------
== 发表晒单 == 

> showOrder

**说明**

>购买成功后可以发表晒单

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||orderID||订单号|| String ||""||是||
||title||标题|| String ||""||是||
||content||内容|| String ||""||是||
||image||图片地址|| String ||""||是||
||label||标签|| String ||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}
}}}


----------
== 获取晒单列表 == 

> getShowOrderList

**说明**

>获取晒单列表

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||3||是||
||project||项目||String||10||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{ 
    exampleID:””, 
    title:””, 
    desc:””, 
    imageUrl””, 
    username:"小美", 
    time:"2015-01-24",
    essence:1, 
    publicationPhoto:1 
    beginTime:””,
    }
  ]
}

}}}


----------
== 收藏/取消收藏 == 

> collectForApp

**说明**

>用于添加收藏和取消收藏

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||activitiesID||活动|| String ||""||是||
|| type||类型：活动和案例|| int ||""||是||
||operation||操作：收藏或取消收藏|| int ||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}
}}}


----------
==是否收藏== 

> collectForApp

**说明**

>判断活动是否已经收藏

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||
||activitiesID||活动|| String ||""||是||
|| type||类型：活动和案例|| int ||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  hasCollect:1
}
}}}


----------
== 获取收藏列表 == 

> getCollectList

**说明**

>根据类型获取收藏列表

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||3||是||
||common_session_id||用户标识||String||""||是||
|| type||类型：活动和案例|| int ||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    activitiesList:[{ 
      activitiesID:””, 
      title:””, 
      typeName:””, 
      imageUrl””, 
      price:999, 
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100, 
      isEnd:1
    }],
  exampleList:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }]
  }
}

}}}


----------
== 医院主页 == 

> getBusiness

**说明**

>获取商家信息

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||businessID||商家|| String ||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    name:”商家名称”, 
    isVip:1, 
    authentication:1, 
    grading:"公立三级医院美容科室", 
    desc:"医院信息", 
    address:"广州",
    workTime:”10:00-21:00”, 
    project:[{ 
      total:20, 
      list:[“玻尿酸隆鼻”, “玻尿酸隆鼻”, “玻尿酸隆鼻”]
    }],
  example:{
    total:20,
    list:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }]
  },
  activities:{
    total:20,
    list:[{ 
      activitiesID:””, 
      title:””, 
      typeName:””, 
      imageUrl””, 
      price:999, 
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100, 
      isEnd:1
    }]},
doctor:{
    total:20,
    list:[{ 
      doctorID:””, 
      imageUrl:””, 
      job:””, 
      name””
    }]}
  }
}

}}}


----------
== 获取医院详细信息 == 

> getBusinessInfo

**说明**

> 获取医院详细信息

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||businessID ||活动||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    html:""
  }
}
}}}


----------
== 获取医生列表 == 

> getDoctorList

**说明**

>根据医院信息获取医生列表

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||3||是||
||businessID||医院||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{[
    name:"陈柯",
    doctorID:””, 
    imageUrl:””, 
    job:””, 
   ]}
}

}}}


----------
== 医院主页 == 

> getBusiness

**说明**

>获取商家信息

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||businessID||商家|| String ||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    desc:”医生详情”, 
  example:{
    total:20,
    list:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }] }
  }
}

}}}


----------
== 获取医生细信息 == 

> getDoctorInfo

**说明**

> 获取医生详细信息

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||doctorID  ||医生ID||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    html:""
  }
}
}}}


----------
== 获取专场列表 == 

> getSpecialList

**说明**

>获取专场列表

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||4||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{[
    title:"陈柯",
    specialID:””, 
    city:”广州,深圳,北京”, 
    discount:””,
     buyTotal:12,
    imageUrl:""
   ]}
}

}}}


----------
== 获取部位列表 == 

> getPositionList

**说明**

>获取部位列表

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{[
    typeID:"1",
    name:”眼部”
   ]}
}

}}}


----------
== 获取二级部位列表 == 

> getSubPositionList

**说明**

>获取二级部位列表

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||typeID||部位类型||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  total:11,
  data:{[
    typeID:"1",
    name:”眼部”
   ]}
}

}}}


----------
== 获取案例列表 == 

> getExampleList

**说明**

>获取案例列表

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||3||是||
||likeProject||项目||String||""||否||
||positionID||部位ID||String||""||否||
||projectID||项目ID||String||""||否||
||doctorID||医生ID||String||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{ 
    exampleID:””, 
    title:””, 
    desc:””, 
    imageUrl””, 
    username:"小美", 
    time:"2015-01-24",
    essence:1, 
    publicationPhoto:1 
    beginTime:””
    }
  ]
}

}}}


----------
== 获取项目列表 == 

> getProjectList

**说明**

>获取项目列表

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  total:11,
  data:{[
    typeID:"1",
    name:”眼部”,
    item:[{
      projectID:”101”,
        name:”埋线双眼皮”
    }]
   ]}
}

}}}


----------
== 获取项目详细信息 == 

> getProjectInfo

**说明**

>获取案例列表

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||projectID||项目ID||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{ 
    html:””
    }
}

}}}


----------
== 获取晒单/案例详细信息 == 

> getExampleInfo

**说明**

>获取案例详情信息，返回的标签点击后要做处理

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||exampleID||案例ID||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{ 
    html:””,
    }
}

}}}


----------
== 获取晒单用户资料 == 

> getExampleInfo

**说明**

>获取用户的资料

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||用户标识||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{ 
    username:”昵称”,
    percent:50,
    headUrl:"",
    sex:"男",
    birthday:"1990-09-21",
    age:21,
    city:"广东广州",
    userProject:"整过的项目1,整过的项目2",
    likeProject:"喜欢的项目1,喜欢的项目2",
    signature:"个性签名", 
    noUse:2,
    score:123
    }
}

}}}


----------
== 修改个人信息 == 

> updateUserInfo

**说明**

>修改个人信息

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||exampleID||案例ID||String||""||是||
||nickname ||昵称||String||""||否||
||headUrl ||头像地址||String||""||否||
||sex ||性别||String||""||否||
||birthday ||生日||String||""||否||
||age ||年龄段||int||""||否||
||city ||城市||String||""||否||
||likeProject ||感兴趣的项目||String||""||否||
||useProject ||整过的项目||String||""||否||
||signature  ||个性签名||String||""||否||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}

}}}


----------
== 获取用户订单 == 

> getUserOrderList

**说明**

>获取我的订单

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||4||是||
||common_session_id ||用户标识||String||""||是||
||orderType ||订单类型//1:全部，2：未消费，3：已消费，4：待付款||int||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{[
    orderID:"123442342",
    imageUrl:””, 
    title:”订单标题”, 
    priceTotal:600,
     total:2,
    failureTime:59,
    state:1,
    showOrderID:"23423432"
   ]}
}

}}}


----------
== 获取订单详情 == 

> getOrderInfo

**说明**

>获取订单详情

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||4||是||
||orderID ||订单||int||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    phoneNum:"13588888888",
    failureTime:”2015-04-15”,
    useTime:”2015-01-01” ,
    orderTime:” 2014-12-01”,
    pwd:[{
       password:”111111”,
      state:1,
      showPhotoID:””
      }]
   }
}

}}}


----------
== 获取用户积分 == 

> getUserScore

**说明**

>获取用户积分

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id ||用户标识||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  data:{
    scoreTotal:"105",
    days:”5”, 
    monthIn:”2015-01-01”,
    monthOut:” 2014-12-01”
   }
}

}}}


----------
== 获取历史积分 == 

> getUserScoreList

**说明**

>获取用户历史积分

**提交方式**

>POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||4||是||
||common_session_id ||用户标识||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    content:"参加活动",
    time:”2015-04-15”,
    type:”1” ,
    score:200
   }
}

}}}


----------
== 领取积分 == 

> getMyScore

**说明**

>获取用户历史积分

**提交方式**

>GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id ||用户标识||String||""||是||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”,
  score:115
}

}}}


----------
== 意见反馈 /版本更新== 

**说明**

>调用魔方

----------
== 登录/注册/重置密码/修改密码== 

**说明**

>调用passport

----------