跳到主要内容

cs.trucking-companies.list

分页查询拖车公司列表

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

请求​

RSocket.rs({
"route" : "cs.trucking-companies.list",
"args" : {
"search" : "搜索参数",
"pg" : "分页参数"
}
});

请求参数​

名称类型必须说明
searchObject否搜索参数
search.relatedCustomerIdsString[]否关联客户ID列表
search.needNullDataBoolean否是否需要空数据
和relatedCustomerIds搭配使用
true表示需要查询关联客户id列表为空的数据
false表示不需要查询关联客户id列表为空的数据
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"]

返回​

拖车公司列表

[ ]

返回属性​

名称类型说明
companyIdString拖车公司ID,主键
dispatchersObject[]
dispatchers.[].enableBoolean是否启用,默认启用
dispatchers.[].registeredBoolean是否注册
dispatchers.[].registrationTimeString注册时间
dispatchers.[].usernameString用户标识
dispatchers.[].nameString用户名称
dispatchers.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
dispatchers.[].mobileString用户手机号
dispatchers.[].emailString用户邮箱
dispatchers.[].positionString职位
dispatchers.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • driversObject[]
    drivers.[].enableBoolean是否启用,默认启用
    drivers.[].registeredBoolean是否注册
    drivers.[].registrationTimeString注册时间
    drivers.[].temporaryBoolean是否为临时车
    drivers.[].idNumberString身份证号
    drivers.[].licensePlateObject车牌信息
    drivers.[].licensePlate.mainlandString大陆车牌号
    drivers.[].licensePlate.hkString香港车牌号
    drivers.[].licensePlate.macaoString澳门车牌号
    drivers.[].licensePlate.trailerPlateString挂车号
    drivers.[].usernameString用户标识
    drivers.[].nameString用户名称
    drivers.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    drivers.[].mobileString用户手机号
    drivers.[].emailString用户邮箱
    drivers.[].positionString职位
    drivers.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • countryString国家
    countryEnString国家(英文)
    nameString名称(中文)
    nameEnString名称(英文)
    abbreviationString名称缩写
    addressString地址(中文)
    addressEnString地址(英文)
    contactPersonsObject[]联系人信息列表
    contactPersons.[].usernameString用户标识
    contactPersons.[].nameString用户名称
    contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    contactPersons.[].mobileString用户手机号
    contactPersons.[].emailString用户邮箱
    contactPersons.[].positionString职位
    contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • relatedCustomersString[]关联客户ID列表
    legalEntityIdString法人主体id
    customerIdString客户id
    extraPropsObject扩展属性
    crByString创建者
    upByString最后修改者
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID
    idString

    下载结果模型定义