グループ登録

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

新規グループを登録します。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

namestringrequired

グループ名

group_codestringrequired

グループコード

parent_codestring

親グループコード

public_statusboolean

利用者自身の登録可否(サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ)

notestring

備考

レスポンスボディ

idinteger

登録されたグループのグループID(エラー返却時はnull)

status_codestring

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

messagestring

API実行結果(正常値:"グループを登録しました。")

エラーレスポンス

400URLに誤りがあります。

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

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

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

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

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

400グループ登録数が上限に達しています。

サイトに登録されているグループ数が上限に達しています。

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

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

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

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

403認証に失敗しました。

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

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

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

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

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

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

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

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

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

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

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

リクエストボディ例

{ "name": "学習グループ", "group_code": "studygroup", "parent_code": "admingroup", "public_status": true, "note": "学習者のグループ" }