软件红岩车联网SRD文档人车相关迭代3.docx

软件红岩车联网SRD文档人车相关迭代3.docx

《软件红岩车联网SRD文档人车相关迭代3.docx》由会员分享，可在线阅读，更多相关《软件红岩车联网SRD文档人车相关迭代3.docx（26页珍藏版）》请在冰豆网上搜索。

软件红岩车联网SRD文档人车相关迭代3

项目名称SRD

1前言

[阐述该文档撰写的前提条件和背景]

1.1目的

【阐述该文档明确的目的，范围，方案以及计划】

1.2文档信息

文件名称：

项目名称SRD

文档版本号：

**

文档作者：

生成日期：

2016-xx-xx

文档审核者：

审核日期：

1.3文档维护历史

1.4参考

题目

描述

1.5缩略词

缩略词

定义

服务APP

服务APP客户端（安卓、IOS）

serverstation微服务

服务站core服务

2CAPP微服务

2CAPPcore服务

位置云服务

位置云服务

fault微服务

fault模块提供车辆故障码查询

2系统概述

红岩服务APP是专门为服务站工作人员提供车辆保养维修一系列操作及管理的APP软件。

2.1目标用户

司机APP

车队APP

车队WEB版

TBoss

产销APP

服务APP

司机

√

×

×

×

×

×

车主

×

√

√

×

×

×

车队管理员

×

√

√

×

×

×

车厂运营人员

×

×

×

√

√

×

生产人员

×

×

×

×

√

×

经销商

×

×

×

×

√

×

服务站

×

×

×

×

×

√

司机：

车辆的使用者

车主：

车辆的实际拥有者

车队管理员：

车辆的管理者

2.2服务模块系统架构（涉及相关模块）

2.3服务模块流程图及状态流转图

流程图：

服务站-工单流程

司机App-工单流程

400客服-工单流程

状态流转图

工单状态定义

工单状态（工单表：

tbl_work_order的wo_status列）及对应描述：

状态值

状态描述

1

待接受

2

待出发

3

待接车

4

检查中

5

维修中

81

拒单审核中

82

关闭审核中

83

修改审核中

97

审核关闭

98

取消预约

100

已完成

工单操作记录定义：

操作状态枚举（操作记录表：

serverstation_operate_record的op_status列）：

状态值

状态描述

1

初始

2

派单确认回访

3

超时未接单回访

4

超时未出发回访

5

超时未到达回访

6

服务质量回访

7

技术支持回访

10

二次维修

11

新增维修项

12

二次外出

13

催单

14

司机评价

20

同意

21

驳回

22

追加记录

2.4系统组件

系统由司机APP、车队APP、TBoss运营支撑系统、产销APP、服务APP所需的微服务模块组成。

2.4.1司机APP

司机APP包含：

货运导航（第三方）、行程分析、故障诊断、行车管家、服务预约、一键呼救、联系客服、解放推荐（第三方）、货源信息、卡友论坛（第三方），我的资料，优惠券等功能。

2.4.2车队APP

车队APP包含：

运营统计、车辆管理、司机管理、线路管理、管理员管理、实时监控、统计分析、联系客服、服务预约、货源信息、卡友论坛（第三方）、我的资料、优惠券等功能。

2.4.3TBoss运营支撑系统

TBoss运营支撑系统包含：

业务支撑（车主认证审核、保养管理、一键呼救、APP用户管理、故障诊断、紧急电话配置、消息管理、预约项目配置、车辆信息查询、APPbanner配置）、在线客服、服务预约管理（新建工单、客服分单、工单处理、关闭申请审核、外出救援、服务统计分析、离线工单）、货源会员认证、市场推广（活动管理、发放管理、兑换管理）、系统管理（部门管理、角色管理、用户管理）、积分管理（规则配置、用户积分数据、积分活动管理、积分券兑换数据）等

2.4.4服务APP

服务APP包含：

服务流程（分派、接车、检查、维修、用户确认、出站、用户确认出站）、外出救援（接车、检查、维修、用户确认、出站、用户确认出站）、历史工单管理、优惠券兑换、离线工单处理等

2.4.5寰游平台

寰游平台包含：

热力图、车辆监控（车辆、服务站、风控区）、风险防控、统计分析（通用报表分析、车厂业务报表、车厂产销报表、服务站列表）、系统管理（业务相关、系统相关、指令日志）等

2.4.6位置云服务

位置云服务：

收集车辆盒子上传的基本位置数据，车辆故障、报警信息，指令下发等功能

2.4.7fault模块

主要提供车辆故障信息的查询，以及故障诊断等的微服务。

2.4.8servicestation微服务模块

主要为服务APP提供微服务并作为业务网关，支持通过feign进行内部微服务的调用。

2.4.9locationservice模块

主要为车厂侧的服务，提供调用位置云webservice的接口服务。

2.4.10webpush模块

主要提供利用爱心推等第三方sdk提供到APP端的推送服务。

2.4.11tool模块

主要提供短信，邮件等工具类服务接口

2.4.122CAPP模块

主要提供车辆信息类服务接口

2.4.13优惠券模块

主要提供发券兑券服务接口

3司机APP软件需求

【依据PRD的功能列表，分别详细描述软件功能需求。

用序列图描述出主要流程，识别出接口，主要参数，约束和限制】

3.1我的车辆列表

详细描述：

该接口是司机APP中我的车辆列表显示接口。

实现是根据用户ID，获取用户作为车主、司机和管理员身份下所有关联车辆。

调用接口路径：

/tocapp/driverCarList司机端-我的车辆列表接口

1、接口参数：

参数名称

参数类型

参数说明

备注

page_number

Integer

当前页码

必填

page_size

Integer

每页记录数量

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、涉及DB：

车辆表：

car

司机车辆关系表：

car_driver_mapping

3.2添加车辆

详细描述：

该接口提供给司机APP、车队APP添加车辆使用，用户加车后默认为该车辆的车主。

加车时要输入车架号、发机号和牌号信息，信息通过云服务验证，完成加车操作并给APP推送成功的消息。

司机端加车时，司机APP、车队APP都推送消息，车队端加车时，只推送到车队APP。

如果信息验证失败则加车操作失败。

业务异常信息包括：

1、成为管理员的用户是不可以进行加车操作的，提示信息“管理员不能添加车辆”。

2、根据输入信息查询出多辆车辆信息，提示信息“数据错误,查找到多个车辆”。

3、该车辆已被添加过，提示信息“车辆已经被添加过，添加失败”。

4、车牌信息已经使用，提示信息“该车牌已经被设定过，添加失败”。

调用接口路径：

/tocapp/addCar添加车辆接口

1、接口参数：

参数名称

参数类型

参数说明

备注

frameNum

String

车架号

必填

engineNum

String

发动机号

必填

carNo

String

车牌号

必填

appType

String

客户端类型

必填1：

车主APP，2：

司机APP

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车架号

507

车架号不能为空

全部

必填项校验:

发动机号

507

发动机号不能为空

全部

必填项校验:

车牌号

507

车牌号不能为空

全部

长度校验：

车架号，输入8字或字符

507

请输入8位车架号

全部

长度校验：

发动机号，输入8字或字符

507

请输入8位发动机号

全部

格式校验：

发动机号，输入1或2

507

客户端类型格式不正确

全部

格式校验：

车牌号

507

车牌号格式不正确

4、涉及DB：

车辆表：

car

用户表：

user

车主信息表：

car_owner_info

管理员关系表：

car_manager_mapping

系统审核表：

system_review

3.3解绑车辆

详细描述：

该接口提供给司机APP、车队APP中用户可以在我的车辆里解绑已经添加的车辆。

解绑时,需要清空车辆表（car）的车主、主副驾驶和车队信息，同时还要清空司机车辆关系表（car_driver_mapping）的人车关系。

业务异常信息包括：

1、要删除的车辆不在该用户的车辆列表中，信息提示“未找到用户与车辆的绑定信息”。

/tocapp/unBindCar解绑车辆

1、接口入参：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

2、接口出参：

结果参数名称

类型

说明

resultCode

Int

通用状态码

message

String

提示信息

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆ID不能为空

4、涉及DB：

车辆表：

car

司机车辆关系表：

car_driver_mapping

3.4车辆详情

详细描述：

该接口返回车辆详情包括车辆信息（车牌号,车辆参数）、车主信息、驾驶司机信息及行驶路线信息。

根据车辆ID查询车辆表（car）关联线路管理表（route_mgt）和司机车辆关系表（car_driver_mapping），取得该车辆的详情信息。

调用接口路径：

/tocapp/carInfo车辆详情接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

**

Integer

路线Id

**

String

路线信息

**

String

副驾驶员名称

**

String

副驾驶员ID

**

String

副驾驶员电话号码

**

String

主驾驶员名称

**

String

主驾驶员ID

**

String

主驾驶员电话号码

**

Integer

速度

**

String

车主电话

**

String

车主名称

**

String

车牌号

**

String

车主ID

**

String

可修改车牌号（用于车主和管理员在司机端APP可编辑车牌号）0不可1可以

**（新原型上没有，故暂不返回管理员信息）

Object[]

管理员信息数组

**#id

String

管理员ID

**#userNnme

String

管理员名称

**#phoneNum

String

管理员电话信息

4、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

5、涉及DB：

车辆表：

car

线路管理表：

route_mgt

司机车辆关系表：

car_driver_mapping

3.5修改车牌号

详细描述：

该接口提供给司机APP修改车辆的车牌号信息。

变更车辆表（car）的车牌号（car_number）,即可实现车牌号的变更。

业务异常信息包括：

1、变更后的车牌号已经被使用，提示信息“该车牌号已经被设定过！

”。

2、变更前后车牌号一致，提示信息“新旧车牌一致，无需修改”。

3、未查询到对应车辆信息，提示信息“没有对应的车辆信息！

”。

调用接口路径：

/tocapp/updateCarNum修改车牌号接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

carNo

String

车牌号

必填

oldCarNo

String

旧车牌号

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

5、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

全部

必填项校验:

车牌号

507

车牌号不能为空

全部

必填项校验:

旧车牌号

507

旧车牌号不能为空

4、涉及DB：

车辆表：

car

3.6设置当前车辆

详细描述：

该接口提供给司机APP绑定当前车辆。

必须是司机、车主或管理员才能绑定车辆，需要判断车辆与用户是否存在以上关系。

绑定成功时，需要更新司机关系表（car_dirver_mapping）的驾驶状态（drive_status）为2。

备注：

驾驶状态（drive_status）1：

初始状态；2：

当前；3:

未驾驶

业务异常信息包括：

1、用户未注册，提示信息“未找到用户信息”。

2、用户不是该车的车主、司机或管理员，提示信息“非用户车辆”。

调用接口路径：

/tocapp/setCurrentCar设置当前车辆接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

4、涉及DB：

车辆表：

car

用户表：

user

车主信息表：

car_owner_info

司机关系表：

car_dirver_mapping

管理员关系表：

car_manager_mapping

3.7车辆设置线路

详细描述：

该接口是司机APP实现车辆绑定线路接口,绑定成功后需要给主副驾驶推送绑定线路成功（司机APP和车队APP）。

可以根据车辆ID作为条件更新车辆表（car）的路线ID（route_id）。

业务异常信息包括：

4、车辆不存在，提示信息“此车辆ID不存在或已被删除”。

5、线路不存在，提示信息“此线路ID不存在或已被删除”。

调用接口路径：

/tocapp/setCarRoute设置车辆线路接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

routeId

String

线路ID

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

全部

必填项校验:

线路ID

507

线路id不能为空

4、涉及DB：

车辆表：

car

线路管理表route_mgt

3.8车辆删除线路

详细描述：

该接口是司机APP实现车辆线路解绑接口,解绑成功后需要给主副驾驶推送绑定线路成功（司机APP和车队APP）。

可以根据车辆ID作为条件更新车辆表（car）的路线ID（route_id）。

业务异常信息包括：

6、车辆不存在，提示信息“此车辆ID不存在或已被删除”。

调用接口路径：

/tocapp/delCarRoute删除车辆线路接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

4、涉及DB：

车辆表：

car

3.9车辆设置主副驾驶

详细描述：

该接口是司机APP实现车辆主副驾驶绑定接口。

绑定司机时需要向司机关系表（car_dirver_mapping）添加一条数据，并且更新车辆表（car）的主驾驶（main_driver）或副驾驶字段（sub_driver）。

业务异常信息包括：

1、获取车辆信息无效，提示信息“此车辆不存在”。

2、车主角色时车辆未被绑定，提示信息“此车辆已解绑无权操作”。

3、管理员角色时车辆未被绑定，提示信息“您不能管理此车辆”。

4、用户与要绑定的司机无绑定关系，提示信息“您名下没有此司机”。

5、要绑定的司机已成为该车辆司机，提示信息“主副驾驶重复，请重新绑定”。

调用接口路径：

/tocapp/bindDriver车辆设置主副驾驶接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

driverType

String

驾驶类型

必填

driverPhone

String

驾驶员手机号

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

3、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

全部

必填项校验:

驾驶类型

507

驾驶类型不能为空

全部

必填项校验:

驾驶员手机号

507

驾驶员手机号不能为空

全部

格式校验:

驾驶类型

507

驾驶类型只能为1或2的正整数

4、涉及DB：

车辆表：

car

司机关系表：

car_dirver_mapping

管理员关系表：

car_manager_mapping

3.10解绑车辆主副驾驶

详细描述：

该接口是司机APP实现车辆主副驾驶解绑接口。

解绑司机时需要删除司机关系表（car_dirver_mapping）的相关数据，并且更新车辆表（car）的主驾驶（main_driver）或副驾驶字段（sub_driver）。

业务异常信息包括：

1、获取车辆信息无效，提示信息“此车辆不存在”。

2、车主角色时车辆未被绑定，提示信息“此车辆已解绑无权操作”。

3、管理员角色时车辆未被绑定，提示信息“您不能管理此车辆”。

4、用户与要绑定的司机无绑定关系，提示信息“您名下没有此司机”。

5、要绑定的司机不是该车辆司机，提示信息“不是当前车辆的主副驾驶员”。

调用接口路径：

/tocapp/unbindDriver解绑车辆主副驾驶接口

1、接口参数：

参数名称

参数类型

参数说明

备注

carId

String

车辆ID

必填

driverType

String

驾驶类型

必填

driverPhone

String

驾驶员手机号

必填

2、接口出参：

结果参数名称

结果参数名称

结果参数名称

resultCode

resultCode

resultCode

message

message

message

6、校验信息：

调用方

校验信息

resultCode

message

全部

必填项校验:

车辆ID

507

车辆id不能为空

全部

必填项校验:

驾驶类型

507

驾驶类型不能为空

全部

必填项校验:

驾驶员手机号

507

驾驶员手机号不能为空

全部

格式校验:

驾驶类型

507

驾驶类型只能为1或2的正整数

7、涉及DB：

车辆表：

car

司机关系表：

car_dirver_mapping

管理员关系表：

car_manager_mapping

4车队APP软件需求