GET/partners/potential-customers/{domain}

Online Direct 顧客企業をパートナー顧客企業に転換するために、利用商品の情報を取得する。

注意
productId プロパティには、LINE WORKSサービスの情報のみを含みます。
productId プロパティは、将来の廃止を予定しています。
productIds プロパティには、すべてのサービスの情報を含みます。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/potential-customers/{domain}

Path Parameters

ParameterTypeDescription
domain string 

Online Direct ドメイン名


required
example : example.com 

Query Parameters

ParameterTypeDescription
partnerCode string 

Online Direct 顧客企業が発行したパートナーコード


required
example : WSqPvhm0ON1stFBRHgW3 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
tenantId integer 

テナント ID

 
domainId integer 

ドメイン ID

 
domain string 

ドメイン名

 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, STD_T, ADV_T, STD, ADV
nullable : true 
productIds array (string) 

Online Direct 顧客企業が利用している商品 ID リスト

  • LINE WORKSサービス
    • FR : フリープラン
    • STD_T : スタンダードプラントライアル
    • ADV_T : アドバンストプラントライアル
    • STD : スタンダードプラン
    • ADV : アドバンストプラン
  • LINE WORKSラジャーサービス
    • ROG_FR : フリープラン
    • ROG_STD_T : スタンダードプラントライアル
    • ROG_ADV_T : アドバンストプラントライアル
    • ROG_STD : スタンダードプラン
    • ROG_ADV : アドバンストプラン
  • LINE WORKS AiNoteサービス
    • NTA_FR : フリープラン
    • NTA_SL_T : ソロプラントライアル
    • NTA_TM_T : チームプラントライアル
    • NTA_BZ_T : ビジネスプラントライアル
    • NTA_EP_T : エンタープライズプラントライアル
    • NTA_SL : ソロプラン
    • NTA_TM : チームプラン
    • NTA_BZ : ビジネスプラン
    • NTA_EP : エンタープライズプラン
  • LINE WORKS PaperOnサービス
    • JP_PPO_LT_T : ライトプラントライアル
    • JP_PPO_STD_T : スタンダードプラントライアル
    • JP_PPO_ADV_T : アドバンストプラントライアル
    • JP_PPO_LT : ライトプラン
    • JP_PPO_STD : スタンダードプラン
    • JP_PPO_ADV : アドバンストプラン
  • LINE WORKS AiStudioサービス
    • JP_AIS_STD_T : スタンダードプラントライアル
    • JP_AIS_STD : スタンダードプラン

Allowed values : FR, STD_T, ADV_T, STD, ADV, ROG_FR, ROG_STD_T, ROG_ADV_T, ROG_STD, ROG_STD_T, NTA_FR, NTA_SL_T, NTA_TM_T, NTA_BZ_T, NTA_EP_T, NTA_SL, NTA_TM, NTA_BZ, NTA_EP, JP_PPO_LT_T, JP_PPO_STD_T, JP_PPO_ADV_T, JP_PPO_LT, JP_PPO_STD, JP_PPO_ADV, JP_AIS_STD_T, JP_AIS_STD
nullable : true 
notHandledApps array (string) 

パートナーが取り扱っていないアプリディレクトリのアプリリスト

 

Response Example

example

1{2  "tenantId": 10000001,3  "domainId": 10000001,4  "domain": "example.com",5  "productId": "FR",6  "productIds": [7    "FR",8    "ROG_FR"9  ],10  "notHandledApps": [11    "ABC app",12    "XYZ app"13  ]14}

HTTP 400

Bad request

HTTP 500

Internal Server Error