すべてのコースのAPI表示

すべてのコースのAPI表示

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

説明：アカデミー内のすべてのコース一覧を取得します。


リクエストURL：/api/v4/<orgId>/courses.json?limit=<Number of courses fetched in this instance>&si=<Start index>
（<orgId>の確認方法）

メソッド：GET
OAuthスコープ：TrainerCentral.courseapi.READ

サンプルリクエスト：https://zylkeracademy.trainercentral.com/api/v4/100000000/courses.json?limit=20&si=0

初期設定では、一覧には15件のコースのみが表示されます。さらに多くのコースを表示する場合は、上記のようにリクエストURLのlimitを増やします。
  1. Limit- 1回の実行で取得するコース数です。

  2. Start index- 一覧の開始位置を示します。0、または5などの別の位置を指定できます。

サンプルレスポンス

  1. {

    'courses': [

    {

    'isHiddenCourse': 'false',

    'includeAllRecurringTalkInMandation': 'false',

    '説明': '<Course 説明>',

    'courseURL': 'https://<your domain>/course/<course unique key>',

    'isPaidActiveTicketAvailable': 'false',

    'type': '0',

    'orgId': '<orgId>',

    'formattedTotalRevenue': 'Rs.0',

    'isFeaturedCourse': 'false',

    'enableReview': 'true',

    'descriptionId': '<descriptionId>',

    'subTitle': 'Course subtitle',

    'excludeLiveLessonsInMandation': 'false',

    'lastUpdatedTime': '1643268420051',

    'links': {

    'sessions': '/api/v4/<orgId>/course/<courseId>/sessions.json',

    'site': '/api/v4/<orgId>/course/<courseId>/site.json',

    'tickets': '/api/v4/<orgId>/course/<courseId>/tickets.json',

    'assignments': '/api/v4/<orgId>/course/<courseId>/assignments.json',

    'certificates': '/api/v4/<orgId>/course/<courseId>/certificates.json',

    'siteSettings': '/api/v4/<orgId>/course/<courseId>/siteSettings.json',

    'reviews': '/api/v4/<orgId>/course/<courseId>/reviews.json',

    'coupons': '/api/v4/<orgId>/coupons.json',

    'paymentPortals': '/api/v4/<orgId>/paymentPortals.json',

    'courseMembers': '/api/v4/<orgId>/course/<courseId>/courseMembers.json',

    'drips': '/api/v4/<orgId>/course/<courseId>/drips.json',

    'sections': '/api/v4/<orgId>/course/<courseId>/sections.json'

    },

    'id': '<courseId>',

    'testCompletionEnabled': 'false',

    'totalRevenue': '0.0',

    'courseId': '<courseId>',

    'publishStatus': '1',

    'lastUpdatedBy': '<userId>',

    'scheduledTime': '0',

    'materialCompletionEnabled': 'false',

    'kind': '0',

    'uniqueKey': '<course unique key>',

    'totalRating': '0',

'excludeLiveLessonsInCompletion': 'false',

'courseName': '<course name>',

'materialCompletionPercentage': '0',

'scheduleType': '0',

'createdBy': '<userId>',

'mandateLessonOrder': 'false',

'enrolledCount': '1',

'time': '1642742957817',

'isPrivateCourse': 'false'

}

],

'courseCategories': [

{

'moduleCategoryMappingId': '<moduleCategoryMappingId>',

'moduleType': '1',

'course': '<courseId>',

'id': '<moduleCategoryMappingId>',

'moduleId': '<moduleId>',

'category': '<categoryId>',

'categoryId': '<categoryId>'

}

],

'meta': {

'totalCourseCount': '<totalCourseCount>',

'selectedCourseCount': '<selectedFilterCourseCount>'

},

'courseMembers': [

{

'role': '0', ADMIN = 0, SPEAKER = 1, ATTENDEE= 3, PREVIEWER =4

'userId': '<userId>',

'orgId': '<orgId>',

'completionPercentage': '0',

'courseMembersId': '3273311000000323004',

'imageUrl': '/api/v4/<orgId>/materials/image/<imageId>.json',

'name': 'コースメンバー名',

'course': '<courseId>',

'time': '1642742957821',

'id': '<course member Id>',

'courseId': '<courseId>',

'メール': '<userEmail>',

'status': '0'

}

]

}