用户列表
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>用户注册接口</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://ip:port/requestCpsService/queryUserListByParams</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST </li>
</ul>
<h5>参数</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">qryType</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>查询类型 A:客户编号,I:智能卡号,S:机顶盒号,M:MAC((包含CM3.0,EOC,ONU,GOPN)),P:用户实例ID,L:宽带登录名,H:用户HN账号</td>
</tr>
<tr>
<td style="text-align: left;">qryValue</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>qryType对应的查询值</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>页码(默认第1页)</td>
</tr>
<tr>
<td style="text-align: left;">size</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>条数(默认20个)</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code>{
&quot;totalCount&quot; : &quot;10000&quot; ,
&quot;totalPage&quot; : &quot;50&quot; ,
&quot;userList&quot; : [{
&quot;subscriberInsId&quot; : &quot;用户实例 ID&quot; ,
&quot;custId&quot; : &quot;客户 ID&quot; ,
&quot;loginName&quot; : &quot;登陆用户名 &quot;,
&quot;userProp&quot; : &quot;用户属性 &quot;,
&quot;accessMode&quot; : &quot;接入方式 &quot;,
&quot;state&quot; : &quot;o&quot; ,
&quot;stateName&quot; : &quot;用户状态名称 &quot;,
&quot;subBillId&quot; : &quot;次计费号 &quot;,
&quot;billId&quot; : &quot;宽带用户为 cmMac&quot; ,
&quot;passwordType&quot; : &quot;密码类型 &quot;,
&quot;password&quot; : &quot;密码 &quot;,
&quot;isIns&quot; : &quot;0&quot; ,
&quot;isInProcess&quot; : &quot;1&quot; ,
&quot;mainSubscriberInsId&quot; : &quot;0&quot; ,
&quot;acctId&quot; : &quot;账户 id&quot; ,
&quot;mainSpecId&quot; : &quot;80020003&quot; ,
&quot;mainSpecName&quot; : &quot;用户规格名称 &quot;,
&quot;createDate&quot; : &quot;2023-10-24&quot; ,
&quot;devicesList&quot; : [{
&quot;resInsId&quot; : &quot;资源实例标识 &quot;,
&quot;resTypeId&quot; : &quot;资源类型标识 (大类 )&quot; ,
&quot;resTypeName&quot; : &quot;资源类型名称 (大类） &quot;,
&quot;devicesListresCode&quot; : &quot;资源编码 &quot;,
&quot;resEquNo&quot; : &quot;设备主编号 &quot;,
&quot;resEquNo2&quot; : &quot;设备次编号 &quot;,
&quot;resEquNo3&quot; : &quot;设备序列号扩展 3&quot; ,
&quot;chipId&quot; : &quot;p60 设备 chipId&quot; ,
&quot;stbMac&quot; : &quot;p60 设备 stbMac&quot; ,
&quot;resSkuId&quot; : &quot;资源类型（小类） &quot;,
&quot;resSkuName&quot; : &quot;资源型号名称（小类） &quot;,
&quot;resSubTypeId&quot; : &quot;资源类型标识 (小类 )&quot; ,
&quot;resSubTypeName&quot; : &quot;资源类型名称 (小类 )&quot; ,
&quot;resState&quot; : &quot;操作方式 &quot;,
&quot;resUseMode&quot; : &quot;资源用途 &quot;,
&quot;resInnetMode&quot; : &quot;资源来源 &quot;,
&quot;digitShareMaxNum&quot; : &quot;数字最大共享次数 &quot;,
&quot;digitUseNum&quot; : &quot;已占用数字端口数 &quot;,
&quot;bandShareMaxNum&quot; : &quot;带最大共享次数 &quot;,
&quot;bandUseNum&quot; : &quot;已占用宽带端口数 &quot;
}]
}]
}
</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th>参数</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>totalCount</td>
<td>总个数</td>
</tr>
<tr>
<td>totalPage</td>
<td>总页数</td>
</tr>
<tr>
<td>- userList</td>
<td>用户列表</td>
</tr>
<tr>
<td>- subscriberInsId</td>
<td>用户实例 ID</td>
</tr>
<tr>
<td>- custId</td>
<td>客户 ID</td>
</tr>
<tr>
<td>- loginName</td>
<td>登陆用户名</td>
</tr>
<tr>
<td>- userProp</td>
<td>用户属性</td>
</tr>
<tr>
<td>- accessMode</td>
<td>接入方式</td>
</tr>
<tr>
<td>- state</td>
<td>用户状态,0：无意义,1：正常,m：申请停机,c：预销户,d：注销,o：迁出</td>
</tr>
<tr>
<td>- stateName</td>
<td>用户状态名称</td>
</tr>
<tr>
<td>- subBillId</td>
<td>次计费号</td>
</tr>
<tr>
<td>- billId</td>
<td>计费号,数字电视用户为机顶盒;宽带用户为cmMac</td>
</tr>
<tr>
<td>- passwordType</td>
<td>密码类型</td>
</tr>
<tr>
<td>- password</td>
<td>密码</td>
</tr>
<tr>
<td>- isIns</td>
<td>用户是否转实例 1是 0否</td>
</tr>
<tr>
<td>- isInProcess</td>
<td>用户是否处理中,0正常, 1处理中</td>
</tr>
<tr>
<td>- mainSubscriberInsId</td>
<td>主用户标识,0主用户,>0副机</td>
</tr>
<tr>
<td>- acctId</td>
<td>账户 id</td>
</tr>
<tr>
<td>- mainSpecId</td>
<td>用户规格ID 80020001数字，80020003宽带</td>
</tr>
<tr>
<td>- mainSpecName</td>
<td>用户规格名称</td>
</tr>
<tr>
<td>- createDate</td>
<td>创建日期</td>
</tr>
<tr>
<td>- devicesList</td>
<td>用户资源库列表</td>
</tr>
<tr>
<td>[ - resInsId</td>
<td>资源实例标识</td>
</tr>
<tr>
<td>- resTypeId</td>
<td>资源类型标识 (大类 )</td>
</tr>
<tr>
<td>- resTypeName</td>
<td>资源类型名称 (大类）</td>
</tr>
<tr>
<td>- devicesListresCode</td>
<td>资源编码</td>
</tr>
<tr>
<td>- resEquNo</td>
<td>设备主编号</td>
</tr>
<tr>
<td>- resEquNo2</td>
<td>设备次编号</td>
</tr>
<tr>
<td>- resEquNo3</td>
<td>设备序列号扩展 3</td>
</tr>
<tr>
<td>- chipId</td>
<td>p60 设备 chipId</td>
</tr>
<tr>
<td>- stbMac</td>
<td>p60 设备 stbMac</td>
</tr>
<tr>
<td>- resSkuId</td>
<td>资源类型（小类）</td>
</tr>
<tr>
<td>- resSkuName</td>
<td>资源型号名称（小类）</td>
</tr>
<tr>
<td>- resSubTypeId</td>
<td>资源类型标识 (小类 )</td>
</tr>
<tr>
<td>- resSubTypeName</td>
<td>资源类型名称 (小类 )</td>
</tr>
<tr>
<td>- resState</td>
<td>操作方式</td>
</tr>
<tr>
<td>- resUseMode</td>
<td>资源用途</td>
</tr>
<tr>
<td>- resInnetMode</td>
<td>资源来源</td>
</tr>
<tr>
<td>- digitShareMaxNum</td>
<td>数字最大共享次数</td>
</tr>
<tr>
<td>- digitUseNum</td>
<td>已占用数字端口数</td>
</tr>
<tr>
<td>- bandShareMaxNum</td>
<td>带最大共享次数</td>
</tr>
<tr>
<td>- bandUseNum ]</td>
<td>已占用宽带端口数</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>
<p>接口名称：查询用户列表</p>
<p>接口描述：根据参数查询用户列表</p>
<p>请求地址：/requestCpsService/queryUserListByParams</p>
<p>请求方法：GET</p>
<p>请求参数：</p>
<ul>
<li>qryType：查询类型，取值为M</li>
<li>qryValue：查询值，示例值为009581129DBOA</li>
<li>page：页码，示例值为1</li>
<li>size：每页大小，示例值为20</li>
</ul>
<p>返回字段说明：</p>
<ul>
<li>status：状态码，0表示成功</li>
<li>data：返回数据对象
<ul>
<li>totalCount：总记录数，示例值为10000</li>
<li>totalPage：总页数，示例值为50</li>
<li>userList：用户列表，包含以下字段</li>
<li>subscriberInsId：用户实例ID</li>
<li>custId：客户ID</li>
<li>loginName：登录用户名</li>
<li>userProp：用户属性</li>
<li>accessMode：接入方式</li>
<li>state：用户状态</li>
<li>stateName：用户状态名称</li>
<li>subBillId：次计费号</li>
<li>billId：宽带用户为cmMac</li>
<li>passwordType：密码类型</li>
<li>password：密码</li>
<li>isIns：是否实名制</li>
<li>isInProcess：是否在办理中</li>
<li>mainSubscriberInsId：主用户实例ID</li>
<li>acctId：账户ID</li>
<li>mainSpecId：用户规格ID</li>
<li>mainSpecName：用户规格名称</li>
<li>createDate：创建日期</li>
<li>devicesList：设备列表，包含以下字段
<ul>
<li>resInsId：资源实例标识</li>
<li>resTypeId：资源类型标识（大类）</li>
<li>resTypeName：资源类型名称（大类）</li>
<li>devicesListresCode：资源编码</li>
<li>resEquNo：设备主编号</li>
<li>resEquNo2：设备次编号</li>
<li>resEquNo3：设备序列号扩展3</li>
<li>chipId：设备chipId</li>
<li>stbMac：设备stbMac</li>
<li>resSkuId：资源类型（小类）</li>
<li>resSkuName：资源型号名称（小类）</li>
<li>resSubTypeId：资源类型标识（小类）</li>
<li>resSubTypeName：资源类型名称（小类）</li>
<li>resState：操作方式</li>
<li>resUseMode：资源用途</li>
<li>resInnetMode：资源来源</li>
<li>digitShareMaxNum：数字最大共享次数</li>
<li>digitUseNum：已占用数字端口数</li>
<li>bandShareMaxNum：带最大共享次数</li>
<li>bandUseNum：已占用宽带端口数</li>
</ul></li>
</ul></li>
</ul>
<p>示例请求：</p>
<pre><code class="language-http">GET /requestCpsService/queryUserListByParams?qryType=M&amp;qryValue=009581129DBOA&amp;page=1&amp;size=20</code></pre>
<p>示例响应：</p>
<pre><code class="language-json">{
&quot;status&quot;: 0,
&quot;data&quot;: {
&quot;totalCount&quot;: 10000,
&quot;totalPage&quot;: 50,
&quot;userList&quot;: [
{
&quot;subscriberInsId&quot;: &quot;用户实例ID&quot;,
&quot;custId&quot;: &quot;客户ID&quot;,
&quot;loginName&quot;: &quot;登录用户名&quot;,
&quot;userProp&quot;: &quot;用户属性&quot;,
&quot;accessMode&quot;: &quot;接入方式&quot;,
&quot;state&quot;: &quot;o&quot;,
&quot;stateName&quot;: &quot;用户状态名称&quot;,
&quot;subBillId&quot;: &quot;次计费号&quot;,
&quot;billId&quot;: &quot;宽带用户为cmMac&quot;,
&quot;passwordType&quot;: &quot;密码类型&quot;,
&quot;password&quot;: &quot;密码&quot;,
&quot;isIns&quot;: &quot;0&quot;,
&quot;isInProcess&quot;: &quot;1&quot;,
&quot;mainSubscriberInsId&quot;: &quot;0&quot;,
&quot;acctId&quot;: &quot;账户ID&quot;,
&quot;mainSpecId&quot;: &quot;80020003&quot;,
&quot;mainSpecName&quot;: &quot;用户规格名称&quot;,
&quot;createDate&quot;: &quot;2023-10-24&quot;,
&quot;devicesList&quot;: [
{
&quot;resInsId&quot;: &quot;资源实例标识&quot;,
&quot;resTypeId&quot;: &quot;资源类型标识（大类）&quot;,
&quot;resTypeName&quot;: &quot;资源类型名称（大类）&quot;,
&quot;devicesListresCode&quot;: &quot;资源编码&quot;,
&quot;resEquNo&quot;: &quot;设备主编号&quot;,
&quot;resEquNo2&quot;: &quot;设备次编号&quot;,
&quot;resEquNo3&quot;: &quot;设备序列号扩展3&quot;,
&quot;chipId&quot;: &quot;设备chipId&quot;,
&quot;stbMac&quot;: &quot;设备stbMac&quot;,
&quot;resSkuId&quot;: &quot;资源类型（小类）&quot;,
&quot;resSkuName&quot;: &quot;资源型号名称（小类）&quot;,
&quot;resSubTypeId&quot;: &quot;资源类型标识（小类）&quot;,
&quot;resSubTypeName&quot;: &quot;资源类型名称（小类）&quot;,
&quot;resState&quot;: &quot;操作方式&quot;,
&quot;resUseMode&quot;: &quot;资源用途&quot;,
&quot;resInnetMode&quot;: &quot;资源来源&quot;,
&quot;digitShareMaxNum&quot;: &quot;数字最大共享次数&quot;,
&quot;digitUseNum&quot;: &quot;已占用数字端口数&quot;,
&quot;bandShareMaxNum&quot;: &quot;带最大共享次数&quot;,
&quot;bandUseNum&quot;: &quot;已占用宽带端口数&quot;
}
]
}
]
}
}</code></pre>