跳到主要内容

cs.users.list

分页查询用户列表

  • 请求路由: cs.users.list
  • 交互模型: Request Stream
  • 访问限制: 无

请求​

RSocket.rs({
  "route" : "cs.users.list",
  "args" : {
    "search" : "查询条件",
    "pg" : "分页参数"
  }
});

请求参数​

名称类型必须说明
searchObject否查询条件
search.usernamesString[]否用户名
search.userTypesNumber[]否用户类型列表
100-后台用户
1-司机
2-调度
3-交单员
4-库管员
5-互联网用户
search.tagsString[]否标签
search.legalEntityIdsString[]否法人主体id
search.customerIdString否客户id
search.keywordString否模糊匹配关键字
search.fromString否查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
search.toString否查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
pgObject否分页参数
pg.pageNumber否页码，首页从0开始
pg.sizeNumber否每页记录，默认为10
pg.sortString[]否排序字段清单，默认为升序，需要指定降序时在字段名后面添加desc并用分号隔开。
例如：["id", "crDate;desc"]

返回​

用户列表

[ ]

返回属性​

名称类型说明
usernameString唯一标识
fullnameString姓名
nameEnString英文名称
passwordString密码
statusNumber状态
0-禁用
1-启用
mobileString手机号
emailString邮箱
genderNumber性别
0-不详
1-男
2-女
inviteCodeString邀请码
userTypesNumber[]用户类型列表
100-后台用户
1-司机
2-调度
3-交单员
4-库管员
5-互联网用户
tagsString[]标签
customer-[id] - 客户往来单位ID
factory-[id] - 工厂往来单位ID
warehouse-[id] - 仓库ID
keeper-[id] - 工厂往来单位ID(库管员)
documenter-[id] - 工厂往来单位ID(交单员)
driverInfoObject用户司机信息
driverInfo.idNumberString身份证号
driverInfo.licensePlateObject车牌信息
driverInfo.licensePlate.mainlandString大陆车牌号
driverInfo.licensePlate.hkString香港车牌号
driverInfo.licensePlate.macaoString澳门车牌号
driverInfo.licensePlate.trailerPlateString挂车号
driverInfo.truckingCompanyIdString拖车公司(往来单位id)
driverInfo.truckingCompanyInfoObject拖车公司信息
driverInfo.truckingCompanyInfo.countryString国家
driverInfo.truckingCompanyInfo.countryEnString国家(英文)
driverInfo.truckingCompanyInfo.abbreviationString名称缩写
driverInfo.truckingCompanyInfo.addressString地址（中文）
driverInfo.truckingCompanyInfo.addressEnString地址（英文）
driverInfo.truckingCompanyInfo.contactPersonsObject[]联系人信息列表，支持多个联系人
driverInfo.truckingCompanyInfo.contactPersons.[].usernameString用户标识
driverInfo.truckingCompanyInfo.contactPersons.[].nameString用户名称
driverInfo.truckingCompanyInfo.contactPersons.[].nameEnString英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
driverInfo.truckingCompanyInfo.contactPersons.[].mobileString用户手机号
driverInfo.truckingCompanyInfo.contactPersons.[].emailString用户邮箱
driverInfo.truckingCompanyInfo.contactPersons.[].positionString职位
driverInfo.truckingCompanyInfo.contactPersons.[].contactRolesString[]联系人承担的职责，支持多选；未指定时为空集合
  • PRIMARY - 主联系人，承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。
  • BILLING - 账单联系人，承担账单接收和账务沟通职责。
    • driverInfo.truckingCompanyInfo.bankAccountsObject[]银行账户列表，支持多个账户
    driverInfo.truckingCompanyInfo.bankAccounts.[].accountNameString开户名称
    driverInfo.truckingCompanyInfo.bankAccounts.[].bankNameString银行名称
    driverInfo.truckingCompanyInfo.bankAccounts.[].bankCodeString联行号
    driverInfo.truckingCompanyInfo.bankAccounts.[].bankAccountString银行账号
    driverInfo.truckingCompanyInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
    • driverInfo.truckingCompanyInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    driverInfo.truckingCompanyInfo.bankAccounts.[].addressString地址
    driverInfo.truckingCompanyInfo.bankAccounts.[].isDefaultBoolean是否默认
    driverInfo.truckingCompanyInfo.invoiceInfoObject开票信息
    driverInfo.truckingCompanyInfo.invoiceInfo.companyNameString公司名称
    driverInfo.truckingCompanyInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    driverInfo.truckingCompanyInfo.invoiceInfo.companyAddressString公司地址
    driverInfo.truckingCompanyInfo.invoiceInfo.phoneString电话
    driverInfo.truckingCompanyInfo.invoiceInfo.bankAccountString银行账号
    driverInfo.truckingCompanyInfo.invoiceInfo.contactString联系人
    driverInfo.truckingCompanyInfo.invoiceInfo.emailString邮箱
    driverInfo.truckingCompanyInfo.extraPropsObject扩展信息
    driverInfo.truckingCompanyInfo.relatedCustomersObject[]关联客户列表
    driverInfo.truckingCompanyInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
    driverInfo.truckingCompanyInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    driverInfo.truckingCompanyInfo.relatedCustomers.[].unitIdString往来单位唯一ID，主键
    driverInfo.truckingCompanyInfo.relatedCustomers.[].nameString名称（中文）
    driverInfo.truckingCompanyInfo.relatedCustomers.[].nameEnString名称（英文）
    driverInfo.truckingCompanyInfo.unitIdString往来单位唯一ID，主键
    driverInfo.truckingCompanyInfo.nameString名称（中文）
    driverInfo.truckingCompanyInfo.nameEnString名称（英文）
    dispatcherInfoObject用户调度信息
    dispatcherInfo.truckingCompanyIdString拖车公司(往来单位id)
    dispatcherInfo.truckingCompanyInfoObject拖车公司信息
    dispatcherInfo.truckingCompanyInfo.countryString国家
    dispatcherInfo.truckingCompanyInfo.countryEnString国家(英文)
    dispatcherInfo.truckingCompanyInfo.abbreviationString名称缩写
    dispatcherInfo.truckingCompanyInfo.addressString地址（中文）
    dispatcherInfo.truckingCompanyInfo.addressEnString地址（英文）
    dispatcherInfo.truckingCompanyInfo.contactPersonsObject[]联系人信息列表，支持多个联系人
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].usernameString用户标识
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].nameString用户名称
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].nameEnString英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].mobileString用户手机号
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].emailString用户邮箱
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].positionString职位
    dispatcherInfo.truckingCompanyInfo.contactPersons.[].contactRolesString[]联系人承担的职责，支持多选；未指定时为空集合
  • PRIMARY - 主联系人，承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。
  • BILLING - 账单联系人，承担账单接收和账务沟通职责。
    • dispatcherInfo.truckingCompanyInfo.bankAccountsObject[]银行账户列表，支持多个账户
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].accountNameString开户名称
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].bankNameString银行名称
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].bankCodeString联行号
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].bankAccountString银行账号
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
    • dispatcherInfo.truckingCompanyInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].addressString地址
    dispatcherInfo.truckingCompanyInfo.bankAccounts.[].isDefaultBoolean是否默认
    dispatcherInfo.truckingCompanyInfo.invoiceInfoObject开票信息
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.companyNameString公司名称
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.companyAddressString公司地址
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.phoneString电话
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.bankAccountString银行账号
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.contactString联系人
    dispatcherInfo.truckingCompanyInfo.invoiceInfo.emailString邮箱
    dispatcherInfo.truckingCompanyInfo.extraPropsObject扩展信息
    dispatcherInfo.truckingCompanyInfo.relatedCustomersObject[]关联客户列表
    dispatcherInfo.truckingCompanyInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
    dispatcherInfo.truckingCompanyInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    dispatcherInfo.truckingCompanyInfo.relatedCustomers.[].unitIdString往来单位唯一ID，主键
    dispatcherInfo.truckingCompanyInfo.relatedCustomers.[].nameString名称（中文）
    dispatcherInfo.truckingCompanyInfo.relatedCustomers.[].nameEnString名称（英文）
    dispatcherInfo.truckingCompanyInfo.unitIdString往来单位唯一ID，主键
    dispatcherInfo.truckingCompanyInfo.nameString名称（中文）
    dispatcherInfo.truckingCompanyInfo.nameEnString名称（英文）
    departmentObject用户所属部门
    department.idString部门标识。
    department.nameString部门名称。
    legalEntityIdString法人主体id
    customerIdString客户id
    extraPropsObject扩展属性
    crByString创建者
    upByString最后修改者
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID
    idVaries以账号作为用户业务主键，保持与 MongoDB 用户标识一致。
    defaultUserTypesNumber[]获取可修改的用户类型集合，未设置或没有元素时初始化为空集合并保存到当前用户。

    下载结果模型定义