レッスンAPIへのリンクの埋め込み

レッスンAPIへのリンクの埋め込み

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


説明:コース内の任意のレッスンにリンク(任意のコンテンツ教材へのリンク)を埋め込むためのものです

要求 URL:/api/v4/<orgId>/sessionMaterials.json(OrgIdの取得方法)

メソッド:POST

OAuthスコープ:TrainerCentral.sessionapi.CREATE

パラメーター

  1. {
  2. 'sessionMaterial':{
  3. 'resourceType':7,
  4. 'sessionId':'<sessionId>',
  5. 'viewType':0,
  6. 'linkTitle':'<title link>',
  7. 'linkAddress':'<link>'
  8. }
  9. }

パラメーター-説明。


1. sessionId - リンクを埋め込むレッスン(コース内)のIDです。
2. linkTitle - 埋め込みリンクのタイトルです。
3. linkAddress - 埋め込むリンクです。

4. resourceType - 埋め込みリンクの場合は7です。

埋め込みリンクのサンプルレスポンス

  1. {
  2. 'sessionMaterialSettings':
  3. [
  4. {
  5. 'sessionMaterialSettingsId':<sessionMaterialSettingId>,
  6. 'sessionMaterial':<sessionMaterialId>,
  7. 'createdTime':'1646217085987',
  8. 'id':<emberdLinkId>,
  9. 'sessionId':<sessionId>,
  10. 'value':'https://trainercentral.com',
  11. 'key':'LINK_ADDRESS',
  12. 'sessionMaterialId':<sessionMaterialId>
  13. },
  14. {
  15. 'sessionMaterialSettingsId':<sessionMaterialSettingId>,
  16. 'sessionMaterial':<sessionMaterialId>,
  17. 'createdTime':'1646217085987',
  18. 'id':<emberdLinkId>,
  19. 'sessionId':<sessionId>,
  20. 'value':'Title',
  21. 'key':'LINK_TITLE',
  22. 'sessionMaterialId':<sessionMaterialId>
  23. }
  24. ],
  25. 'sessionMaterials':
  26. [
  27. {
  28. 'session':<sessionId>,
  29. 'viewType':'0',
  30. 'topic':'title',
  31. 'sessionMaterialIndex':'0',
  32. 'time':'1646217085987',
  33. 'id':<sessionId>,
  34. 'sessionMaterialId':<sessionMaterialId>,
  35. 'resourceType':'7'
  36. }
  37. ]
  38. }