Online Direct顧客企業の取得

GET/partners/potential-customers/{domain}

Online Direct顧客企業をパートナー顧客企業に転換するためにプラン情報を取得する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

partner
partner.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
domainstring

Online Direct ドメイン名


required
example : example.com

Query Parameters

ParameterTypeDescription
partnerCodestring

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


required
example : WSqPvhm0ON1stFBRHgW3

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required

Response

HTTP 200

OK

PropertyTypeDescription
tenantIdinteger

テナントID

domainIdinteger

ドメインID

domainstring

ドメイン名

productIdstring

商品ID

  • FR: Free
  • LT_T: Lite Trial
  • BS_T: Basic Trial
  • PRM_T: Premium Trial
  • LT: Lite
  • BS: Basic
  • PRM: Premium
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM, STD_T, ADV_T, STD, ADV
notHandledAppsarray (string)

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

Response Example

example

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

HTTP 400

Bad request

HTTP 500

Internal Server Error