跳至主要内容

按名称查找企业

本方法用于搜索名称中包含指定字符串的所有托管企业。

参数

参数

类型

可选

描述

名称筛选器

字符串

否

需在企业名称中搜索的字符串。使用星号符号（ * ）置于关键词前以搜索名称中任意位置出现该词。若省略，则仅返回名称以关键词开头的结果。

maxResults

整数

是

指定请求返回的最大条目数。

可选值： 1 - 100 .

默认值： 25 .

返回值

本方法返回一个数组，包含符合搜索条件的公司对象。返回数组的最大长度基于 maxResults 参数。数组中每个条目具有以下结构：

  • type - 公司类型：0表示合作伙伴，1表示客户

  • name - 公司名称

  • id - 公司ID

  • address - 公司地址

  • phone - 公司电话

  • canBeManagedByAbove - 公司安全管理状态： true ，表示该安全权限是否可由上级公司管理

  • enforce2FA - 布尔值，指定所选公司用户账户是否强制启用双因素认证(2FA)

  • skip2FAPeriod - 整数值，表示用户登录时可免于提供双因素认证码的豁免期限（单位：天）

  • isSuspended - 公司账户状态： true ，表示该公司已被暂停

  • createdAt - 字符串，表示公司创建的UTC日期和时间

  • country - 字符串，表示 ISO 3166 标准格式的国家代码。若未指定代码，则该字符串值为 N/A

  • state - 字符串，表示 ISO 3166 标准格式的国家行政区划代码。若未指定代码，则该字符串值为 N/A

  • contactPerson - 包含联系人详细信息的对象：

    • fullName ，联系人的名和姓

    • email ，联系人的工作邮箱地址

    • phoneNumber ，联系人的工作电话号码

    • companyRole ，他们在公司中的职位

  • customFields - 包含公司自定义字段值的对象：

    • 自定义字段名称1 ，自定义字段值1，

    • 自定义字段名称2 ，自定义字段值2

示例

请求 : 

{
       "params": {
           "nameFilter": "测试",
           "maxResults": "100"
       },
       "jsonrpc": "2.0",
       "method": "findCompaniesByName",
       "id": "ae037403-7947-4f2b-b0b2-af190a8b44eb"
  }

响应 : 

{
      "id":"ae037403-7947-4f2b-b0b2-af190a8b44eb",
      "jsonrpc":"2.0",
      "result": [{
          "type": 1,
          "name": "测试客户",
          "id": "55191c7ab1a43d1f107b23c7",
          "address": "示例街1号",
          "phone": "0040740000001",
          "canBeManagedByAbove": true,
          "enforce2FA": true,
          "skip2FAPeriod": 1,
          "isSuspended": false,
          "createdAt": "2017-01-28T15:01:15",
          "country": "CA",
          "state": "CA-BC",
          "contactPerson": {
              "fullName": "斯蒂芬·约翰逊",
              "email": "stephen.jhonsons@example.email.com",
              "phoneNumber": "0040740000001",
              "companyRole": "所有者/总裁"
          },
          "customFields":{
              "referenceID":"004562",
              "vertical":"医疗保健",
              "partner_type":"白金",
              "security_level":"高",
              "payment_status":"良好"
          }
      },
       {
          "type": 0,
          "name": "测试合作伙伴",
          "id": "55191c5fb1a43da8107b23c6",
          "address": "示例街2号",
          "phone": "0040740000002",
          "canBeManagedByAbove": true,
          "enforce2FA": false,
          "isSuspended": false,
          "createdAt": "2017-01-28T15:01:15",
          "country": "CA",
          "state": "CA-BC",
          "country": "CA",
          "state": "CA-BC",
          "contactPerson": {
              "fullName": "斯蒂芬·约翰逊",
              "email": "stephen.jhonsons@example.email.com",
              "phoneNumber": "0040740000001",
              "companyRole": "所有者/总裁"
          },
          "customFields":{
              "referenceID":"004562",
              "vertical":"医疗保健",
              "partner_type":"白金",
              "security_level":"高",
              "payment_status":"良好"
          }
      }]
  }
本节内容 :