CourseMemberID APIの取得

CourseMemberID APIの取得

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

説明：コースメンバーの詳細一覧を取得します

要求 URL：/api/v4/<orgId>/course/<courseId>/courseMembers.json?filter=3&並べ替え=1

メソッド：GET

OAuthスコープ：TrainerCentral.courseapi.READ

パラメーター：

キー名
データ型
サンプルID
si
int
0
並べ替え
int
1
limit
int
20
searchText
String
'John'
filter
int
3

パラメーターの説明：

開始インデックス - 一覧を0または5などの別の位置から開始することを示します。
並べ替え - データを並べ替えます。
limit - 一度に取得するコースメンバー数です。デフォルトのlimit値は20です。

filter - 特定のフィルターを使用してデータを取得します。
Info
フィルター：
              TYPE = 3
並べ替え：
SORT_BY_COURSE_PROGRESS - 5
SORT_BY_TIME - 1

要求の例：
https://zylkeracademy.trainercentral.com/api/v4/{org ID}/courses { courseID}/courseMembers.json


応答の例：

  1. 'courseMembers': [
    {
    'lastLogin': '1728628131563',
    'country': 'INDIA',
    'role': '3',
    'orgId': 'TC-ORGID',
    'formattedTotalRevenue': '$104.00',
    'courseMembersId': '{COURSE_MEMBER_ID}',
    'orgMemberId': '{ORG_MEMBER_ID}',
    'imageUrl': '{IMAGE_URL}',
    'course': '{COURSE_ID}',
    'completedLesson': '0',
    'id': '{COURSE_MEMBER_ID}',
    'totalRevenue': '104.00',
    'courseId': '{COURSE_ID}',
    'メール': '{EMAIL_ID}',
    'ipAddress': '{IP_ADDRESS}',
    'userId': '{USERID}',
    'enrolledTime': '1700714216252',
    'completionPercentage': '0',
    'name': '{LEARNER_NAME}',
    'time': '1700714266048',
    'status': '50',
    'totalLesson': '3'
    }
    ],
    'meta': {
    'prospectMembersCount': '{{TOTAL_PROSPECT_COUNT_IN_COURSE}}',
    'membersCount': '{TOTAL_LEARNER_COUNT_IN_COURSE}'
    }
    }