概要
他APIのリクエストパラメーターとして利用する、管理グループの情報を取得するAPIです。
API URL
https://api-analytics.stream.jp/group/getList
リクエスト通信仕様
- プロトコル：POST
- Content-Type : application/json
■パラメータ
| No. | 項目名 | 必須 | 説明 | 属性 | 形式 | 備考 |
| 1 | page_size | ○ | 1ページ当たりのログレコード数 | int | 1〜100 | |
| 2 | page_number | ○ | 該当のページ番号 | int | 1〜2147483647 |
■リクエストサンプル
| { "page_size": 100, "page_number": 1 } |
レスポンス通信仕様
- Content-Type : application/json
■パラメータ
| No. | 項目名 | 説明 | 属性 | 備考 | |
| 1 | response_code | レスポンスコード | int | 成功時は0 エラー時は9 | |
| 2 | count | レコード数 | int | 検索条件に一致するトータルレコード件数 | |
| group_list | グループ一覧 | array | |||
| cid | 顧客ID | int | |||
| grid | グループID | int | |||
| group_name | 管理グループ名 | string | |||
■レスポンスサンプル
| { "count": 3, "group_list": [ { "cid": 0000, "grid": 625, "group_name": "管理グループA" }, { "cid": 0000, "grid": 626, "group_name": "管理グループB" }, { "cid": 0000, "grid": 627, "group_name": "管理グループB－２" } ], "respons |
■レスポンスサンプル（エラー時） 入力パラメータに誤りがある場合
| { "message": "パラメータの入力に誤りがあるため認証できませんでした。", "response_code": 9 } |