割り当て登録

POSThttps://manabeat.com/{site_id}/mana_apis/lectue_setting_create

新規割り当てを登録します。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

course_idintegerrequired

科目ID

namestringrequired

割り当て条件名

*1group_codes[string]

グループコード

*1properties[string]

属性名

*2group_property_conditionsenum

グループ×属性。["AND", "OR"]から選択。

*1show_users[string]

指定ユーザーのログインID

allocation_start_datestring

割り当て開始日(yyyy/mm/dd)

allocation_end_datestring

割り当て終了日(yyyy/mm/dd)

optionalboolean

任意設定(true: 任意, false: 必須)。

needs_applicationboolean

受講申請の要不要(true: 必要, false: 不要)。サイト設定で「受講申請/承認の機能を使用する」をONにしている場合のみ設定可能。

*1 いずれか1項目は必須
*2 グループと属性を両方登録する場合のみ、設定可能且つ必須パラメータとなる。

レスポンスボディ

idinteger

登録された割り当ての割り当てID(エラー返却時はnull)

status_codestring

レスポンスステータスが返却されます

messagestring

API実行結果(正常値:"割り当てを登録しました。")

エラーレスポンス

400URLに誤りがあります。

リクエストURL、パスパラメータを確認してください。

400Content-Type情報が不正な値です。

リクエストヘッダー情報を確認してください。

400リクエスト内容を認識できません。

リクエストボディの読み込みに失敗しました。送信データを確認してください。

400必須パラメータが不足しています。parameter1…

一覧情報取得に必須のパラメータが不足しています。

400登録出来ないデータが含まれています。parameter1…

メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。

403認証に失敗しました。

APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。

403許可されていないIPからのリクエストです。

IPアドレス制限によってリクエストが制限されています。

413リクエストボディサイズが上限に達しています。

送信できるリクエストボディのサイズは100KBです。

429リクエスト制限中です。

1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。

500予期せぬエラーが発生しました。

システム内部でエラーが発生しました。時間をおいて再度お試しください。

503システムメンテナンス中です。

現在システム全体のメンテナンス中です。終了までお待ちください。

503現在別の割り当てを処理中のため、割り当て登録ができません。

現在別の割り当て情報の処理中です。時間を空けてからお試しください。

リクエストボディ例

{ "course_id": 999999, "name": "基本学習割り当て", "group_codes": [ "group001", "group002" ], "properties": [ "1期生" ], "group_property_conditions": "AND", "allocation_start_date": "2025/01/01", "optional": true }