academy OrgID APIの取得

academy OrgID APIの取得

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。


TrainerCentralにログインすると、URLに数値のID（<orgId>）が表示されます。

例：https://trainercentral.com/#/portal/<orgID>/sessions/upcoming?並べ替え=1 


この<orgID>は、以下に記載されているAPIのリクエストURLで使用されます。組織プロフィールのURLをカスタマイズしている場合、URLにはorgIDの代わりにカスタマイズした名前が表示されます。すべてのポータルのURLとorgIDは、組織ポータルの表示API呼び出しのレスポンスとして返されます。

組織ポータルの表示

isDefaultパラメーターの値が「true」のorgIdが、現在有効な組織ポータルIDです。

説明：ユーザーのすべての組織ポータルの一覧を取得します。

リクエストURL：/api/v4/org/portals.json

メソッド：GET

OAuthスコープ：TrainerCentral.portalapi.READ

サンプルレスポンス

  1. {
  2. 'portals': [
  3. {
  4. 'planName': <planName>,
  5. 'isTrial': 'false',
  6. 'orgLogoUrl': <orgLogoUrl>,
  7. 'url': <url>,
  8. 'referrer': '1',
  9. 'isDefault': 'false',
  10. 'portalName': <portalName>,
  11. 'currentUserRole': '0',
  12. 'createdBy': <createdBy>,
  13. 'createdTime': '1502194325666',
  14. 'id': <orgId>,
  15. 'isLogoExists': 'false',
  16. 'zsoid': <orgId>