グループ一覧

PATCHhttps://manabeat.com/{site_id}/mana_apis/group_list

グループの一覧情報を取得します。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

get_countbooleanrequired

true: グループ数のみ取得。false: 一覧情報を取得。

orderenum

昇順/降順。["asc", "desc"]から選択。デフォルト："asc"

sortenum

一覧情報をソートする項目。["id", "name", "group_code"]から選択。デフォルト："id"

perinteger

一覧情報の取得単位。デフォルト及び上限値：1,000

pageinteger

perで区切られた一覧情報のインデックス。デフォルト：1

keyword[string]

フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目：グループ名

レスポンスボディ

countinteger

取得グループ数。get_count: true 時に返却。

page{current: integer, max: integer}

一覧のインデックス情報。current: 現在値, max: 上限値

perinteger

リストの取得単位

groups[{ id: integer, name: string, group_code: string, parent_id: integer, parent_code: string, deletable: boolean, public_status: boolean }]

グループ情報。グループID, グループ名, グループコード, 親グループID, 親グループコード, 削除の可否, 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）を取得

エラーレスポンス

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,
  "sort": "group_code",
  "order": "desc",
  "per": 50
}