PMS


用户列表

[TOC]

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

接口名称：查询用户列表

接口描述：根据参数查询用户列表

请求地址：/requestCpsService/queryUserListByParams

请求方法：GET

请求参数：

  • qryType：查询类型，取值为M
  • qryValue：查询值，示例值为009581129DBOA
  • page：页码，示例值为1
  • size：每页大小，示例值为20

返回字段说明：

  • status：状态码，0表示成功
  • data：返回数据对象
    • totalCount：总记录数，示例值为10000
    • totalPage：总页数，示例值为50
    • userList：用户列表，包含以下字段
    • subscriberInsId：用户实例ID
    • custId：客户ID
    • loginName：登录用户名
    • userProp：用户属性
    • accessMode：接入方式
    • state：用户状态
    • stateName：用户状态名称
    • subBillId：次计费号
    • billId：宽带用户为cmMac
    • passwordType：密码类型
    • password：密码
    • isIns：是否实名制
    • isInProcess：是否在办理中
    • mainSubscriberInsId：主用户实例ID
    • acctId：账户ID
    • mainSpecId：用户规格ID
    • mainSpecName：用户规格名称
    • createDate：创建日期
    • devicesList：设备列表，包含以下字段
      • resInsId：资源实例标识
      • resTypeId：资源类型标识（大类）
      • resTypeName：资源类型名称（大类）
      • devicesListresCode：资源编码
      • resEquNo：设备主编号
      • resEquNo2：设备次编号
      • resEquNo3：设备序列号扩展3
      • chipId：设备chipId
      • stbMac：设备stbMac
      • resSkuId：资源类型（小类）
      • resSkuName：资源型号名称（小类）
      • resSubTypeId：资源类型标识（小类）
      • resSubTypeName：资源类型名称（小类）
      • resState：操作方式
      • resUseMode：资源用途
      • resInnetMode：资源来源
      • digitShareMaxNum：数字最大共享次数
      • digitUseNum：已占用数字端口数
      • bandShareMaxNum：带最大共享次数
      • bandUseNum：已占用宽带端口数

示例请求：

GET /requestCpsService/queryUserListByParams?qryType=M&qryValue=009581129DBOA&page=1&size=20

示例响应：

{
  "status": 0,
  "data": {
    "totalCount": 10000,
    "totalPage": 50,
    "userList": [
      {
        "subscriberInsId": "用户实例ID",
        "custId": "客户ID",
        "loginName": "登录用户名",
        "userProp": "用户属性",
        "accessMode": "接入方式",
        "state": "o",
        "stateName": "用户状态名称",
        "subBillId": "次计费号",
        "billId": "宽带用户为cmMac",
        "passwordType": "密码类型",
        "password": "密码",
        "isIns": "0",
        "isInProcess": "1",
        "mainSubscriberInsId": "0",
        "acctId": "账户ID",
        "mainSpecId": "80020003",
        "mainSpecName": "用户规格名称",
        "createDate": "2023-10-24",
        "devicesList": [
          {
            "resInsId": "资源实例标识",
            "resTypeId": "资源类型标识（大类）",
            "resTypeName": "资源类型名称（大类）",
            "devicesListresCode": "资源编码",
            "resEquNo": "设备主编号",
            "resEquNo2": "设备次编号",
            "resEquNo3": "设备序列号扩展3",
            "chipId": "设备chipId",
            "stbMac": "设备stbMac",
            "resSkuId": "资源类型（小类）",
            "resSkuName": "资源型号名称（小类）",
            "resSubTypeId": "资源类型标识（小类）",
            "resSubTypeName": "资源类型名称（小类）",
            "resState": "操作方式",
            "resUseMode": "资源用途",
            "resInnetMode": "资源来源",
            "digitShareMaxNum": "数字最大共享次数",
            "digitUseNum": "已占用数字端口数",
            "bandShareMaxNum": "带最大共享次数",
            "bandUseNum": "已占用宽带端口数"
          }
        ]
      }
    ]
  }
}

页面列表

ITEM_HTML