跳到主要内容

cs.units.notifier.list

查询当前用户主体范围内的通知方，按字典决定是否必须指定关联客户。

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

请求​

RSocket.rs({
  "route" : "cs.units.notifier.list",
  "args" : {
    "search" : "搜索条件；后端固定收货人角色及主体范围",
    "pg" : "分页和排序信息"
  }
});

请求参数​

名称类型必须说明
searchObject否搜索条件；后端固定收货人角色及主体范围
search.statusString否状态
  • NORMAL - 正常
  • DISABLED - 禁用
    • search.unitIdsString[]否需要匹配的往来单位ID集合
    search.tagsString[]否标签列表，用于分类或标记
    search.contactPersonMobileString否联系人手机号
    search.needNullDataBoolean否是否需要空数据
    和relatedCustomerIds搭配使用,当relatedCustomerIds有值时
    needNullData=true表示需要查询关联客户id列表为空的数据
    needNullData=false表示不需要查询关联客户id列表为空的数据
    search.relatedCustomerIdsString[]否关联客户id列表
    search.countriesString[]否国家多选过滤列表 (对应 country 属性，如 ["US", "CN"])
    search.cityNamesString[]否城市多选过滤列表 (对应 extraProps.dock.cityName 属性)
    search.routeNamesString[]否航线多选过滤列表 (对应 extraProps.dock.tags 属性，模糊匹配 "RT:航线")
    search.isPublicBoolean否是否公开
    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"]

    返回​

    满足主体、客户关联或公开资料条件的通知方

    [ ]

    返回属性​

    名称类型说明
    unitIdString往来单位唯一ID，主键
    statusString状态
  • NORMAL - 正常
  • DISABLED - 禁用
    • nameString名称（中文）
    nameEnString名称（英文）
    abbreviationString名称缩写
    countryString国家
    countryEnString国家(英文)
    tagsString[]标签列表，用于分类或标记
    addressString地址（中文）
    addressEnString地址（英文）
    contactPersonsObject[]联系人信息列表，支持多个联系人
    contactPersons.[].usernameString用户标识
    contactPersons.[].nameString用户名称
    contactPersons.[].nameEnString英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
    contactPersons.[].mobileString用户手机号
    contactPersons.[].emailString用户邮箱
    contactPersons.[].positionString职位
    contactPersons.[].contactRolesString[]联系人承担的职责，支持多选；未指定时为空集合
  • PRIMARY - 主联系人，承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。
  • BILLING - 账单联系人，承担账单接收和账务沟通职责。
    • bankAccountsObject[]银行账户列表，支持多个账户
    bankAccounts.[].accountNameString开户名称
    bankAccounts.[].bankNameString银行名称
    bankAccounts.[].bankCodeString联行号
    bankAccounts.[].bankAccountString银行账号
    bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
    • bankAccounts.[].swiftCodeStringSWIFT CODE
    bankAccounts.[].addressString地址
    bankAccounts.[].isDefaultBoolean是否默认
    invoiceInfoObject开票信息
    invoiceInfo.companyNameString公司名称
    invoiceInfo.taxIdentificationNumberString纳税识别号
    invoiceInfo.companyAddressString公司地址
    invoiceInfo.phoneString电话
    invoiceInfo.bankAccountString银行账号
    invoiceInfo.contactString联系人
    invoiceInfo.emailString邮箱
    relatedCustomersObject[]关联客户列表
    relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
    relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    relatedCustomers.[].unitIdString往来单位唯一ID，主键
    relatedCustomers.[].nameString名称（中文）
    relatedCustomers.[].nameEnString名称（英文）
    sortWeightNumber排序权重
    isPublicBoolean是否公开
    legalEntityIdString法人主体id
    customerIdString客户id
    extraPropsObject扩展属性
    crByString创建者
    upByString最后修改者
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID
    idVaries
    dockPropsObject获取 dock 扩展属性（港口专属信息）
    当 tags 含 "dock" 时此字段才有意义
    dockTimeZoneString获取港口所在时区（如 "Asia/Shanghai"）
    用于把第三方 API 返回的港口当地时间（无时区）转 UTC Instant

    下载结果模型定义