Parcourir la source

添加接口文档

FanXiaoyu il y a 6 ans
Parent
commit
2c0a78ff37
1 fichiers modifiés avec 196 ajouts et 0 suppressions
  1. 196 0
      src/main/resources/documentation.md

+ 196 - 0
src/main/resources/documentation.md

@@ -0,0 +1,196 @@
+#生产商
+##查询项目下的资产[辅助服务接口]
+    http://<host>:<port>/venders-dp/manufacturer/property/query  
+post体:
+    
+    {
+        "venderId":"",      //必填,厂商id
+        "projectId":""      //必填,项目id
+    }  
+    
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "propertyId":"",                // 资产id
+                "localName":"",                 // 本地名称
+                "localId":"",                   // 本地编码
+                "brand":"",                     // 品牌
+                "product":"",                   // 产品名
+                "specification":"",             // 型号
+                "picture":"",                   // 正面照名称,根据名称去图片服务中获取
+                "platePic":"",                  // 名牌照片名称,同正面照
+                "productionDate":"",            // 生产日期
+                "serialNumber":""               // 出厂编号
+            }
+        ]        
+    }    
+
+#供应商
+##查询项目下的资产[辅助服务接口]
+    http://<host>:<port>/venders-dp/supplier/property/query    
+post体:
+    
+    {
+        "venderId":"",              // String, 必填, 维修商Id
+        "projectId":""              // String, 必填, 项目id  
+    } 
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "propertyId":"",                // 资产id
+                "localName":"",                 // 本地名称
+                "localId":"",                   // 本地编码
+                "brand":"",                     // 品牌
+                "product":"",                   // 产品名
+                "specification":"",             // 型号
+                "price":"",                     // 采购价格
+                "warranty":"",                  // 保修期
+                "productionDate":"",            // 生产日期
+                "serial number":"",             // 出厂编号
+                "contractId":""                 // 合同编号
+            }
+        ]
+    }
+    
+    {
+        "result":"failure",
+        "resultMsg":"***"
+    }             
+
+#保险商
+##获取在保资产清单[辅助服务接口]
+    http://<host>:<port>/venders-dp/insurance/project/query     
+post体:
+    
+    {
+        "vendorId":"",               //String,必填,保险商Id
+        "projectId":""               // String 必填, 数据平台项目id
+    }
+    
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "id":"**********",       // 该资产在数据平台的id
+                "infos":{
+                    "EquipLocalName":"***",                   // 本地名称(信息点均为数据平台资产的信息点)
+                    "********":"*****",          // 
+                    ......
+                }
+            },.......        
+        ]
+    }
+    
+    {
+        "result":"failure",
+        "resultMsg":"***"
+    }
+##获取所有保单列表[辅助服务接口]
+    http://<host>:<port>/venders-dp/insurance/contract/query     
+post体:
+    
+    {
+        "vendorId":"",               //String,必填,保险商Id
+        "projectId":""               //String, 必填, 项目id
+    }
+    
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "insuranceId":"***",                   // 保单Id
+                "expireDate":"*****",          // 截止日期
+                "propertyCount":10,              // 保单内资产数量
+                "insuranceFile":"****"           // 保险文件key
+            },.......        
+        ]
+    }
+    
+    {
+        "result":"failure",
+        "resultMsg":"***"
+    }
+
+##根据保单获取资产[辅助服务接口]
+    http://<host>:<port>/venders-dp/insurance/contract/property/query     
+post体:
+    
+    {
+        "venderId":"",             //String,必填,保险商Id
+        "contractId":"",              //String,必填,保单编号
+    }
+    
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "id":"****",         // 资产的id
+                "infos":{            // 信息点
+                    "EquipLocalName":"",        // 资产本地名称
+                    "EquipLocalId":"",          // 资产本地编码
+                    "Brand":"",                 // 品牌
+                    "Product":"",               // 产品名
+                    "Specification":"",         // 型号
+                }
+            },......
+        ]
+    }   
+    
+    {
+        "result":"failure",
+        "resultMsg":"***"
+    }
+    
+#维修商
+##查询指定项目内合同有效期内的资产/查询指定项目内历史维护资产[辅助服务接口]
+    http://<host>:<port>/venders-dp/maintainance/property/query
+post体:
+    
+    {
+        "venderId":"****",             // String, 必填, 维修商Id
+        "projectId":"*****",          // String, 必填, 项目id
+        "expire":true                   //Boolean, 必填. true 查询维护合同过期资产, false 查询在维护期的资产
+    }
+    
+返回:
+
+    {
+        "result":"success",
+        "resultMsg":"",
+        "content":[
+            {
+                "id":"****",                 //资产id
+                "infos":{
+                    "EquipLocalName":"",               // 本地名称
+                    "EquipLocalId":"",               // 本地编码
+                    "Brand":"",                   // 品牌
+                    "Product":"",                 // 标牌名
+                    "Specification":"",           // 型号
+                    "MaintainDeadline":"",              // 合同截止日期
+                    "MaintainPeriod":100                   // 保养周期
+                }
+            },........
+        ]
+    }
+    
+    {
+        "result":"failure",
+        "resultMsg":"***"
+    }