レッスンAPIの作成

レッスンAPIの作成

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


説明:アカデミー内のコース配下にレッスンを作成します。

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

メソッド:POST

OAuthスコープTrainerCentral.sessionapi.CREATE


オンデマンドレッスン作成用パラメーター


  1. {
  2. 'session':{
  3. 'name':'<session name>',
  4. 'courseId':'<courseId>',
  5. 'sectionId':'<sectionId>',
  6. 'deliveryMode':4
  7. }
  8. }

パラメーターの説明


1. name - レッスンの名前(オンデマンドまたはライブ)
2. courseId - レッスンを作成するコースのID。
3. sectionId - セッションを作成するチャプターのID。
4. deliveryMode - オンデマンドセッションの場合は4、ライブセッションの場合は3です。
5. scheduledTime - ライブレッスンの開始予定時刻(ミリ秒)。
6. scheduledEndTime - ライブレッスンの終了予定時刻(ミリ秒)。

7. timezone - 上記の開始/終了時刻に設定されているタイムゾーン。

 

オンデマンドレッスンのサンプル応答

  1. {
  2. 'ticketsInfo':
  3. {
  4. 'tickets':
  5. {
  6. 'session':<sessionId>,
  7. 'maximumPurchaseLimit':'1',
  8. 'paymentOrgId':<paymentOrgId>,
  9. '説明':<説明>,
  10. 'orgId':<orgId>,
  11. 'frequency':'1',
  12. 'paymentType':'0',
  13. 'createdTime':'1646208424732',
  14. 'lastUpdatedTime':'1646208424732',
  • 'id':<sessionId>,
  • 'deletedTime':'-1',
  • 'expiryDurationType':'0',
  • 'lastUpdatedBy':<userId>,
  • 'amount':'0.0',
  • 'isTaxable':'false',
  • 'ticketType':'0',
  • 'sessionId':<sessionId>,
  • 'isDefault':'true',
  • 'createdBy':<userId>,
  • 'billingCycle':'-1',
  • 'frequencyType':'-1',
  • 'name':<sessionName>,
  • 'expiryDuration':'0',
  • 'ticketId':<sessionTicketId>,
  • 'status':'1'
  • }
  • },
  • 'sessionMembers':
  • [
  • {
  • 'country':'us',
  • 'role':'1',
  • 'encryptedSessionMemberId':<encrytpedSessionMemberId>,
  • 'session':<sessionId>,
  • 'sessionMemberId':<sessionMemberId>,
  • 'language':'en',
  • 'emailId':<userEmail>,
  • 'sessionId':<sessionId>,
  • 'presenterImageUrl':<presenterImageURL>,
  • 'userId':<userId>,
  • 'orgId':<orgId>,
  • 'name':<userName>,
  • 'createdTime':'1646208424693',
  • 'time':'1646208424693',
  • 'id':<sessionMemberId>
  • }
  • ],
  • 'session':
  • {
  • 'sessionIndex':'0',
  • 'timezone':<usertimezoneSet>,
  • 'attendeeLimit':<attendeeLimit>,
  • 'createdbyName':<userName>,
  • 'orgId':<orgId>,
  • 'protoFlag':'1',
  • 'recurringType':'0',
  • 'deliveryMode':'4',
  • 'sessionType':'1',
  • 'course':<courseId>,
  • 'createdTime':'1646208424680',
  • 'scheduledBy':<userId>,
  • 'id':<id>,
  • 'joinURL':<session join url>,
  • 'deletedTime':'-1',
  • 'courseId':<courseId>,
  • 'registeredCount':'0',
  • 'invitedCount':'0',
  • 'orgName':<orgName>,
  • 'scheduledTime':'1646208424676',
  • 'presenterAutoStartUrl':<presenterAutoStartURL>,
  • 'presenterUrl':<presenterURL>,
  • 'uniqueKey':<UniqueKey>,
  • 'sessionId':<sessionId>,
  • 'attendedCount':'0',
  • 'paymentsHomePageURL':<paymentsURL>,
  • 'referrer':'1',
  • 'scheduleType':'0',
  • 'createdBy':<userId>,
  • 'name':'<sessionName>,
  • 'zaid':<zaid>,
  • 'memberRole':'2'
  • },
  • 'talks':
  • [
  • {
  • 'owner':<userId>,
  • 'scheduledTime':'1646208424676',
  • 'deliveryMode':'4',
  • 'session':<sessionId>,
  • 'sessionType':'1',
  • 'id':<sessionId>,
  • 'sessionId':<sessionId>,
  • 'talkId':<talkId>,
  • 'orgId':<orgId>,
  • 'status':'1',
  • 'registeredCount':'0'
  • }
  • ],
  • 'sessionCategories':[]
  • }
  •  

    コース内のライブレッスン作成用パラメーター

    1. {
    2. 'session':
    3. {
    4. 'name':<sessionName>,
    5. 'scheduledTime':<session Start time>,
    6. 'scheduledEndTime':<session end time>,
    7. 'deliveryMode':3,
    8. 'timezone':'Asia/Calcutta',
    9. '説明':<session 説明>,
    10. 'courseId':'<courseId>',
    11. 'sectionId':'<sectionId>',
    12. 'sessionSettings':
    13. {
    14. 'enableClientLogin':true,
    15. 'recurringType':0
    16. }
    17. }
    18. }

    コース内で開催されるライブレッスンのサンプルレスポンス

    1. {
    2. 'ticketsInfo':
    3. {
    4. 'tickets':
    5. {
    6. 'session':<sessionId>,
    7. 'maximumPurchaseLimit':'1',
    8. 'paymentOrgId':<paymentsOrgId>,
    9. '説明':<説明>,
    10. 'orgId':<orgId>,
    11. 'frequency':'1',
    12. 'paymentType':'0',
    13. 'createdTime':'1646210370550',
    14. 'lastUpdatedTime':'1646210370550',
    15. 'id':'<ticketId>',
    16. 'deletedTime':'-1',
    17. 'expiryDurationType':'0',
    18. 'lastUpdatedBy':<userId>,
    19. 'amount':'0.0',
    20. 'isTaxable':'false',
    21. 'ticketType':'0',
    22. 'sessionId':<sessionId>,
    23. 'isDefault':'true',
    24. 'createdBy':<userId>,
    25. 'billingCycle':'-1',
    26. 'frequencyType':'-1',
    27. 'name':'<session name>,
    28. 'expiryDuration':'0',
    29. 'ticketId':<ticketId>,
    30. 'status':'1'
    31. }
    32. },
    33. 'sessionMembers':
    34. [
    35. {
    36. 'country':'us',
    37. 'role':'1',
  • 'encryptedSessionMemberId':<encryptedSessionMemberId>,
  • 'session':<sessionId>,
  • 'sessionMemberId':<sessionMemberId>,
  • 'language':'en',
  • 'emailId':<userEmaild>,
  • 'sessionId':<sessionId>,
  • 'presenterImageUrl':<userImageURL>,
  • 'userId':<userId>,
  • 'orgId':<orgId>,
  • 'name':<userName>,
  • 'createdTime':'1646210370523',
  • 'time':'1646210370523',
  • 'id':<sessionMemberId>
  • }
  • ],
  • 'session':
  • {
  • 'sessionIndex':'0',
  • 'timezone':<userTimeZoneSet>,
  • '説明':<説明>,
  • 'attendeeLimit':'100',
  • 'createdbyName':<userName>,
  • 'orgId':<orgId>,
  • 'protoFlag':'1',
  • 'recurringType':'0',
  • 'descriptionId':<descriptionId>,
  • 'deliveryMode':'3',
  • 'sessionType':'1',
  • 'course':<courseId>,
  • 'createdTime':'1646210370510',
  • 'scheduledBy':<userId>,
  • 'id':'<sessionId>,
  • 'joinURL':<joinURL>,
  • 'deletedTime':'-1',
  • 'courseId':<courseId>,
  • 'registeredCount':'0',
  • 'invitedCount':'0',
  • 'orgName':<orgName>,
  • 'scheduledTime':'1646210400000',
  • 'presenterAutoStartUrl':<presenterAutoStartUrl>,
  • 'presenterUrl':<presenterURL>,
  • 'uniqueKey':<uniqueKey>,
  • 'scheduledEndTime':'1646214000000',
  • 'sessionId':<sessionId>,
  • 'attendedCount':'0',
  • 'paymentsHomePageURL':<paymentsURL>,
  • 'referrer':'1',
  • 'scheduleType':'0',
  • 'createdBy':<userId>,
  • 'name':<sessionName>,
  • 'zaid':<zaid>,
  • 'memberRole':'2'
  • },
  • 'talks':
  • [
  • {
  • 'owner':<userId>,
  • 'scheduledTime':'1646210400000',
  • 'deliveryMode':'3',
  • 'session':<sessionId>,
  • 'scheduledEndTime':'1646214000000',
  • 'sessionType':'1',
  • 'id':<talkId>,
  • 'sessionId':<sessionId>,
  • 'talkId':<talkId>,
  • 'orgId':<orgId>,
  • 'status':'1',
  • 'registeredCount':'0'
  • }
  • ],
  • 'sessionCategories':[]
  • }
  •