帮帮找接口文档 v1.0

[Toc]

帮帮找接口文档 v1.0


附录

1.错误描述errorCode

错误码 类型 说明
1200 int 操作成功
1500 int 操作失败

2.图片上传

  • 简要概述
    所有图片均以此接口进行上传,以流进行传输.
    上传后将图片地址返回.

  • 参数

参数名 必选 类型 说明
image string 图片名
  • 返回
参数名 必选 类型 说明
url string 图片地址

3.其他

  • 所有列表项均有pageNo字段(页数).请自行添加,以下接口不再对此字段做描述.

一.登录注册

1.0 注册接口

请求URL:

  • /interface/user/register

参数:

参数名 必选 类型 说明
phone string 手机号码
password type=2 string 登录密码
openId type!=2 string 微信/qq唯一标识号
headImage type!=2 string QQ微信头像地址
nickname type!=2 string QQ微信昵称
type sting 0:微信登录 1 QQ登录 2 手机号登录

返回示例

 {
   "errorCode" : "1200",
   "msg" : "操作成功", 
   "data" : {
     "headImage":"",
     "idcard":"", 
     "name":"", 
    "phone":"12345678000", 
    "userId":"18", 
    "userType":""
   }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型,雇主,施工单位,工人
headImage string 头像地址
name string 用户名
phone string 手机号
idcard string 身份证号码

1.1 登录接口

帮帮找接口文档 v1.0_第1张图片
登录

简要描述:

  • 用户可通过微信登录/QQ登录/手机号登录

若用户通过微信/QQ登录,系统可自动注册.
若用户通过手机号登录,需要验证是否存在,存在则登录,否则注册。

请求URL:

  • /interface/user/login

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
phone type=2 string 手机号码
password type=2 string 登录密码
openId type!=2 string 微信/qq唯一标识号
headImage type!=2 string QQ微信头像地址
nickname type!=2 string QQ微信昵称
type sting 0:微信登录 1 QQ登录 2 手机号登录

返回示例

 {
   "errorCode" : "1200",
   "msg" : "操作成功", 
   "data" : {
     "headImage":"",
     "idcard":"", 
     "name":"", 
    "phone":"12345678000", 
    "userId":"18", 
    "userType":""
   }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型,雇主,施工单位,工人
headImage string 头像地址
name string 用户名
phone string 手机号
idcard string 身份证号码

1.2 找回密码/修改密码

注:前端使用验证码校验
简要描述:

  • 用户登录接口

请求URL:

  • /interface/user/getPass

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
phoneNumber string 用户名
password string 新密码

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "headImage":"",
    "idcard":"",
    "name":"",
    "phone":"12345678000",
    "userId":"18",
    "userType":""
  }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型,雇主,施工单位,工人
headImage string 头像地址
name string 用户名
phone string 手机号

1.3 完善个人信息(实名认证)

简要描述:

  • 用户实名认证,所有用户必须通过实名认证后才可使用app功能.

请求URL:

  • /interface/user/aotonmy

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户ID
headImage string 头像
name string 姓名
sex string 性别
birthday date 生日
idcard string 身份证号
address string 地址

返回示例

 {
  "errorCode":"1200", 
  "msg":"操作成功"
}

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败

1.4 审核成为工人

简要描述:

  • 用户实名认证后,可审核成为工人.

请求URL:

  • /interface/user/checkWorker

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户ID
idCardF string 身份证正面
idCardB string 身份证反面
idCardH string 手持身份证
workType String 工种
experience string 经验
speciality string 特长
certificate string 证书
descript string 自我描述

返回示例

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败
status string 0 :未审核 1: 通过 2:未通过
createUser string 审核人
checkTime string 审核时间
cause string 未通过原因(根据具体情况显示)

1.5 审核成为施工单位/材料厂商

简要描述:

  • 用户实名认证后,可审核成为施工单位/材料厂商.

请求URL:

  • /interface/user/checkUnit

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户ID
comLogo string 公司logo
comName string 公司名称
workAddr string 办公地址
telephone String 座机
certificate string 营业执照
picture string 图片
information string 其他信息

返回示例

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败
status string 0 :未审核 1: 通过 2:未通过
createUser string 审核人
checkTime string 审核时间
cause string 未通过原因(根据具体情况显示)

注:工人列表/详情,职位列表/详情,请求URL:

  • /interface/demand/demandList

二.找工人

2.1 工人列表

帮帮找接口文档 v1.0_第2张图片
工人列表

简要描述:

  • 附近的工人列表

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
longitude string 经度
latitude string 纬度

返回示例

返回参数说明

参数名 类型 说明
id string 工人id
name string 工人姓名
workType string 工人
speciality string 擅长
rank string 星级
longitude string 经度
latitude string 纬度

2.2 工人详情

帮帮找接口文档 v1.0_第3张图片
工人详情

简要描述:

  • 工人详情

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
workerId string 工人id
longitude string 经度
latitude string 纬度

返回示例

返回参数说明

  • 自行参考设计稿中所有字段
  • isCollection 是否收藏(/interface/user/isCollection)
  • 工人评价信息(/interface/demand/wokerCommentList)

2.2.1 收藏/取消收藏工人

简要描述:

  • 附近的工人列表

请求URL:

  • /interface/user/addCollection
  • /interface/user/deleteCollection

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
workerId string 工人id
type string 1:收藏 0 取消收藏

返回示例

返回参数说明

  • 返回成功/失败即可

2.2.2 雇佣该工人(没写呢)

参数:

参数名 必选 类型 说明
userId string 用户id
workerId string 工人id
detail string 备注信息

返回:

  • 返回成功或者失败即可.

2.3 发布求职

简要描述:

  • 发布求职

请求URL:

  • /interface/work/applyJob

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
workerId string 工人id
exAddr string 期望工作地点
exSalary string 期望薪水
remark string 备注
entryTime string 入职时间

返回示例

返回参数说明

参数名 类型 说明
name string 工人姓名
age string 出生年月(处理成年龄)
sex string 性别
rank string 星级
address string 住址
workType int 工种
speciality string 擅长
descript string 自我描述
exAddr string 期望工作地点
exSalary string 期望薪资
remark string 备注
entryTime string 入职时间

三.找工作

3.1职位列表

帮帮找接口文档 v1.0_第4张图片
职位列表

简要描述:

  • 职位列表

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
longitude string 经度
latitude string 纬度

返回示例

返回参数说明

参数名 类型 说明
id string 工作id
name string 发布者
time long 发布时间(时间戳)
projectName String 项目名
period string XX年XX月XX日到XX年XX月XX日
workAddr string 工作地点
remark string 备注
needList list 所需工种

其中needList内字段主要为:(单独接口)

请求URL:

  • /interface/demand/needList
参数名 类型 说明
workType int 工种id
personNum int 当前工种人数
salaryType int 薪资类型
salary double 薪资

3.1.1 申请加入(没写呢)

参数:

参数名 必选 类型 说明
userId string 用户id
workId string 职位id
detail string 备注信息

返回:

  • 返回成功或者失败即可.

3.2 发布职位

请求URL:

  • /interface/work/recruit

参数:

参数名 必选 类型 说明
projectName string 项目名称
period string 项目周期(起止时间 xxxx年xx月xx日至xxxx年xx月xx日)
workAddr string 工作地点
remark string 备注信息
needList string 需求列表

其中needList内字段主要为:

参数名 类型 说明
workType int 工种id
personNum int 需求人数
salaryType int 薪资类型 1 日薪 2 月薪 3 年薪
salary double 薪资

返回:

  • 返回成功或者失败即可.

四.找材料(没写)

4.1 采购清单列表

帮帮找接口文档 v1.0_第5张图片
采购清单列表

简要描述:

  • 采购清单列表

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
type string 1:已提交的清单 0:未提交清单

返回示例

返回参数说明

参数名 类型 说明
inventoryId string 清单id
inventoryName string 清单名称
inventoryDetail List 清单内所含商品

其中inventoryDetail内含字段为:

参数名 类型 说明
goodId string 商品名
goodNum string 数量
goodImage string 商品图片
goodState string 商品状态:(1已收到x家商家报价,2已选择某某商家)
marchantPrice string 已选中的商家报价金额

4.2 清单详细信息

帮帮找接口文档 v1.0_第6张图片
清单详细信息

简要描述:

  • 清单详细信息

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
purchasingId string 清单Id

返回示例

返回参数说明

参数名 类型 说明
inventoryId string 清单id
inventoryName string 清单名称
inventoryDetail List 清单内所含商品

其中inventoryDetail内含字段为:

参数名 类型 说明
goodId string 商品名
merchantName string 商家名称
goodNum string 数量
goodImage string 商品图片
goodState string 商品状态:(1已收到x家商家报价,2已选择某某商家)
marchantPrice string 已选中的商家报价金额

4.3 生成订单

4.4 发布清单


五.交流大厅

5.1 大厅列表

帮帮找接口文档 v1.0_第7张图片
大厅列表

简要描述:

  • 交流大厅,排序优先将附近的排在最前面,不含评论

请求URL:

  • /interface/exchange/exchangeList

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户id
longitude string 经度
latitude string 纬度

返回参数说明

参数名 类型 说明
id string 用户id
icon string 用户头像
name string 用户姓名
time string 发布时间 时间戳
longitude string 经度
latitude string 纬度
content string 用户发的内容
image string 图片地址,多张图片以逗号隔开

5.1.1 交流详情

简要描述:

  • 动态的具体信息,含该动态所有评论信息

请求URL:

  • /interface/exchange/exchangeDetail

参数:

参数名 必选 类型 说明
communityId string 条目id

返回参数说明

  • 主要返回的是评论数据
参数名 类型 说明
id string 评论条目id
userId string 评论者id
name string 用户姓名
time string 发布时间 时间戳
word string 评论内容

5.1.2 发表评论

请求URL:

  • /interface/exchange/addComment

参数:

参数名 必选 类型 说明
userId string 用户id
communityId string 状态id
content string 内容
picture string 图片

返回参数说明

  • 返回成功/失败

5.2 发布状态

请求URL:

  • /interface/exchange/addCommunity

参数:

参数名 必选 类型 说明
userId string 用户id
longitude string 经度
latitude string 纬度
content string 内容
image string 图片地址,多张图片以逗号隔开

返回参数说明

  • 返回成功/失败

六.个人中心

6.1 个人信息

简要描述:

  • 用户登录接口

请求URL:

  • /interface/user/userInfo

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户ID

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "headImage":"",
    "idcard":"",
    "name":"",
    "phone":"12345678000",
    "nickname":"",
    "sex":"",
    "birthday":"",
    "userId":"18",
    "userType":""
  }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型,雇主,施工单位,工人
headImage string 头像地址
name string 用户名
phone string 手机号
nickname string 用户昵称
sex string 性别
birthday string 出生年月
idcard string 身份证号
address string 地址

6.2 我的钱包

6.3 我的收藏

简要描述:

  • 用户登录接口

请求URL:

  • /interface/user/userCollectionList

请求方式:

  • POST /GET

参数:

参数名 必选 类型 说明
userId string 用户ID

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "collectionId":"",
    "title":"",
    "createTime":"",
    "tableId":"18",
    "tableName":""
  }
}

返回参数说明

参数名 类型 说明
collectionId string 收藏id
title string 简要描述
createTime string 收藏时间
tableId string 被收藏人id
tableName string 被收藏人姓名

6.4 我的合同

6.5 我的订单

6.6 认证与审核


七.消息中心


你可能感兴趣的:(帮帮找接口文档 v1.0)