门户的接口需求.docx

对门户的接口需求1. 登录功能描述用户通过输入账号和密码登录。如果登录成功，返回用户信息；如果失败，返回失败的原因。输入参数参数名必选说明emailtrue登录账号passwordtrue登录密码返回数据变量含义resulttrue-成功false-失败message提示信息：比如：没有这个用户，密码错误等提示uid大街网用户idname姓名userPicture头像emailemailgender性别mobile手机cityName所在城市schoolName就读学校specType专业类别specName专业名称startEduDate入学时间eduLevel学历emailIsValidate邮箱是否验证2. 检查绑定并登录功能描述通过用户id去第三方平台验证用户是否存在，如果验证成功则返回状态信息和用户信息；如果失败，则通过状态信息返回失败原因。输入参数参数名必选说明uidtrue第三方平台uidplatformtrue开方平台代码1 人人网2 开心网3 微博4 MSN 5 百度optokentrue开放平台token（RC4）opsecrettrue放平台secret（RC4）oprefreshtokenfalse开放平台refreshtoken（RC4）devicetokenfalseiOSpushtoken（RC4）返回数据变量含义resulttrue-成功false-失败message提示信息：比如：没有这个用户，密码错误等提示corpId企业idcorpName企业名称corpLogo企业logocorpDesc企业简介isFollowed是否已关注recrInfo招聘信息semiNum宣讲会数量topicNum讨论区话题数量concernNum关注人数recrStatusList招聘状态列表recrStatus招聘状态recrDateFrom状态开始日期recrDateTo状态结束日期recrReached该状态是否已达到schoolMateNum已关注校友数corpInfo公司详情3. 绑定第三方开放平台功能描述用户通过输入账号、密码和选择要绑定的平台进行绑定操作。如果绑定成功，返回状态信息和用户信息；如果失败，通过状态信息返回失败原因。输入参数参数名必选说明emailtrue登录账号passwordtrue登录密码platformtrue开发平台代码1 人人网2 开心网3 微博4 MSN 5 百度optokentrue开放平台token（RC4）opsecrettrue放平台secret（RC4）oprefreshtokenfalse开放平台refreshtoken（RC4）devicetokenfalseiOSpushtoken（RC4）返回数据变量含义resulttrue-成功false-失败message提示信息：比如：没有这个用户，密码错误等提示uid大街网用户idname姓名userPicture头像emailemailgender性别mobile手机cityName所在城市schoolName就读学校specType专业类别specName专业名称startEduDate入学时间eduLevel学历emailIsValidate邮箱是否验证4. 注册：基本信息功能描述用户录入帐号、密码、姓名和手机号码，选择性别进行注册，注册成功以后返回用户id和姓名，如果失败则通过状态信息返回失败原因。输入参数参数名必选说明emailtrue登录账号passwordtrue登录密码nametrue姓名gendertrue性别mobiletrue手机注：原来已经提供了对应的接口，但是录入项中缺少mobile项。返回数据变量含义resulttrue-成功false-失败message提示信息uid大街网用户idname姓名5. 注册：教育信息功能描述用户录入学校名称和专业名称，选择专业类别、入学日期和学历结合用户id注册教育信息，如果成功，返回成功提示，如果失败返回失败原因。输入参数参数名必选说明uidtrue用户idschooltrue学校名称specTypetrue专业类别specNametrue专业名称startEduDatetrue入学日期eduLeveltrue学历返回数据变量含义resulttrue-成功false-失败message提示信息6. 获取企业列表（是指club信息或者公司信息？）功能描述 用户引导-名企关注引导：只需要传入用户在大街网的UID，服务器根据UID查询该用户所在学校和该用户所读专业（是指相同学校“并且”相同专业还是“或”的关系？）中同学关注最多的20个名企，如数量不足20个，则读取该用户所读专业关注最多的前20家企业。(searchType=0) 校园招聘-搜索：通过组合输入2个参数：城市和企业名称（企业信息中并无城市信息，企业名称在下面表格中的输入参数中并未列出），查询出所有符合条件的企业，需要支持翻页。(searchType=1) 我的关注(searchType=2) 我的关注-引导关注 (同：用户引导-名企关注引导)(searchType=0) 我的关注-添加名企，按地区（企业信息中无地区信息）、行业、企业类型（企业类型是指？）搜(searchType=1) 我的关注-搜索(searchType=1)（是否与上述冲突）查询成功返回企业列表信息和状态信息，如果失败通过状态信息返回失败原因。业务规则按照条件筛选出对应的企业，返回的企业列表按照企业当前招聘数量（招聘多的排前面）、关注人数（关注人数多的在前面）进行排序。其中宣讲会的数量只统计当前还未结束的宣讲会、讨论区话题数量只返回与当前有效的招聘信息有关的话题数量。输入参数参数名必选说明pageNofalse页码pageSizefalse每页数量searchTypetrue搜索类型：0=名企关注引导1=搜索2=我的关注uidfalse用户idindustryfalse所属行业districtfalse地区corpTypefalse企业类型注：后四项不会同时为空。返回数据 变量含义resulttrue-成功false-失败message提示信息corpList（什么类型）用户关注企业列表corpId企业idcorpName企业名称corpLogo企业logocityName企业招聘所在城市corpDesc企业简介isFollowed是否已关注recrInfo招聘信息semiNum宣讲会数量topicNum讨论区话题数量concernNum关注人数recrStatusList招聘状态列表recrStatus招聘状态recrDateFrom状态开始日期recrDateTo状态结束日期recrReached该状态是否已达到schoolMateNum已关注校友数corpInfo公司详情其中公司详情可能需要重新考虑，如果公司详情数据过大，可以提取到获取企业详细信息中进行再获取，否则可以直接去掉获取企业详情信息接口。公司简介是不是公司详情的前部分？（公司简介在哪里？）7. 获取企业详细信息功能描述根据当前用户的id和企业id获取企业详细信息。如果成功返回企业详细信息和状态信息，如果失败通过状态信息返回失败原因。输入参数参数名必选说明uidtrue用户idcorpIdtrue企业id注：原来已经提供了很接近的接口，但是输入参数中缺少“用户id”。返回数据变量含义resulttrue-成功false-失败message提示信息corpList用户关注企业列表corpId企业idcorpName企业名称corpLogo企业logocityName企业招聘所在城市isFollowed是否已经关注0否1是schoolMateNum已关注的校友数corpInfo公司详情recrInfo招聘信息注：原功能接口返回的参数中缺少“是否关注”和“已关注的校友数”两个字段的值。8. 保存关注企业功能描述通过用户id和企业id进行关联，实现个人关注企业，如果成功返回成功状态信息，如果失败返回失败的原因。输入参数参数名必选说明uidtrue用户idfollowListtrue关注列表返回数据变量含义resulttrue-成功false-失败message提示信息9. 获取招聘信息功能描述获取招聘信息分为一下四种情况： 获取最新招聘信息； 根据用户id获取该用户同学校被关注企业版的招聘信息；（searchType=1） 根据用户id获取该用户同专业被关注企业版的招聘信息（searchType=2）； 按照地区和企业名称查询招聘信息（searchType=3）。查询成功返回招聘信息和状态信息，如果失败通过状态信息返回失败原因。业务规则按照“招聘信息发布时间”倒序排列，且只返回当前有效的招聘信息。输入参数参数名必选说明注意事项pageNotrue页码无pageSizetrue每页数量无searchTypetrue搜索类型：0=最新消息1=同校关注2=同专业关注3=搜索无uidfalse用户idsearchType=1或2时必选corpNamefalse企业名称searchType=3时生效cityNamefalse城市名称searchType=3时生效返回数据变量含义resulttrue-成功false-失败message提示信息corpId企业idcorpName企业名称isFollowed是否关注了该企业logo企业logorecrCity企业招聘所在城市recrId校园招聘idrecrTitle招聘信息标题recrPubTime招聘信息发布时间isRead是否已读（什么意思？是指项目邀约信息已读吗？）10. 获取宣讲会列表功能描述获取宣讲会信息分为一下四种情况： 根据用户id获取本校的宣讲会信息(searchType=0)； 根据用户id获取同城的宣讲会信息(searchType=1)； 根据城市和企业名称查询宣讲会信息(searchType=2)； 根据企业id获取该企业的宣讲会信息(searchType=3)。如果成功则返回宣讲会信息和状态信息，如果失败，则通过状态信息返回失败原因。业务规则返回还未开始的宣讲会信息，按照“宣讲会开始时间”正序排列。输入参数参数名必选说明注意事项pageNotrue页码无pageSizetrue每页数量无searchTypetrue查询类型0-本校1-同城2-搜索3-列出企业下的宣讲会无uidtrue用户id无corpNamefalse企业名称searchType=2生效cityNamefalse城市searchType=2生效corpIdfalse企业idsearchType=3必选返回数据变量含义resulttrue-成功false-失败message提示信息semiId宣讲会idcorpId企业idcorpLogo企业logosemiTitle宣讲会标题startTime宣讲会开始时间yyyy-mm-dd hh:mm:ssendTime宣讲会结束时间yyyy-mm-dd hh:mm:sssemiLocation宣讲会地点registerNum报名人数isCooperated是否合作企业（什么为合作企业？）applyUrl网申地址isRegistered是否报名semiInfo宣讲会详情如果获取宣讲会列表中不存在大数据项，那么就可以省去“18获取宣讲会详细信息”接口功能，有待讨论确定。11. 获取宣讲会详细信息功能描述根据用户id和宣讲会id查询对应的宣讲会详细信息，返回宣讲会的对应的详细信息。如果失败通过状态信息返回失败原因。输入参数参数名必选说明uidtrue用户idsemiIdtrue宣讲会id返回数据变量含义resulttrue-成功false-失败message提示信息semiId宣讲会idcorpId企业idcorpLogo企业logosemiTitle宣讲会标题startTime宣讲会开始时间yyyy-mm-dd hh:mm:ssendTime宣讲会结束时间yyyy-mm-dd hh:mm:sssemiLocation宣讲会地点registerNum报名人数isCooperated是否合作企业applyUrl网申地址isRegistered是否报名semiInfo宣讲会详情12. 宣讲会报名功能描述用户输入手机号，系统结合用户id和宣讲会id完成报名操作，报名成功，返回提示信息；如果报名失败，则返回失败原因。输入参数参数名必选说明uidtrue用户idsemiIdtrue宣讲会idmobiletrue手机号返回数据变量含义resulttrue-成功false-失败message提示信息：比如：已到达报名人数上线13. 获取讨论话题列表功能描述根据企业的id，返回对应企业相关的讨论话题列表信息。如果失败通过状态信息返回失败原因。业务规则按照讨论话题“发布时间”倒序排列后返回数据。输入参数参数名必选说明corpIdtrue企业idpageNotrue页面pageSizetrue每页显示的记录数返回数据变量含义resulttrue-成功false-失败message提示信息topicId话题idtopicTitle标题content正文pubTime发布时间topicType话题类型：0=笔经、1=面经、2=薪酬author作者authorPicture头像14. 获取讨论话题回复信息功能描述根据话题id，获取该话题的所有回复信息。如果失败通过状态信息返回失败原因。业务规则按照回复信息“发布时间”倒序排列返回数据。输入参数参数名必选说明topicIdtrue话题idpageNotrue页面pageSizetrue每页显示的记录数返回数据变量含义resulttrue-成功false-失败message提示信息answerId回复idanswerTitle标题（回复没有标题）content正文pubTime发布时间answerTo回复给author作者authorPicture头像15. 发表讨论话题功能描述用户选择对应的企业，录入话题标题和正文，并选择话题的类型，发表新的话题。如果发表成功，返回成功信息；如果发表失败，则返回失败原因。输入参数参数名必选说明uidtrue用户idcorpIdtrue企业idtopicTitletrue标题contenttrue正文topicTypetrue话题类型：0=无分类、1=笔经、2=面经、3=薪酬返回数据变量含义resulttrue-成功false-失败message提示信息16. 发表回复功能描述用户选择要回复的话题和回复的对象，录入回复的标题和正文进行回复。如果回复成功则提示回复成功；如果回复失败返回失败原因。输入参数参数名必选说明uidtrue用户idtopicIdtrue话题idanswerTitletrue标题（回复没有标题）contenttrue正文answerTotrue回复给返回数据变量含义resulttrue-成功false-失败message提示信息17. 获取攻略信息（攻略是指什么？）功能描述根据企业的id返回企业的攻略信息。如果成功返回攻略信息和状态信息，如果失败通过状态信息返回失败原因。输入参数参数名必选说明corpIdtrue企业id返回数据变量含义resulttrue-成功false-失败message提示信息strategyId攻略idstrategyTitle标题content正文url下载地址fileName文件名18. 邮件转发攻略信息（邮件格式以及内容是什么？）功能描述根据用户id获取和攻略id，给对应的用户的邮箱发送攻略信息。如果失败通过状态信息返回失败原因输入参数参数名必选说明uidtrue用户idstrategyIdtrue攻略id返回数据变量含义resulttrue-成功false-失败message提示信息19. 获取消息列表功能描述根据用户id获取当前用户的消息列表信息和转台信息。如果失败通过状态信息返回失败原因。业务规则按照消息“发布时间”倒序排列后返回数据。输入参数参数名必选说明uidtrue用户idpageNotrue页面pageSizetrue每页显示的记录数返回数据变量含义resulttrue-成功false-失败message提示信息messageId话题idmessageTitle标题content正文receiveTime发布时间messageType消息类型：0=发布宣讲会1=发布攻略2=校招信息发布更新3=招聘进展状态4=讨论区的回复5=职位邀请6=宣讲会邀请7=项目型邀请isRead是否阅读0=未读 1=已读20. 设信息为已读功能描述根据对应的用户id和消息id把对应的消息设