Bläddra i källkod

20221009-更新了接口说明的格式

lifuquan 2 år sedan
förälder
incheckning
9474fc3ec5
1 ändrade filer med 44 tillägg och 34 borttagningar
  1. 44 34
      doc/接口文档/domainBAPI接口说明.md

+ 44 - 34
doc/接口文档/domainBAPI接口说明.md

@@ -33,14 +33,18 @@ Content-Type: application/json
 ```
 
 ### 输出参数说明
-<table>
-    <tr><td>phoneNumber</td><td>手机号</td></tr>
-    <tr><td>isUnicomNumber</td><td>是否联通号码</td></tr>
-    <tr><td>userStatus</td><td>用户状态;1:drds 号码在用状态 且为新架构号码 2:oracle 号码在用状态 且为cBss常态化号码 3:非CB 号码在cBss系统没有路由记录 4:drds 号码失效状态 且为新架构号码 5:oracle 号码失效状态 且为cBss常态化号码</td></tr>
-    <tr><td>routeType</td><td>路由类型</td></tr>
-    <tr><td>eparchyCode</td><td>地市编码</td></tr>
-    <tr><td>provinceCode</td><td>省份编码</td></tr>
-</table>
+
+phoneNumber:手机号
+
+isUnicomNumber:是否联通号码
+
+userStatus: 用户状态;1:drds 号码在用状态 且为新架构号码 2:oracle 号码在用状态 且为cBss常态化号码 3:非CB 号码在cBss系统没有路由记录 4:drds 号码失效状态 且为新架构号码 5:oracle 号码失效状态 且为cBss常态化号码
+
+routeType:路由类型
+
+eparchyCode: 地市编码
+
+provinceCode:省份编码
 
 ## 接口2: 5GSA查询
 
@@ -71,12 +75,13 @@ Content-Type: application/json
 }
 ```
 
-### 输出参数说明
-<table>
-    <tr><td>isUnicomNumber</td><td>是否联通号码</td></tr>
-    <tr><td>isHaveSa</td><td>是否有SA服务</td></tr>
-    <tr><td>isUdmUser</td><td>是否UDM用户</td></tr>
-</table>
+### 5GSA查询接口输出参数说明
+
+isUnicomNumber: 是否联通号码
+
+isHaveSa: 是否有SA服务
+
+isUdmUser: 是否UDM用户
 
 ## 接口3: 功能查询
 
@@ -109,13 +114,15 @@ Content-Type: application/json
 
 ```
 
-### 输出参数说明
-<table>
-    <tr><td>isHebeiUnicomNumber</td><td>是否河北联通号码</td></tr>
-    <tr><td>is5gProduct</td><td>是否5g套餐</td></tr>
-    <tr><td>isHaveSa</td><td>是否开通5g</td></tr>
-    <tr><td>isHaveVolte</td><td>是否开通volte</td></tr>
-</table>
+### 功能查询接口输出参数说明
+
+isHebeiUnicomNumber: 是否河北联通号码
+
+is5gProduct: 是否5g套餐
+
+isHaveSa: 是否开通5g
+
+isHaveVolte: 是否开通volte
 
 ## 接口4:用户资料三户返回
 
@@ -140,10 +147,9 @@ Content-Type: application/json
 }
 ```
 
-### 输出参数说明
-<table>
-    <tr><td>userState</td><td>用户状态</td></tr>
-</table>
+### 用户资料三户返回输出参数说明
+
+userState: 用户状态
 
 ## 接口5:欠费接口整合
 
@@ -173,12 +179,16 @@ Content-Type: application/json
 }
 ```
 
-### 输出参数说明
-<table>
-    <tr><td>payFee</td><td>应交金额=费用合计-上次余额,应交金额&gt;=0(往月欠费+实时话费)</td></tr>
-    <tr><td>balanceFee</td><td>当前余额</td></tr>
-    <tr><td>realFee</td><td>实时话费</td></tr>
-    <tr><td>creditClass</td><td>信用等级</td></tr>
-    <tr><td>totalCreditValue</td><td>用户总信用度</td></tr>
-    <tr><td>availableCreditValue</td><td>可用额度</td></tr>
-</table>
+### 欠费接口整合输出参数说明
+
+payFee: 应交金额=费用合计-上次余额,应交金额&gt;=0(往月欠费+实时话费)
+
+balanceFee: 当前余额
+
+realFee: 实时话费
+
+creditClass: 信用等级
+
+totalCreditValue: 用户总信用度
+
+availableCreditValue: 可用额度