教材一覧
PATCHhttps://manabeat.com/{site_id}/mana_apis/material_list教材の一覧情報を取得します。
パスパラメータ
site_idstringrequired
サイトID
リクエストボディ
get_countbooleanrequired
true: 教材数のみ取得。false: 一覧情報を取得。
perinteger
一覧情報の取得単位。デフォルト及び上限値：1,000
pageinteger
perで区切られた一覧情報のインデックス。デフォルト：1
keyword[string]
フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目： 教材名
course_idinteger
科目IDによる絞り込み。
レスポンスボディ
countinteger
取得教材数。get_count: true 時に返却。
page{current: integer, max: integer}
一覧のインデックス情報。current: 現在値, max: 上限値
perinteger
リストの取得単位
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), 属する科目の共有の有無を取得。 ※教材名はサイトに設定された使用言語のみ取得。
エラーレスポンス
400URLに誤りがあります。
リクエストURL、パスパラメータを確認してください。
400Content-Type情報が不正な値です。
リクエストヘッダー情報を確認してください。
400リクエスト内容を認識できません。
リクエストボディの読み込みに失敗しました。送信データを確認してください。
400使用出来ないパラメータが含まれています。parameter1…
メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400必須パラメータが不足しています。parameter1…
一覧情報取得に必須のパラメータが不足しています。
403認証に失敗しました。
APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403許可されていないIPからのリクエストです。
IPアドレス制限によってリクエストが制限されています。
413リクエストボディサイズが上限に達しています。
送信できるリクエストボディのサイズは100KBです。
429リクエスト制限中です。
1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500予期せぬエラーが発生しました。
システム内部でエラーが発生しました。時間をおいて再度お試しください。
503システムメンテナンス中です。
現在システム全体のメンテナンス中です。終了までお待ちください。
リクエストボディ例
{
"get_count": false,
"per": 100,
"course_id": 999999
}