グループの件数を取得する#
Description#
リクエストパラメータを検索条件として該当するグループ情報の件数を返却します。
項目「複数指定グループＩＤ」「グループ名」はいずれか１つを条件として設定できます。
（いずれも設定されている場合は入力エラーとなります。）
Method#
GET
Request Header#
共通リクエストヘッダーを参照してください。
Argument#
| Name | Type | Required | Length （Long /Decimalの場合はValue） |
URI | Query String | Description |
|---|---|---|---|---|---|---|
group_id |
String |
8 |
- |
○ |
複数指定グループＩＤ |
|
group_name |
String |
1 |
- |
○ |
グループ名 |
|
free_item1 |
String |
1 |
- |
○ |
フリー項目１ |
|
free_item2 |
String |
1 |
- |
○ |
フリー項目２ |
|
free_item3 |
String |
1 |
- |
○ |
フリー項目３ |
|
free_item4 |
String |
1 |
- |
○ |
フリー項目４ |
|
free_item5 |
String |
1 |
- |
○ |
フリー項目５ |
|
free_item6 |
String |
1 |
- |
○ |
フリー項目６ |
|
free_item7 |
String |
1 |
- |
○ |
フリー項目７ |
|
free_item8 |
String |
1 |
- |
○ |
フリー項目８ |
|
free_item9 |
String |
1 |
- |
○ |
フリー項目９ |
|
free_item10 |
String |
1 |
- |
○ |
フリー項目１０ |
URI#
/API/v2/api/grouplistcount
Sample request uri#
グループＩＤを指定しての検索
/API/v2/api/grouplistcount?group_id=00000001
Parameters in request body#
なし
Return Codes#
| Code | Description |
|---|---|
| 200 | レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。 |
| 401 | 認証エラー。API認証時のエラー。 |
| 403 | アクセス不可。 |
| 404 | 対象なし。対象の情報が見つからない場合。 |
| 500 | 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。 |
Response Header#
なし
Response Parameter#
共通仕様はこちらを参照してください。
- レスポンス（正常）
Example#
Parameters#
- レスポンス（異常）
共通エラー情報を参照してください。