对大街的接口需求.docx
- 文档编号:19759709
- 上传时间:2023-04-24
- 格式:DOCX
- 页数:27
- 大小:21.83KB
对大街的接口需求.docx
《对大街的接口需求.docx》由会员分享,可在线阅读,更多相关《对大街的接口需求.docx(27页珍藏版)》请在冰豆网上搜索。
对大街的接口需求
对大街的接口需求
1.登录
功能描述
用户通过输入账号和密码登录。
如果登录成功,返回用户信息;如果失败,返回失败的原因。
输入参数
参数名
必选
说明
true
登录账号
password
true
登录密码
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息:
比如:
没有这个用户,密码错误等提示
uid
大街网用户id
name
姓名
userPicture
头像
gender
性别
mobile
手机
cityName
所在城市
schoolName
就读学校
specType
专业类别
specName
专业名称
startEduDate
入学时间
eduLevel
学历
emailIsValidate
邮箱是否验证
2.检查绑定并登录
功能描述
通过用户id去第三方平台验证用户是否存在,如果验证成功则返回状态信息和用户信息;如果失败,则通过状态信息返回失败原因。
输入参数
参数名
必选
说明
uid
true
第三方平台uid
platform
true
开方平台代码
0人人网
1开心网
2新浪微博
3MSN
4腾讯微博
5XX
optoken
true
开放平台token(RC4)
opsecret
true
放平台secret(RC4)
oprefreshtoken
false
开放平台refreshtoken(RC4)
devicetoken
false
iOSpushtoken(RC4)
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息:
比如:
没有这个用户,密码错误等提示
corpId
企业id
corpName
企业名称
corpLogo
企业logo
corpDesc
企业简介
isFollowed
是否已关注
recrInfo
招聘信息
semiNum
宣讲会数量
topicNum
讨论区话题数量
concernNum
关注人数
recrStatusList
招聘状态列表
recrStatus
招聘状态
recrDateFrom
状态开始日期
recrDateTo
状态结束日期
recrReached
该状态是否已达到
schoolMateNum
已关注校友数
corpInfo
公司详情
3.绑定第三方开放平台
功能描述
用户通过输入账号、密码和选择要绑定的平台进行绑定操作。
如果绑定成功,返回状态信息和用户信息;如果失败,通过状态信息返回失败原因。
输入参数
参数名
必选
说明
true
登录账号
password
true
登录密码
platform
true
开发平台代码
0人人网
1开心网
2新浪微博
3MSN
4腾讯微博
5XX
optoken
true
开放平台token(RC4)
opsecret
true
放平台secret(RC4)
oprefreshtoken
false
开放平台refreshtoken(RC4)
devicetoken
false
iOSpushtoken(RC4)
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息:
比如:
没有这个用户,密码错误等提示
uid
大街网用户id
name
姓名
userPicture
头像
gender
性别
mobile
手机
cityName
所在城市
schoolName
就读学校
specType
专业类别
specName
专业名称
startEduDate
入学时间
eduLevel
学历
emailIsValidate
邮箱是否验证
4.注册:
基本信息
功能描述
用户录入帐号、密码、姓名和手机号码,选择性别进行注册,注册成功以后返回用户id和姓名,如果失败则通过状态信息返回失败原因。
输入参数
参数名
必选
说明
true
登录账号
password
true
登录密码
name
true
姓名
gender
true
性别
mobile
true
手机
注:
原来已经提供了对应的接口,但是录入项中缺少mobile项。
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
uid
大街网用户id
name
姓名
5.注册:
教育信息
功能描述
用户录入学校名称和专业名称,选择专业类别、入学日期和学历结合用户id注册教育信息,如果成功,返回成功提示,如果失败返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
school
true
学校名称
specType
true
专业类别
specName
true
专业名称
startEduDate
true
入学日期
eduLevel
true
学历
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
6.获取企业列表(是指club信息或者公司信息?
)
功能描述
Ø用户引导->名企关注引导:
只需要传入用户在大街网的UID,服务器根据UID查询该用户所在学校和该用户所读专业(是指相同学校“并且”相同专业还是“或”的关系?
)中同学关注最多的20个名企,如数量不足20个,则读取该用户所读专业关注最多的前20家企业。
(searchType=0)
Ø校园招聘->搜索:
通过组合输入2个参数:
城市和企业名称(企业信息中并无城市信息,企业名称在下面表格中的输入参数中并未列出),查询出所有符合条件的企业,需要支持翻页。
(searchType=1)
Ø我的关注(searchType=2)
Ø我的关注->引导关注(同:
用户引导->名企关注引导)(searchType=0)
Ø我的关注->添加名企,按地区(企业信息中无地区信息)、行业、企业类型(企业类型是指?
)搜(searchType=1)
Ø我的关注->搜索(searchType=1)(是否与上述冲突)
查询成功返回企业列表信息和状态信息,如果失败通过状态信息返回失败原因。
业务规则
按照条件筛选出对应的企业,返回的企业列表按照企业当前招聘数量(招聘多的排前面)、关注人数(关注人数多的在前面)进行排序。
其中宣讲会的数量只统计当前还未结束的宣讲会、讨论区话题数量只返回与当前有效的招聘信息有关的话题数量。
输入参数
参数名
必选
说明
pageNo
false
页码
pageSize
false
每页数量
searchType
true
搜索类型:
0=名企关注引导
1=搜索
2=我的关注
uid
false
用户id
industry
false
所属行业
district
false
地区
corpType
false
企业类型
注:
后四项不会同时为空。
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
corpList(什么类型)
用户关注企业列表
corpId
企业id
corpName
企业名称
corpLogo
企业logo
cityName
企业招聘所在城市
corpDesc
企业简介
isFollowed
是否已关注
recrInfo
招聘信息
semiNum
宣讲会数量
topicNum
讨论区话题数量
concernNum
关注人数
recrStatusList
招聘状态列表
recrStatus
招聘状态
recrDateFrom
状态开始日期
recrDateTo
状态结束日期
recrReached
该状态是否已达到
schoolMateNum
已关注校友数
corpInfo
公司详情
其中公司详情可能需要重新考虑,如果公司详情数据过大,可以提取到获取企业详细信息中进行再获取,否则可以直接去掉获取企业详情信息接口。
公司简介是不是公司详情的前部分?
(公司简介在哪里?
?
)
7.获取企业详细信息
功能描述
根据当前用户的id和企业id获取企业详细信息。
如果成功返回企业详细信息和状态信息,如果失败通过状态信息返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
corpId
true
企业id
注:
原来已经提供了很接近的接口,但是输入参数中缺少“用户id”。
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
corpList
用户关注企业列表
corpId
企业id
corpName
企业名称
corpLogo
企业logo
cityName
企业招聘所在城市
isFollowed
是否已经关注
0否
1是
schoolMateNum
已关注的校友数
corpInfo
公司详情
recrInfo
招聘信息
注:
原功能接口返回的参数中缺少“是否关注”和“已关注的校友数”两个字段的值。
8.保存关注企业
功能描述
通过用户id和企业id进行关联,实现个人关注企业,如果成功返回成功状态信息,如果失败返回失败的原因。
输入参数
参数名
必选
说明
uid
true
用户id
followList
true
关注列表
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
9.获取招聘信息
功能描述
获取招聘信息分为一下四种情况:
Ø获取最新招聘信息;
Ø根据用户id获取该用户同学校被关注企业版的招聘信息;(searchType=1)
Ø根据用户id获取该用户同专业被关注企业版的招聘信息(searchType=2);
Ø按照地区和企业名称查询招聘信息(searchType=3)。
查询成功返回招聘信息和状态信息,如果失败通过状态信息返回失败原因。
业务规则
按照“招聘信息发布时间”倒序排列,且只返回当前有效的招聘信息。
输入参数
参数名
必选
说明
注意事项
pageNo
true
页码
无
pageSize
true
每页数量
无
searchType
true
搜索类型:
0=最新消息
1=同校关注
2=同专业关注
3=搜索
无
uid
false
用户id
searchType=1或2时必选
corpName
false
企业名称
searchType=3时生效
cityName
false
城市名称
searchType=3时生效
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
corpId
企业id
corpName
企业名称
isFollowed
是否关注了该企业
logo
企业logo
recrCity
企业招聘所在城市
recrId
校园招聘id
recrTitle
招聘信息标题
recrPubTime
招聘信息发布时间
isRead
是否已读(什么意思?
是指项目邀约信息已读吗?
)
10.获取宣讲会列表
功能描述
获取宣讲会信息分为一下四种情况:
Ø根据用户id获取本校的宣讲会信息(searchType=0);
Ø根据用户id获取同城的宣讲会信息(searchType=1);
Ø根据城市和企业名称查询宣讲会信息(searchType=2);
Ø根据企业id获取该企业的宣讲会信息(searchType=3)。
如果成功则返回宣讲会信息和状态信息,如果失败,则通过状态信息返回失败原因。
业务规则
返回还未开始的宣讲会信息,按照“宣讲会开始时间”正序排列。
输入参数
参数名
必选
说明
注意事项
pageNo
true
页码
无
pageSize
true
每页数量
无
searchType
true
查询类型
0-本校
1-同城
2-搜索
3-列出企业下的宣讲会
无
uid
true
用户id
无
corpName
false
企业名称
searchType=2生效
cityName
false
城市
searchType=2生效
corpId
false
企业id
searchType=3必选
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
semiId
宣讲会id
corpId
企业id
corpLogo
企业logo
semiTitle
宣讲会标题
startTime
宣讲会开始时间
yyyy-mm-ddhh:
mm:
ss
endTime
宣讲会结束时间
yyyy-mm-ddhh:
mm:
ss
semiLocation
宣讲会地点
registerNum
报名人数
isCooperated
是否合作企业(什么为合作企业?
)
applyUrl
网申地址
isRegistered
是否报名
semiInfo
宣讲会详情
如果获取宣讲会列表中不存在大数据项,那么就可以省去“18获取宣讲会详细信息”接口功能,有待讨论确定。
11.获取宣讲会详细信息
功能描述
根据用户id和宣讲会id查询对应的宣讲会详细信息,返回宣讲会的对应的详细信息。
如果失败通过状态信息返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
semiId
true
宣讲会id
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
semiId
宣讲会id
corpId
企业id
corpLogo
企业logo
semiTitle
宣讲会标题
startTime
宣讲会开始时间
yyyy-mm-ddhh:
mm:
ss
endTime
宣讲会结束时间
yyyy-mm-ddhh:
mm:
ss
semiLocation
宣讲会地点
registerNum
报名人数
isCooperated
是否合作企业
applyUrl
网申地址
isRegistered
是否报名
semiInfo
宣讲会详情
12.宣讲会报名
功能描述
用户输入手机号,系统结合用户id和宣讲会id完成报名操作,报名成功,返回提示信息;如果报名失败,则返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
semiId
true
宣讲会id
mobile
true
手机号
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息:
比如:
已到达报名人数上线
13.获取讨论话题列表
功能描述
根据企业的id,返回对应企业相关的讨论话题列表信息。
如果失败通过状态信息返回失败原因。
业务规则
按照讨论话题“发布时间”倒序排列后返回数据。
输入参数
参数名
必选
说明
corpId
true
企业id
pageNo
true
页面
pageSize
true
每页显示的记录数
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
topicId
话题id
topicTitle
标题
content
正文
pubTime
发布时间
topicType
话题类型:
0=笔经、1=面经、2=薪酬
author
作者
authorPicture
头像
14.获取讨论话题回复信息
功能描述
根据话题id,获取该话题的所有回复信息。
如果失败通过状态信息返回失败原因。
业务规则
按照回复信息“发布时间”倒序排列返回数据。
输入参数
参数名
必选
说明
topicId
true
话题id
pageNo
true
页面
pageSize
true
每页显示的记录数
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
answerId
回复id
answerTitle
标题(回复没有标题)
content
正文
pubTime
发布时间
answerTo
回复给
author
作者
authorPicture
头像
15.发表讨论话题
功能描述
用户选择对应的企业,录入话题标题和正文,并选择话题的类型,发表新的话题。
如果发表成功,返回成功信息;如果发表失败,则返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
corpId
true
企业id
topicTitle
true
标题
content
true
正文
topicType
true
话题类型:
0=无分类、1=笔经、2=面经、3=薪酬
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
16.发表回复
功能描述
用户选择要回复的话题和回复的对象,录入回复的标题和正文进行回复。
如果回复成功则提示回复成功;如果回复失败返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
topicId
true
话题id
answerTitle
true
标题(回复没有标题)
content
true
正文
answerTo
true
回复给
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
17.获取攻略信息(攻略是指什么?
)
功能描述
根据企业的id返回企业的攻略信息。
如果成功返回攻略信息和状态信息,如果失败通过状态信息返回失败原因。
输入参数
参数名
必选
说明
corpId
true
企业id
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
strategyId
攻略id
strategyTitle
标题
content
正文
url
下载地址
fileName
文件名
18.邮件转发攻略信息(邮件格式以及内容是什么?
)
功能描述
根据用户id获取和攻略id,给对应的用户的邮箱发送攻略信息。
如果失败通过状态信息返回失败原因
输入参数
参数名
必选
说明
uid
true
用户id
strategyId
true
攻略id
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
19.获取消息列表
功能描述
根据用户id获取当前用户的消息列表信息和转台信息。
如果失败通过状态信息返回失败原因。
业务规则
按照消息“发布时间”倒序排列后返回数据。
输入参数
参数名
必选
说明
uid
true
用户id
pageNo
true
页面
pageSize
true
每页显示的记录数
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
messageId
话题id
messageTitle
标题
content
正文
receiveTime
发布时间
messageType
消息类型:
0=发布宣讲会
1=发布攻略
2=校招信息发布\更新
3=招聘进展状态
4=讨论区的回复
5=职位邀请
6=宣讲会邀请
7=项目型邀请
isRead
是否阅读0=未读1=已读
20.设信息为已读
功能描述
根据对应的用户id和消息id把对应的消息设置为已读。
如果设置成功,返回提示信息;如果设置失败,返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
messageId
true
消息id
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
21.修改用户基本信息
功能描述
用户可以对用户的姓名、头像、email、性别、手机、所在城市、就读学校、专业名称,选择专业类别、入学时间和学历,修改以后进行保存。
如果保存成功,则返回成功信息;如果保存失败,返回失败原因。
输入参数
参数名
必选
说明
uid
true
用户id
name
true
姓名
userPicture
true
头像
true
gender
true
性别
mobile
true
手机
cityName
true
所在城市
schoolName
true
就读学校
specType
true
专业类别
specName
true
专业名称
startEduDate
true
入学时间
eduLevel
true
学历
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
22.更改头像
功能描述
根据用户id和新头像文件对用户的头像进行修改。
输入参数
参数名
必选
说明
传递方式
默认值
注意事项
uid
true
用户id
form
无
无
userPicture
true
头像
form
无
无
返回数据
变量
含义
result
true-成功
false-失败
message
提示信息
23.判断某人是否关注某企业
根据当前用户的id和企业id获取判断某人是否关注此公司
输入参数
参数名
必选
说明
uid
true
用户id
corpId
true
企业id
返回数据
变量
含义
Result
True:
关注
False:
未关注
24.获取某公司的话题类型
根据企业id获取该企业的话题类型
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 大街 接口 需求