割り当て対象ユーザー一覧
PATCHhttps://manabeat.com/{site_id}/mana_apis/assigned_user_list/{course_id}指定した科目の割り当て対象ユーザー一覧情報を取得します。
パスパラメータ
サイトID
科目ID
リクエストボディ
true: 対象ユーザー数のみ取得。false: 一覧情報を取得。指定科目の複数割り当てに該当するユーザーが存在する場合は重複して取得。
昇順/降順。["asc", "desc"]から選択。デフォルト："asc"
一覧情報をソートする項目。["id", "login", "name", "lecture_setting_id", "lectue_setting_name"]から選択。デフォルト："id"
一覧情報の取得単位。デフォルト及び上限値：1,000
perで区切られた一覧情報のインデックス。デフォルト：1
割り当てIDによる絞り込み。
レスポンスボディ
割り当て対象ユーザー数。get_count: true 時に返却。
一覧のインデックス情報。current: 現在値, max: 上限値
リストの取得単位
割り当て対象ユーザー情報。ユーザーID, ログインID, ユーザー名, 科目受講ステータス, 割り当てID, 割り当て条件名を取得。
エラーレスポンス
リクエストURL、パスパラメータを確認してください。
リクエストヘッダー情報を確認してください。
リクエストボディの読み込みに失敗しました。送信データを確認してください。
メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
一覧情報取得に必須のパラメータが不足しています。
APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
IPアドレス制限によってリクエストが制限されています。
送信できるリクエストボディのサイズは100KBです。
1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
システム内部でエラーが発生しました。時間をおいて再度お試しください。
現在システム全体のメンテナンス中です。終了までお待ちください。
リクエストボディ例
{
"get_count": false,
"sort": "login",
"page": 2,
"lecture_setting_id": 999999
}