{ "openapi": "3.0.0", "info": { "title": "Facility Management API", "description": "设施信息管理接口文档,提供设施信息的增删改查功能。设施表(basic_facility)通过building_id与楼宇表(basic_building)关联。", "version": "1.0.0" }, "servers": [ { "url": "https://api.example.com", "description": "Production Server" } ], "paths": { "/facility/getListPage": { "get": { "summary": "分页查询设施列表", "description": "根据查询条件分页获取设施信息列表,支持按楼宇ID、常驻警备公司名称、机械警备公司名称进行筛选。返回结果包含关联的楼宇名称。", "tags": ["FacilityController"], "parameters": [ { "name": "LoginName", "in": "header", "required": true, "schema": { "type": "string", "default": "admin" }, "description": "登录名" }, { "name": "AccessToken", "in": "header", "required": true, "schema": { "type": "string" }, "description": "鉴权token" }, { "name": "UserId", "in": "header", "required": true, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户ID" }, { "name": "CompanyId", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户所属企业ID" }, { "name": "LanguageType", "in": "header", "required": true, "schema": { "type": "integer", "default": 2 }, "description": "语言类型 0:中文 1:英文 2:日文" }, { "name": "UTCOffset", "in": "header", "required": true, "schema": { "type": "integer", "default": -480 }, "description": "格林威治时间与本地时间的差值,单位是分钟,比如东八区是 -480" }, { "name": "buildingId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "楼宇ID", "example": 1 }, { "name": "securityCompanyName", "in": "query", "required": false, "schema": { "type": "string" }, "description": "常驻警备公司名称(模糊匹配)", "example": "ABC" }, { "name": "machineSecurityCompany", "in": "query", "required": false, "schema": { "type": "string" }, "description": "机械警备公司名称(模糊匹配)", "example": "XYZ" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "页码" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "每页条数" } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse_FacilityPageVO" } } } }, "500": { "description": "服务器内部错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } } } } }, "/facility/add": { "post": { "summary": "新增设施信息", "description": "新增一条设施信息记录,buildingId为必填字段。日期字段格式为 yyyy-MM-dd。", "tags": ["FacilityController"], "parameters": [ { "name": "LoginName", "in": "header", "required": true, "schema": { "type": "string", "default": "admin" }, "description": "登录名" }, { "name": "AccessToken", "in": "header", "required": true, "schema": { "type": "string" }, "description": "鉴权token" }, { "name": "UserId", "in": "header", "required": true, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户ID" }, { "name": "CompanyId", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户所属企业ID" }, { "name": "LanguageType", "in": "header", "required": true, "schema": { "type": "integer", "default": 2 }, "description": "语言类型 0:中文 1:英文 2:日文" }, { "name": "UTCOffset", "in": "header", "required": true, "schema": { "type": "integer", "default": -480 }, "description": "格林威治时间与本地时间的差值,单位是分钟,比如东八区是 -480" } ], "requestBody": { "description": "设施新增参数", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityAddParam" } } } }, "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "400": { "description": "参数校验失败", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "500": { "description": "服务器内部错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } } } } }, "/facility/edit": { "post": { "summary": "编辑设施信息", "description": "编辑一条已有的设施信息记录,facilityId为必填字段。日期字段格式为 yyyy-MM-dd。", "tags": ["FacilityController"], "parameters": [ { "name": "LoginName", "in": "header", "required": true, "schema": { "type": "string", "default": "admin" }, "description": "登录名" }, { "name": "AccessToken", "in": "header", "required": true, "schema": { "type": "string" }, "description": "鉴权token" }, { "name": "UserId", "in": "header", "required": true, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户ID" }, { "name": "CompanyId", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户所属企业ID" }, { "name": "LanguageType", "in": "header", "required": true, "schema": { "type": "integer", "default": 2 }, "description": "语言类型 0:中文 1:英文 2:日文" }, { "name": "UTCOffset", "in": "header", "required": true, "schema": { "type": "integer", "default": -480 }, "description": "格林威治时间与本地时间的差值,单位是分钟,比如东八区是 -480" } ], "requestBody": { "description": "设施编辑参数", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityEditParam" } } } }, "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "400": { "description": "参数校验失败或记录不存在", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "500": { "description": "服务器内部错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } } } } }, "/facility/delete": { "post": { "summary": "批量删除设施信息", "description": "批量软删除设施信息(设置flag=1),支持逗号分隔的多个facilityId。", "tags": ["FacilityController"], "parameters": [ { "name": "LoginName", "in": "header", "required": true, "schema": { "type": "string", "default": "admin" }, "description": "登录名" }, { "name": "AccessToken", "in": "header", "required": true, "schema": { "type": "string" }, "description": "鉴权token" }, { "name": "UserId", "in": "header", "required": true, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户ID" }, { "name": "CompanyId", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 }, "description": "用户所属企业ID" }, { "name": "LanguageType", "in": "header", "required": true, "schema": { "type": "integer", "default": 2 }, "description": "语言类型 0:中文 1:英文 2:日文" }, { "name": "UTCOffset", "in": "header", "required": true, "schema": { "type": "integer", "default": -480 }, "description": "格林威治时间与本地时间的差值,单位是分钟,比如东八区是 -480" } ], "requestBody": { "description": "设施删除参数", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityDeleteParam" } } } }, "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "400": { "description": "参数校验失败", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } }, "500": { "description": "服务器内部错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleDataResponse" } } } } } } } }, "components": { "schemas": { "FacilityAddParam": { "type": "object", "required": ["buildingId"], "properties": { "buildingId": { "type": "integer", "format": "int64", "description": "楼宇ID(必填)", "example": 1 }, "securityCompanyName": { "type": "string", "maxLength": 255, "description": "常驻警备公司名称", "example": "ABC Security" }, "machineSecurityCompany": { "type": "string", "maxLength": 255, "description": "机械警备公司名称", "example": "XYZ Machine Security" }, "machineSecurityTel": { "type": "string", "maxLength": 40, "description": "机械警备联系电话", "example": "03-1234-5678" }, "machineSecurityCustomerCode": { "type": "string", "maxLength": 40, "description": "机械警备客户代码", "example": "CUST001" }, "nightShiftType": { "type": "string", "maxLength": 50, "description": "夜间体制区分", "example": "A" }, "nightGuardCount": { "type": "integer", "description": "夜间常驻人数", "example": 2 }, "securitySwitchTime": { "type": "string", "maxLength": 10, "description": "常驻→机械 切换时间(格式 HH:mm)", "example": "22:00" }, "securityPhs": { "type": "string", "maxLength": 40, "description": "警备员PHS号码", "example": "070-1234-5678" }, "mallSecurityTel": { "type": "string", "maxLength": 40, "description": "商场侧警备电话", "example": "03-8765-4321" }, "facilitySideType": { "type": "string", "maxLength": 50, "description": "商场/永旺侧区分", "example": "Mall" }, "adDirectTel": { "type": "string", "maxLength": 40, "description": "AD直通电话", "example": "03-1111-2222" }, "alarmReceptionNote": { "type": "string", "maxLength": 2000, "description": "警报接收特记", "example": "注意事项..." }, "escalationFlow": { "type": "string", "maxLength": 2000, "description": "联络流程", "example": "联络流程说明..." }, "contractStartDate": { "type": "string", "format": "date", "description": "合同开始日(格式 yyyy-MM-dd)", "example": "2024-01-01" }, "openDate": { "type": "string", "format": "date", "description": "开业日(格式 yyyy-MM-dd)", "example": "2024-04-01" }, "contractEndDate": { "type": "string", "format": "date", "description": "解约日/闭店日(格式 yyyy-MM-dd)", "example": "2025-12-31" }, "legacyAddress": { "type": "string", "maxLength": 20, "description": "旧地址", "example": "旧地址信息" }, "legacyPropertyFlag": { "type": "integer", "description": "旧物业标志 0:否 1:是", "example": 0 }, "nameChangeHistory": { "type": "string", "maxLength": 255, "description": "名称变更履历", "example": "变更履历..." }, "communicationInfo": { "type": "string", "maxLength": 255, "description": "SIM/通信线路", "example": "通信线路信息" }, "napTime": { "type": "string", "maxLength": 20, "description": "值班小睡时段", "example": "23:00-06:00" }, "noteUpdatedBy": { "type": "string", "maxLength": 128, "description": "记载者/更新日", "example": "张三" } } }, "FacilityEditParam": { "type": "object", "required": ["facilityId"], "properties": { "facilityId": { "type": "integer", "format": "int64", "description": "设施ID(必填)", "example": 1 }, "buildingId": { "type": "integer", "format": "int64", "description": "楼宇ID", "example": 1 }, "securityCompanyName": { "type": "string", "maxLength": 255, "description": "常驻警备公司名称", "example": "ABC Security" }, "machineSecurityCompany": { "type": "string", "maxLength": 255, "description": "机械警备公司名称", "example": "XYZ Machine Security" }, "machineSecurityTel": { "type": "string", "maxLength": 40, "description": "机械警备联系电话", "example": "03-1234-5678" }, "machineSecurityCustomerCode": { "type": "string", "maxLength": 40, "description": "机械警备客户代码", "example": "CUST001" }, "nightShiftType": { "type": "string", "maxLength": 50, "description": "夜间体制区分", "example": "A" }, "nightGuardCount": { "type": "integer", "description": "夜间常驻人数", "example": 2 }, "securitySwitchTime": { "type": "string", "maxLength": 10, "description": "常驻→机械 切换时间(格式 HH:mm)", "example": "22:00" }, "securityPhs": { "type": "string", "maxLength": 40, "description": "警备员PHS号码", "example": "070-1234-5678" }, "mallSecurityTel": { "type": "string", "maxLength": 40, "description": "商场侧警备电话", "example": "03-8765-4321" }, "facilitySideType": { "type": "string", "maxLength": 50, "description": "商场/永旺侧区分", "example": "Mall" }, "adDirectTel": { "type": "string", "maxLength": 40, "description": "AD直通电话", "example": "03-1111-2222" }, "alarmReceptionNote": { "type": "string", "maxLength": 2000, "description": "警报接收特记", "example": "注意事项..." }, "escalationFlow": { "type": "string", "maxLength": 2000, "description": "联络流程", "example": "联络流程说明..." }, "contractStartDate": { "type": "string", "format": "date", "description": "合同开始日(格式 yyyy-MM-dd)", "example": "2024-01-01" }, "openDate": { "type": "string", "format": "date", "description": "开业日(格式 yyyy-MM-dd)", "example": "2024-04-01" }, "contractEndDate": { "type": "string", "format": "date", "description": "解约日/闭店日(格式 yyyy-MM-dd)", "example": "2025-12-31" }, "legacyAddress": { "type": "string", "maxLength": 20, "description": "旧地址", "example": "旧地址信息" }, "legacyPropertyFlag": { "type": "integer", "description": "旧物业标志 0:否 1:是", "example": 0 }, "nameChangeHistory": { "type": "string", "maxLength": 255, "description": "名称变更履历", "example": "变更履历..." }, "communicationInfo": { "type": "string", "maxLength": 255, "description": "SIM/通信线路", "example": "通信线路信息" }, "napTime": { "type": "string", "maxLength": 20, "description": "值班小睡时段", "example": "23:00-06:00" }, "noteUpdatedBy": { "type": "string", "maxLength": 128, "description": "记载者/更新日", "example": "张三" } } }, "FacilityDeleteParam": { "type": "object", "required": ["facilityIds"], "properties": { "facilityIds": { "type": "string", "description": "设施ID,逗号分隔", "example": "1,2,3" } } }, "FacilityPageVO": { "type": "object", "properties": { "facilityId": { "type": "integer", "format": "int64", "description": "设施ID", "example": 1 }, "buildingId": { "type": "integer", "format": "int64", "description": "楼宇ID", "example": 1 }, "buildingName": { "type": "string", "description": "楼宇名称", "example": "东京建物日本桥ビル" }, "companyId": { "type": "integer", "format": "int64", "description": "企业ID", "example": 1 }, "securityCompanyName": { "type": "string", "description": "常驻警备公司名称", "example": "ABC Security" }, "machineSecurityCompany": { "type": "string", "description": "机械警备公司名称", "example": "XYZ Machine Security" }, "machineSecurityTel": { "type": "string", "description": "机械警备联系电话", "example": "03-1234-5678" }, "machineSecurityCustomerCode": { "type": "string", "description": "机械警备客户代码", "example": "CUST001" }, "nightShiftType": { "type": "string", "description": "夜间体制区分", "example": "A" }, "nightGuardCount": { "type": "integer", "description": "夜间常驻人数", "example": 2 }, "securitySwitchTime": { "type": "string", "description": "常驻→机械 切换时间", "example": "22:00" }, "securityPhs": { "type": "string", "description": "警备员PHS号码", "example": "070-1234-5678" }, "mallSecurityTel": { "type": "string", "description": "商场侧警备电话", "example": "03-8765-4321" }, "facilitySideType": { "type": "string", "description": "商场/永旺侧区分", "example": "Mall" }, "adDirectTel": { "type": "string", "description": "AD直通电话", "example": "03-1111-2222" }, "alarmReceptionNote": { "type": "string", "description": "警报接收特记", "example": "注意事项..." }, "escalationFlow": { "type": "string", "description": "联络流程", "example": "联络流程说明..." }, "contractStartDate": { "type": "string", "description": "合同开始日", "example": "2024-01-01" }, "openDate": { "type": "string", "description": "开业日", "example": "2024-04-01" }, "contractEndDate": { "type": "string", "description": "解约日/闭店日", "example": "2025-12-31" }, "legacyAddress": { "type": "string", "description": "旧地址", "example": "旧地址信息" }, "legacyPropertyFlag": { "type": "integer", "description": "旧物业标志 0:否 1:是", "example": 0 }, "nameChangeHistory": { "type": "string", "description": "名称变更履历", "example": "变更履历..." }, "communicationInfo": { "type": "string", "description": "SIM/通信线路", "example": "通信线路信息" }, "napTime": { "type": "string", "description": "值班小睡时段", "example": "23:00-06:00" }, "noteUpdatedBy": { "type": "string", "description": "记载者/更新日", "example": "张三" } } }, "SimpleDataResponse": { "type": "object", "properties": { "code": { "type": "integer", "description": "状态码,0 或 200 表示成功", "example": 0 }, "msg": { "type": "string", "description": "响应消息", "example": "success" }, "data": { "description": "响应数据(错误时为 null)" } } }, "PageInfo_FacilityPageVO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "总记录数", "example": 100 }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/FacilityPageVO" }, "description": "设施信息列表" }, "pageNum": { "type": "integer", "description": "当前页码", "example": 1 }, "pageSize": { "type": "integer", "description": "每页条数", "example": 20 }, "pages": { "type": "integer", "description": "总页数", "example": 5 } } }, "PageResponse_FacilityPageVO": { "type": "object", "properties": { "code": { "type": "integer", "description": "状态码,0 或 200 表示成功", "example": 0 }, "msg": { "type": "string", "description": "响应消息", "example": "success" }, "data": { "$ref": "#/components/schemas/PageInfo_FacilityPageVO" } } }, "PageResponse": { "type": "object", "properties": { "code": { "type": "integer", "description": "状态码", "example": 500 }, "msg": { "type": "string", "description": "响应消息", "example": "service error" }, "data": { "description": "响应数据(错误时为 null)", "nullable": true } } } } } }