12.5 API リファレンス – 学び～と｜マニュアル

学び～と｜マニュアル

学び～との操作方法や、教材作成の流れを学べます。

12.5 API リファレンス

  • 管理者
  • 基本機能

API基本情報

認証情報

  • 管理サイトで発行したAPIキーをリクエストヘッダーに設定します。詳細は各API情報を参照ください。
  • APIキーの発行方法についてはAPI管理からご確認いただけます。
  • APIキーの発行・利用共にサイト管理者の権限を持つユーザーのみ可能です。
  • ログイン出来ない状態（無効、仮登録、有効期間外等）のユーザーが保有するAPIキーは利用できません。

リクエスト制限

  • 一度に送信可能なリクエストボディのサイズ上限は100KBまでです。
  • ご利用のサイト全体で1時間あたり5000回までリクエストを受け付けます。
  • 認証に失敗したリクエストはカウントされず、API利用ログにも記録されません。
  • 5000回を超えた場合APIリクエストに制限がかかるため、次の00分まで時間を空けてから再度実行してください。

ユーザー管理

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: ユーザー数のみ取得。false: 一覧情報を取得。
order enum 昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort enum 一覧情報をソートする項目。[“id”, “login”, “last_name”, “first_name”]から選択。デフォルト：”login”
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： ログインID, 姓, 名
group_codes [string] グループコードによる絞り込み。複数値でOR検索が可能。
properties [string] 属性名による絞り込み。複数値でOR検索が可能。
status enum ユーザーステータス（無効/仮登録/アカウントロック）による絞り込み。[“invalid_flag”, “temporary_user_flag”, “locked”]から選択。
*face_approved boolean 顔情報承認状況による絞り込み。true: 顔情報承認済み
*オプション利用中のみ
リクエストボディ例 
{
"get_count": false,
"sort": "id",
"page": 2,
"keyword": ["学習"]
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得ユーザー数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
users [{
id: integer,
login: string,
last_name: string,
first_name: string
}]		 ユーザーリスト。ユーザーID, ログインID, 姓, 名 を取得
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
user_id [必須] string ユーザーID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer ユーザーID
*face string 顔情報認証状況
login string ログインID
last_name string 姓
first_name string 名
last_name_kana string 姓（カナ）
first_name_kana string 名（カナ）
email string メールアドレス
email2 string メールアドレス（サブ）
valid_start_date string 有効開始日
valid_end_date string 有効終了日
role string 権限名
groups [{group_code: string, name: string}] グループ（グループコード, グループ名）
properties [string] 属性名
invalid_flag boolean 無効
temporary_user_flag boolean 仮登録
language string 使用言語
note string 備考
*saml_idps [string] SAML認証用ユーザーID
creator string 登録者
created_at string 登録日時
updater string 更新者
updated_at string 更新日時
*オプション利用中のみ
レスポンスボディ例 
{
"id": 123456789,
"face": "approved",
"login": "example001",
"last_name": "学習",
"first_name": "太郎",
"last_name_kana": "ガクシュウ",
"first_name_kana": "タロウ",
"email": "api1@example.com",
"email2": "api2@example.com",
"valid_start_date": "2024-09-01",
"valid_end_date": "2027-08-31",
"role": "受講者（student）",
"groups":[
{
"group_code": "english",
"name": "英語専攻"
}
],
"properties":[
"生徒", "1年生"
],
"invalid_flag": null,
"temporary_user_flag": true,
"language": "英語 (English)",
"note": "備考欄",
"saml_idps":[
"SAMLUSERID001"
],
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12"
}
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 ユーザーが存在しません。 取得するユーザーが存在しません。ユーザーIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
login [必須] string ログインID
last_name [必須] string 姓
first_name [必須] string 名
last_name_kana string 姓（カナ）
first_name_kana string 名（カナ）
email string メールアドレス
email2 string メールアドレス（サブ）
password [必須] string パスワード
valid_start_date string 有効開始日（yyyy/mm/dd）
valid_end_date string 有効終了日（yyyy/mm/dd）
role [必須] string 権限名（例：受講者（student））
group_codes [string] グループコード
properties [string] 属性名
invalid_flag boolean 無効
temporary_user_flag boolean 仮登録
language string 使用言語名（デフォルト：日本語 (Japanese)）
note string 備考
scheduled_signup_mail boolean ログインID発行通知メール送信（trueの場合はemail必須）
*saml_idps [string] SAML認証用ユーザーID
*オプション利用中のみ
リクエストボディ例 
{
"login": "example001",
"last_name": "学習",
"first_name": "太郎",
"last_name_kana": "ガクシュウ",
"first_name_kana": "タロウ",
"email": "api1@example.com",
"email2": "api2@example.com",
"password": "1234abcd"
"valid_start_date": "2024-09-01",
"valid_end_date": "2027-08-31",
"role": "受講者（student）",
"group_codes":[
"english", "math"
],
"properties":[
"生徒", "1年生"
],
"invalid_flag": false,
"temporary_user_flag": false,
"language": "英語 (English)",
"note": "備考欄",
"saml_idps":[
"SAMLUSERID001"
]
}

レスポンス情報

レスポンスボディ
key type description
id integer 登録されたユーザーのユーザーID（エラー返却時はnull）
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”ユーザーを登録しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 ユーザー登録数が上限に達しています。 サイトに登録されているユーザー数が契約内容の上限に達しています。
400 必須パラメータが不足しています。parameter1… ユーザー登録に必須の項目が不足しています。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
user_id [必須] string ユーザーID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
login string ログインID
last_name string 姓
first_name string 名
last_name_kana string 姓（カナ）
first_name_kana string 名（カナ）
email string メールアドレス
email2 string メールアドレス（サブ）
password string パスワード
valid_start_date string 有効開始日（yyyy/mm/dd）
valid_end_date string 有効終了日（yyyy/mm/dd）
role string 権限名（例：受講者（student））
group_codes [string] グループコード
properties [string] 属性名
invalid_flag boolean 無効
temporary_user_flag boolean 仮登録
language string 使用言語名（デフォルト：日本語 (Japanese)）
note string 備考
*saml_idps [string] SAML認証用ユーザーID
*オプション利用中のみ
リクエストボディ例 
{
"valid_end_date": "2027-09-30",
"group_codes":[],
"invalid_flag": true,
}

レスポンス情報

レスポンスボディ
key type description
id integer 指定したユーザーのユーザーID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”ユーザーを更新しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 ユーザーが存在しません。 更新するユーザーが存在しません。ユーザーIDを確認してください。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
user_id [必須] string ユーザーID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 指定したユーザーのユーザーID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”ユーザーを削除しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 このユーザーは削除できません。 削除する事の出来ないユーザーです。ユーザー情報を確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 ユーザーが存在しません。 削除するユーザーが存在しません。ユーザーIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

グループ管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: グループ数のみ取得。false: 一覧情報を取得。
order enum 昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort enum 一覧情報をソートする項目。[“id”, “name”, “group_code”]から選択。デフォルト：”id”
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： グループ名
リクエストボディ例 
{
"get_count": false,
"sort": "group_code",
"order": "desc",
"per": 50
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得グループ数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
groups [{
id: integer,
name: string,
group_code: string,
parent_id: integer,
parent_code: string,
deletable: boolean,
public_status: boolean
}]		 グループ情報。グループID, グループ名, グループコード, 親グループID, 親グループコード, 削除の可否, 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ） を取得
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
group_id [必須] string グループID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer グループID
name string グループ名
group_code string グループコード
parent_id integer 親グループID
parent_code string 親グループコード
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
creator string 登録者
created_at string 登録日時
updater string 更新者
updated_at string 更新日時
deletable boolean 削除の可否
レスポンスボディ例 
{
"id": 123456789,
"name": "管理者グループ",
"group_code": "admingroup",
"parent_id": 987654321,
"parent_code": "superadmin",
"public_status": false,
"note": "管理者のグループ",
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12",
"deletebale": false
}
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 グループが存在しません。 取得するグループが存在しません。グループIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
name [必須] string グループ名
group_code [必須] string グループコード
parent_code string 親グループコード
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
*オプション利用中のみ
リクエストボディ例 
{
"name": "学習グループ",
"group_code": "studygroup",
"parent_code": "admingroup",
"public_status": true,
"note": "学習者のグループ"
}

レスポンス情報

レスポンスボディ
key type description
id integer 登録されたグループのグループID（エラー返却時はnull）
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”グループを登録しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 グループ登録数が上限に達しています。 サイトに登録されているグループ数が上限に達しています。
400 必須パラメータが不足しています。parameter1… グループ登録に必須の項目が不足しています。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
group_id [必須] string グループID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
name string グループ名
group_code string グループコード
parent_code string 親グループコード。親グループを解除する場合は空文字列””を入力
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
リクエストボディ例 
{
"group_code": "singlegroup",
"parent_code": ""
}

レスポンス情報

レスポンスボディ
key type description
id integer 指定したグループのグループID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”グループを更新しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 グループが存在しません。 更新するグループが存在しません。グループIDを確認してください。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
group_id [必須] string グループID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 指定したグループのグループID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”グループを削除しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 このグループは削除できません。 削除する事の出来ないグループです。グループ情報を確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 グループが存在しません。 削除するグループが存在しません。グループIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

属性管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 属性数のみ取得。false: 一覧情報を取得。
order enum 昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort enum 一覧情報をソートする項目。[“position”, “id”, “name”]から選択。デフォルト：”position”
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 属性名
リクエストボディ例 
{
"get_count": false,
"sort": "name",
"order": "desc",
"per": 50
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得属性数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
properties [{ id: integer, name: string, deletable: boolean, public_status: boolean }] 属性情報。属性ID, 属性名, 削除の可否, 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ） を取得
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
property_id [必須] string 属性ID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 属性ID
name string 属性名
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
creator string 登録者
created_at string 登録日時
updater string 更新者
updated_at string 更新日時
deletable boolean 削除の可否
レスポンスボディ例 
{
"id": 123456789,
"name": "英語",
"public_status": false,
"note": "英語割り当て用の属性",
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12",
"deletebale": false
}
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 属性が存在しません。 取得する属性が存在しません。属性IDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
name [必須] string 属性名
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
*オプション利用中のみ
リクエストボディ例 
{
"name": "数学"
"public_status": true,
"note": "数学割り当て用の属性"
}

レスポンス情報

レスポンスボディ
key type description
id integer 登録された属性の属性ID（エラー返却時はnull）
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”属性を登録しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 属性登録数が上限に達しています。 サイトに登録されている属性数が上限に達しています。
400 必須パラメータが不足しています。parameter1… 属性登録に必須の項目が不足しています。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
property_id [必須] string 属性ID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
name string 属性名
public_status boolean 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note string 備考
リクエストボディ例 
{
"name": "数学（受講完了）",
"public_status": false
}

レスポンス情報

レスポンスボディ
key type description
id integer 指定した属性の属性ID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”属性を更新しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 属性が存在しません。 更新する属性が存在しません。属性IDを確認してください。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
property_id [必須] string 属性ID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 指定た属性の属性ID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”属性を削除しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 この属性は削除できません。 削除する事の出来ない属性です。属性情報を確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 属性が存在しません。 削除する属性が存在しません。属性IDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

教科管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 教科数のみ取得。false: 一覧情報を取得。
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 教科名
リクエストボディ例 
{
"get_count": false,
"per": 100,
"page": 2
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得教科数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
subjects [{ id: integer,
name: {
　ja: string,
　en: string,
　zh_CN: string,
　zh_TW: string
},
shared: boolean,
courses_count: integer,
materials_count: integer }]		 教科情報。教科ID, 教科名, 配下の共有科目の有無, 配下の科目数, 配下の総教材数を取得。
※教科名はサイトに設定された使用言語のみ取得。
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

科目管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 科目数のみ取得。false: 一覧情報を取得。
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 科目名
subject_id integer 教科IDによる絞り込み。
リクエストボディ例 
{
"get_count": false,
"per": 100,
"subject_id": 999999
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得科目数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
courses [{
subject_id: integer,
id: integer,
name: {
　ja: string,
　en: string,
　zh_CN: string,
　zh_TW: string
},
is_adaptive_course: boolean,
status: string,
shared: boolean,
materials_count: integer
}]		 科目情報。教科ID, 科目ID, 科目名, 科目のアダプティブ設定の有無,　公開(public)/非公開(private), 科目の共有の有無, 配下の教材数を取得。
※科目名はサイトに設定された使用言語のみ取得。
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

教材管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 教材数のみ取得。false: 一覧情報を取得。
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 教材名
course_id integer 科目IDによる絞り込み。
リクエストボディ例 
{
"get_count": false,
"per": 100,
"course_id": 999999
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得教材数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
materials [{
subject_id: integer,
course_id: integer,
id: integer,
name: { ja: string,　en: string,　zh_CN: string,　zh_TW: string },
status: string,
shared: boolean
}]		 教材情報。教科ID, 科目ID, 教材ID, 教材名, 完了(published)/編集中(making), 属する科目の共有の有無を取得。 ※教材名はサイトに設定された使用言語のみ取得。
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

割り当て管理

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 割り当て数のみ取得。false: 一覧情報を取得。
order enum 昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort enum 一覧情報をソートする項目。[“id”, “name”, “allocation_start_date”, “allocation_end_date”]から選択。デフォルト：”id”
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
keyword [string] フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 割り当て条件名
course_id integer 科目IDによる絞り込み。
リクエストボディ例 
{
"get_count": false,
"sort": "allocation_end_date",
"order": "desc",
"keyword": ["全受講者"],
"course_id": 999999
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得割り当て数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
lecture_settings [{
id: integer,
subject: {
　id: integer,
　name: {
　　ja: string,
　　en: string,
　　zh_CN: string,
　　zh_TW: string
　}
},
course: {
　id: integer,
　name: {
　　ja: string,
　　en: string,
　　zh_CN: string,
　　zh_TW: string
　}
},
name: string,
allocation_start_date: string,
allocation_end_date: string
}]		 割り当て情報。割り当てID, 教科情報(教科ID, 教科名), 科目情報(科目ID, 科目名), 割り当て条件名, 割り当て開始日, 割り当て終了日を取得。
allocation_start_date string 割り当て開始日。
allocation_end_date string 割り当て終了日。
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
lecture_setting_id [必須] string 割り当てID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 割り当てID
name string 割り当て条件名
subject {
id: integer,
name: {
ja: string,
en: string,
zh_CN: string,
zh_TW: string
}
}		 教科情報（教科ID, 教科名）
course {
id: integer,
name: {
ja: string,
en: string,
zh_CN: string,
zh_TW: string
}
}		 科目情報（科目ID, 科目名）
groups [{group_code: string, name: string}] グループ情報（グループコード, グループ名）
properties [string] 属性情報（属性名）
group_property_conditions string グループ×属性（AND/OR）。グループと属性が共に設定されている場合のみ取得。
show_users [string] ユーザー情報(ログインID)
assigned_count integer 割り当て対象ユーザー数
allocation_start_date string 割り当て開始日
allocation_end_date string 割り当て終了日
optional boolean 任意設定（true: 任意, false: 必須）。
needs_application boolean 受講申請の要不要（true: 必要,  false: 不要）。サイト設定で「受講申請/承認の機能を使用する」をONにしている場合のみ取得。
creator string 登録者
created_at string 登録日時
updater string 更新者
updated_at string 更新日時
レスポンスボディ例 
{
"id": 123456789,
"name": "英語割り当て",
"subject": {id: 999999, name: {ja: "基本学習", en: "Basic Learning"}},
"course": {id: 999999, name: {ja: "英語1", en: "English 1"}},
"groups": [{group_code: "english", name: "英語専攻"}],
"properties" ["1期生", "2期生"],
"group_property_conditions: "AND",
"show_users": ["tester001"],
"assigned_count": 10,
"allocation_start_date": 2025-01-01,
"allocation_end_date": 2025-12-31,
"optional": false,
"needs_application": true,
"creator": "管理者 user001",
"created_at: "2024-12-01 00:00:00",
"updated_at": "2024-12-10 12:12:12 
}
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 割り当てが存在しません。 取得する割り当てが存在しません。割り当てIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
course_id [必須] string 科目ID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
get_count [必須] boolean true: 対象ユーザー数のみ取得。false: 一覧情報を取得。指定科目の複数割り当てに該当するユーザーが存在する場合は重複して取得。
order enum 昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort enum 一覧情報をソートする項目。[“id”, “login”, “name”, “lecture_setting_id, “lectue_setting_name”]から選択。デフォルト：”id”
per integer 一覧情報の取得単位。デフォルト及び上限値：1,000
page integer perで区切られた一覧情報のインデックス。デフォルト：1
lecture_setting_id integer 割り当てIDによる絞り込み。
リクエストボディ例 
{
"get_count": false,
"sort": "login",
"page": 2,
"lecture_setting_id": 999999
}

レスポンス情報

レスポンスボディ
key type description
count integer 割り当て対象ユーザー数。get_count: true 時に返却。
page {current: integer, max: integer} 一覧のインデックス情報。current: 現在値, max: 上限値
per integer リストの取得単位
assigned_users [{
id: string,
login: string,
name: string,
lecture_setting_id: integer,
lecture_setting_name: string
}]		 割り当て対象ユーザー情報。ユーザーID, ログインID, ユーザー名, 科目受講ステータス, 割り当てID, 割り当て条件名を取得。
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
course_id [必須] integer 科目ID
name [必須] string 割り当て条件名
group_codes*1 [string] グループコード
properties*1 [string] 属性名
group_property_conditions*2 enum グループ×属性。[“AND”, “OR”]から選択。
show_users*1 [string] 指定ユーザーのログインID
allocation_start_date string 割り当て開始日（yyyy/mm/dd）
allocation_end_date string 割り当て終了日（yyyy/mm/dd）
optional boolean 任意設定（true: 任意, false: 必須）。
needs_application boolean 受講申請の要不要（true: 必要, false: 不要）。サイト設定で「受講申請/承認の機能を使用する」をONにしている場合のみ設定可能。
*1いずれか1項目は必須
*2グループと属性を両方登録する場合のみ、設定可能且つ必須パラメータとなる。
リクエストボディ例 
{
"course_id": 999999,
"name": "基本学習割り当て"
"group_codes": ["group001", "group002"],
"properties": ["1期生"],
"group_property_conditions": "AND",
"allocation_start_date": "2025/01/01",
"optional": true
}

レスポンス情報

レスポンスボディ
key type description
id integer 登録された属性の属性ID（エラー返却時はnull）
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”割り当てを登録しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 必須パラメータが不足しています。parameter1… 割り当て登録に必須の項目が不足しています。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。
503 現在別の割り当てを処理中のため、割り当て登録ができません。 現在別の割り当て情報の処理中です。時間を空けてからお試しください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
property_id [必須] string 属性ID
ヘッダー情報   dth: 94.1875px;”>備考
key value description
name string 割り当て条件名
group_codes*1 [string] グループコード
properties*1 [string] 属性名
group_property_conditions*2 enum グループ×属性。[“AND”, “OR”]から選択。
show_users*1 [string] 指定ユーザーのログインID
allocation_start_date string 割り当て開始日（yyyy/mm/dd）
allocation_end_date string 割り当て終了日（yyyy/mm/dd）
optional boolean 任意設定（true: 任意, false: 必須）。
needs_application boolean 受講申請の要不要（true: 必要, false: 不要）。サイト設定で「受講申請/承認の機能を使用する」をONにしている場合のみ設定可能。
*1全ての項目で指定が無くなる更新は不可。
*2更新によりグループと属性の両方が設定されるようになる場合は必須。
リクエストボディ例 
{
"group_property_conditions": "OR",
"allocation_end_date": "2025/12/31",
"needs_application": true
}

レスポンス情報

レスポンスボディ
key type description
id integer 指定した割り当ての割り当てID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”割り当てを更新しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 登録出来ないデータが含まれています。parameter1… メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 割り当てが存在しません。 更新する割り当てが存在しません。割り当てIDを確認してください。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディのサイズは100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。
503 現在別の割り当てを処理中のため、割り当て更新ができません。 現在別の割り当て情報の処理中です。時間を空けてからお試しください。

リクエスト情報

パスパラメータ  
key type description
site_id [必須] string サイトID
lecture_setting_id [必須] string 割り当てID
ヘッダー情報  
key value
Authorization [必須] Bearer {api_key}

レスポンス情報

レスポンスボディ
key type description
id integer 指定た割り当ての割り当てID
status_code string レスポンスステータスが返却されます
message string API実行結果（正常値：”割り当てを削除しました。”）
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
404 割り当てが存在しません。 削除する割り当てが存在しません。割り当てIDを確認してください。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。
503 現在別の割り当てを処理中のため、割り当て削除ができません。 現在別の割り当て情報の処理中です。時間を空けてからお試しください。

レポート管理

next_page_tokenの仕様

  • per(デフォルト：1000）行より取得可能なデータ数が多い場合、レスポンスとしてnext_page_tokenが発行されます。
  • 2ページ目以降のデータ取得はnext_page_tokenをパラメータにセットしてください。
  • 初回リクエストの絞り込み要素を引き継ぐため、next_page_tokenをセットしたリクエストではその他全てのパラメータが排除されます。
  • 全データの取得が完了した時点でnullが返却されます。
  • トークンの有効期限は30分です。
  • 一度使用したトークンの再使用は出来ません。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
course_id [必須] integer 取得する科目のID指定
group_codes [string] グループコードによる絞り込み。複数値でOR検索が可能。
properties [string] 属性名による絞り込み。複数値でOR検索が可能。
group_property_conditions * enum グループ×属性。[“AND”, “OR”]から選択。
users [string] ログインIDによる絞り込み。
include_invalid_user boolean 出力結果に無効ユーザーを含めるかの可否。デフォルト：false
optional boolean 科目が任意で割り当てられているかの可否。true: 任意割り当て者, false: 必須割り当て者
*グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。
リクエストボディ例 
{
"course_id": 999999,
"group_codes": ["group9999"],
"properties": ["property9999"],
"group_property_conditions": "OR",
"include_invalid_user: true,
"optional": false
}

レスポンス情報

レスポンスボディ
key type description
subject_id integer 教科ID
subject_name {ja: string, en: string, zh_CN: string, zh_TW: string} 教科名
course_id integer 科目ID
course_name {ja: string, en: string, zh_CN: string, zh_TW: string} 科目名
assigned_count integer 割当受講者数
completed integer 修了受講者数
passed integer 合格受講者数
failed integer 不合格受講者数
incomplete integer 受講中受講者数
not_attempted integer 未受講者数
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
material_id [必須] integer 取得する教材のID指定。
group_codes [string] グループコードによる絞り込み。複数値でOR検索が可能。
properties [string] 属性名による絞り込み。複数値でOR検索が可能。
group_property_conditions * enum グループ×属性。[“AND”, “OR”]から選択。
users [string] ログインIDによる絞り込み。
include_invalid_user boolean 出力結果に無効ユーザーを含めるかの可否。デフォルト：false
optional boolean 科目が任意で割り当てられているかの可否。true: 任意割り当て者, false: 必須割り当て者
*グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。
リクエストボディ例 
{
"material_id": 999999,
"group_codes": ["group9999"],
"properties": ["property9999"],
"group_property_conditions": "OR",
"include_invalid_user: true,
"optional": false
}

レスポンス情報

レスポンスボディ
key type description
subject_id integer 教科ID
subject_name {ja: string, en: string, zh_CN: string, zh_TW: string} 教科名
course_id integer 科目ID
course_name {ja: string, en: string, zh_CN: string, zh_TW: string} 科目名
material_id integer 教材ID
material_name {ja: string, en: string, zh_CN: string, zh_TW: string} 教材名
assigned_count integer 割当受講者数
completed integer 修了受講者数
passed integer 合格受講者数
failed integer 不合格受講者数
incomplete integer 受講中受講者数
not_attempted integer 未受講者数
avg_score float 平均点
max_score float 最高点
min_score float 最低点
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
user [必須] string 取得するユーザーのログインID指定。
リクエストボディ例 
{
"user": "user999999"
}

レスポンス情報

レスポンスボディ
key type description
user_id integer ユーザーID
login string ログインID
user_name string ユーザー名
assigned_count integer 割当科目数
completed integer 修了科目数
passed integer 合格科目数
failed integer 不合格科目数
incomplete integer 受講中科目数
not_attempted integer 未受講科目数
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ *1
key type description
get_count [必須]*2 boolean true: データ数のみ取得。false: 一覧情報を取得。
next_page_token [必須]*2 string 2ページ目以降のデータ取得用に発行されたトークン。
per integer データの取得単位。デフォルト及び上限値：1,000
subject_ids [integer] 教科IDによる絞り込み。複数指定可能。
course_ids [integer] 科目IDによる絞り込み。複数指定可能。
course_type enum 科目種別による絞り込み。[“normal”(通常科目), “adaptive”(アダプティブ科目)]から選択。
group_codes [string] グループコードによる絞り込み。複数値でOR検索が可能。
properties [string] 属性名による絞り込み。複数値でOR検索が可能。
group_property_conditions *3 enum グループ×属性。[“AND”, “OR”]から選択。
users [string] ログインIDによる絞り込み。複数指定可能。
include_invalid_user boolean 出力結果に無効ユーザーを含めるかの可否。デフォルト：false
status [enum] 科目の受講ステータスによる絞り込み。[“completed”(修了), “incomplete”(受講中), “not_attempted”(未受講)]から複数選択可能。
is_passed [boolean] 科目の合否による絞り込み。true：合格, false: 不合格。両方指定も可能。
optional boolean 科目が任意で割り当てられているかの可否。true: 任意割り当て, false: 必須割り当て
*1取得ユーザー数10,000以下、取得科目数1,000以下、取得ユーザー×科目数1,000,000以下になるよう絞り込みが必須。
*2get_count, next_page_tokenのいずれか一つ必須。
*3グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。
リクエストボディ例（初回） 
{
"get_count": false,
"subject_ids": [1234, 5678],
"course_type": "normal",
"group_codes": ["group9999"],
"properties": ["property9999"],
"group_property_conditions": "OR",
"include_invalid_user: true,
"status": ["completed"],
"is_passed": [true, false],
"optional": false
}
リクエストボディ例(2ページ目以降) 
{
"next_page_token": "abcdefghi123456789"
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得データ数。get_count: true時に返却。
per integer リストの取得単位
next_page_token string 次ページが存在する場合に発行されるトークン。
user_course_report array 以降の各パラメータを持つデータをリスト形式で返却する。
user_id integer ユーザーID
login string ログインID
user_name string ユーザー名
subject_id integer 教科ID
subject_name { ja: string, en: string, zh_CN: string, zh_TW: string } 教科名
course_id integer 科目ID
course_name { ja: string, en: string, zh_CN: string, zh_TW: string } 科目名
status string 科目の受講ステータス
is_passed string 科目の合否
completed_at string 学習修了日。”yyyy/mm/dd HH:MM:SS”
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
400 このトークンは無効です。next_page_token セットされたトークンは期限切れ、または存在しません。
400 ユーザーが10,000以下になるように絞り込みをしてください。 ユーザー数の絞り込み上限は10,000までです。
400 科目が1,000以下になるように絞り込みをしてください。 科目数の絞り込み上限は1,000までです。
400 ユーザー×科目が1,000,000以下になるように絞り込みをしてください。 ユーザー×科目の絞り込み上限は1,000,000までです。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ *1
key type description
get_count [必須]*2 boolean true: 割り当て数のみ取得。false: 一覧情報を取得。
next_page_token [必須]*2 string 2ページ目以降のデータ取得用に発行されたトークン。
per integer データの取得単位。デフォルト及び上限値：1,000
subject_ids [integer] 教科IDによる絞り込み。複数指定可能。
course_ids [integer] 科目IDによる絞り込み。複数指定可能。
course_type enum 科目種別による絞り込み。[“normal”, “adaptive”]から選択。
material_ids [integer] 教材IDによる絞り込み。複数指定可能。
group_codes [string] グループコードによる絞り込み。複数値でOR検索が可能。
properties [string] 属性名による絞り込み。複数値でOR検索が可能。
group_property_conditions *3 enum グループ×属性。[“AND”, “OR”]から選択。
users [string] ログインIDによる絞り込み。複数指定可能
include_invalid_user boolean 出力結果に無効ユーザーを含めるかの可否。デフォルト：false
status *4 [enum] 教材の受講ステータスによる絞り込み。[“completed”(修了), “incomplete”(受講中), “not_attempted”(未受講)]から複数選択可能。
is_passed *4 [boolean] 教材の合否による絞り込み。true：合格, false: 不合格。両方指定も可能。
optional boolean 教材が属する科目が任意で割り当てられているかの可否。true: 任意割り当て, false: 必須割り当て
*1取得ユーザー数10,000以下、取得教材数1,000以下、取得ユーザー×教材数1,000,000以下になるよう絞り込みが必須。
*2get_count, next_page_tokenのいずれか一つ必須。
*3グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。
*4status, is_passedを指定する場合のみ、教材数が10以下になるよう絞込みが必須。
リクエストボディ例（初回） 
{
"get_count": false,
"subject_ids": [1234, 5678],
"course_type": "normal",
"material_ids": [1234]
"group_codes": ["group9999"],
"properties": ["property9999"],
"group_property_conditions": "OR",
"include_invalid_user: true,
"status": ["completed"],
"is_passed": [true, false],
"optional": false
}
リクエストボディ例(2ページ目以降) 
{
"next_page_token": "abcdefghi123456789"
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得データ数。get_count: true時に返却。
per integer リストの取得単位
next_page_token string 次ページが存在する場合に発行されるトークン。
user_material_report array 以降の各パラメータを持つデータをリスト形式で返却する。
user_id integer ユーザーID
login string ログインID
user_name string ユーザー名
subject_id integer 教科ID
subject_name { ja: string, en: string, zh_CN: string, zh_TW: string } 教科名
course_id integer 科目ID
course_name { ja: string, en: string, zh_CN: string, zh_TW: string } 科目名
material_id integer 教材ID
material_name { ja: string, en: string, zh_CN: string, zh_TW: string } 教材名
status string 教材の受講ステータス
submission_status string 課題教材の提出状況
is_passed string 教材の合否
score integer/string 採点結果。課題教材且つ5段階評価の場合のみ”A”~”E”。
started_at string 学習開始日。”yyyy/mm/dd HH:MM:SS”
completed_at string 学習修了日。”yyyy/mm/dd HH:MM:SS”
last_learned_date string 最終学習日時。”yyyy/mm/dd HH:MM:SS”
total_time string 総学習時間。”HH:MM:SS”
first_score integer/string 初回採点結果。課題教材且つ5段階評価の場合のみ”A”~”E”。
times_of_attended integer 受講回数
suspend_data string SCORM教材用サスペンドデータ
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
400 このトークンは無効です。next_page_token セットされたトークンは期限切れ、または存在しません。
400 ユーザーが10,000以下になるように絞り込みをしてください。 ユーザー数の絞り込み上限は10,000までです。
400 教材が1,000以下になるように絞り込みをしてください。 教材数の絞り込み上限は1,000までです。
400 ユーザー×教材が1,000,000以下になるように絞り込みをしてください。 ユーザー×教材の絞り込み上限は1,000,000までです。
400 status, is_passedを指定する場合、教材が10以下になるように絞り込みをしてください。 status, is_passedのいずれかを含める場合、教材の絞り込み（上限10）が必須です。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。

リクエスト情報

パスパラメータ
key type description
site_id [必須] string サイトID
ヘッダー情報
key value
Authorization [必須] Bearer {api_key}
Content-Type [必須] application/json
リクエストボディ
key type description
user [必須]* string ログインID
get_count boolean true: 割り当て数のみ取得。false: 一覧情報を取得。
next_page_token [必須]* string 2ページ目以降のデータ取得用に発行されたトークン。
per integer データの取得単位。デフォルト及び上限値：1,000
subject_ids [integer] 教科IDによる絞り込み。複数指定可能。
course_ids [integer] 科目IDによる絞り込み。複数指定可能。
course_type enum 科目種別による絞り込み。[“normal”, “adaptive”]から選択。
material_ids [integer] 教材IDによる絞り込み。複数指定可能。
optional boolean 教材が属する科目が任意で割り当てられているかの可否。true: 任意割り当て, false: 必須割り当て
*user, next_page_tokenのいずれか一つ必須。
リクエストボディ例（初回） 
{
"user": "user9999",
"subject_ids": [1234, 5678],
"course_type": "adaptive",
"material_ids": [1234]
"optional": true
}
リクエストボディ例(2ページ目以降) 
{
"next_page_token": "abcdefghi123456789"
}

レスポンス情報

レスポンスボディ
key type description
count integer 取得データ数。get_count: true時に返却。
per integer リストの取得単位
next_page_token string 次ページが存在する場合に発行されるトークン。
answer_report array 以降の各パラメータを持つデータをリスト形式で返却する。
user_id integer ユーザーID
login string ログインID
user_name string ユーザー名
subject_id integer 教科ID
subject_name { ja: string, en: string, zh_CN: string, zh_TW: string } 教科名
course_id integer 科目ID
course_name { ja: string, en: string, zh_CN: string, zh_TW: string } 科目名
material_id integer 教材ID
material_name { ja: string, en: string, zh_CN: string, zh_TW: string } 教材名
question_id string 問題ID
question_type string 問題形式
correct_answer [string]/[{ja: string, en: string, zh_CN: string, zh_TW: string }] 正答値。オリジナル教材の場合に各言語で出力。
selected_answer [string]/[{ja: string, en: string, zh_CN: string, zh_TW: string }] ユーザー回答値。オリジナル教材の場合に各言語で出力。
judgement string 判定結果
answer_time string 回答時間。”HH:MM:SS”
answered_at string 回答日時。”yyyy/mm/dd HH:MM:SS”
エラーレスポンス
status_code message description
400 URLに誤りがあります。 リクエストURL、パスパラメータを確認してください。
400 Content-Type情報が不正な値です。 リクエストヘッダー情報を確認してください。
400 リクエスト内容を認識できません。 リクエストボディの読み込みに失敗しました。送信データを確認してください。
400 使用出来ないパラメータが含まれています。parameter1… メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400 必須パラメータが不足しています。parameter1… 一覧情報取得に必須のパラメータが不足しています。
400 このトークンは無効です。next_page_token セットされたトークンは期限切れ、または存在しません。
403 認証に失敗しました。 APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403 許可されていないIPからのリクエストです。 IPアドレス制限によってリクエストが制限されています。
413 リクエストボディサイズが上限に達しています。 送信できるリクエストボディサイズの上限は100KBです。
429 リクエスト制限中です。 1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500 予期せぬエラーが発生しました。 システム内部でエラーが発生しました。時間をおいて再度お試しください。
503 現在別のレポートAPIを処理中のため、APIを実行できません。 サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。
503 サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。 サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。
503 システムメンテナンス中です。 現在システム全体のメンテナンス中です。終了までお待ちください。
＜ 前の項目へ
トップへ戻る