カテゴリ所属マスタの件数を取得する#
Description#
リクエストパラメータを検索条件として該当するカテゴリ所属マスタ情報の件数を返却します。
本APIは、「カテゴリ所属マスタを検索する」で検索する対象レコード数を事前に取得するために使用します。
Method#
GET
Request Header#
共通リクエストヘッダーを参照してください。
Argument#
Name | Type | Required | Length (Long/Decimalの場合はValue) |
URI | Query String | Description |
---|---|---|---|---|---|---|
category_belonging_id | String | 15 | - | ○ | カテゴリ所属ID カテゴリ所属を一意に識別するID |
|
category_id | String | 15 | - | ○ | カテゴリID カテゴリを一意に識別するID |
|
service_code | String | 10 | - | ○ | サービスコード 商品IDとして使用 半角英数字またはハイフン、アンダーバーのみ入力可能 |
|
apply_start_date_from | String | 8 | - | ○ | 適用開始年月日From 入力値の適用開始年月日以降 yyyyMMdd形式 |
|
apply_start_date_to | String | 8 | - | ○ | 適用開始年月日To 入力値の適用開始年月日以前 yyyyMMdd形式 |
|
apply_end_date_from | String | 8 | - | ○ | 適用終了年月日From 入力値の適用終了年月日以降 yyyyMMdd形式 |
|
apply_end_date_to | String | 8 | - | ○ | 適用終了年月日To 入力値の適用終了年月日以前 yyyyMMdd形式 |
|
free_item1 | String | 1 ~ 1000 |
- | ○ | フリー項目1 | |
free_item2 | String | 1 ~ 1000 |
- | ○ | フリー項目2 | |
free_item3 | String | 1 ~ 1000 |
- | ○ | フリー項目3 | |
free_item4 | String | 1 ~ 1000 |
- | ○ | フリー項目4 | |
free_item5 | String | 1 ~ 1000 |
- | ○ | フリー項目5 | |
free_item6 | String | 1 ~ 1000 |
- | ○ | フリー項目6 | |
free_item7 | String | 1 ~ 1000 |
- | ○ | フリー項目7 | |
free_item8 | String | 1 ~ 1000 |
- | ○ | フリー項目8 | |
free_item9 | String | 1 ~ 1000 |
- | ○ | フリー項目9 | |
free_item10 | String | 1 ~ 1000 |
- | ○ | フリー項目10 |
URI#
/API/v2/api/categorybelongingcount
Sample request uri#
カテゴリIDと適用開始日Fromを指定しての検索
/API/v2/api/categorybelongingcount?category_id=000000000000001&apply_start_date_from=20170101
Parameters in request body#
なし
Return Codes#
Code | Description |
---|---|
200 | レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。 |
401 | 認証エラー。API認証時のエラー。 |
403 | アクセス不可 |
404 | 対象なし。対象の情報が見つからない場合。 |
500 | 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。 |
Response Header#
なし
Response Parameter#
共通仕様はこちらを参照してください。
- レスポンス(正常)
Example#
Parameters#
- レスポンス(異常)
共通エラー情報を参照してください。