Skip to content

カテゴリマスタの件数を取得する#

Description#

リクエストパラメータを検索条件として該当するカテゴリマスタ情報の件数を返却します。
本APIは、「カテゴリマスタを検索する」で検索する対象レコード数を事前に取得するために使用します。

Method#

GET

Request Header#

共通リクエストヘッダーを参照してください。

Argument#

Name Type Required Length
(Long/Decimalの場合はValue)		 URI Query String Description
category_id String 15 - ○ カテゴリＩＤ
カテゴリを一意に識別するＩＤ
category_name String 1
～
50		 - ○ カテゴリ名
apply_start_date_from String 8 - ○ 適用開始年月日Ｆｒｏｍ
入力値の適用開始年月日以降
yyyyMMdd形式
apply_start_date_to String 8 - ○ 適用開始年月日Ｔｏ
入力値の適用開始年月日以前
yyyyMMdd形式
apply_end_date_from String 8 - ○ 適用終了年月日Ｆｒｏｍ
入力値の適用終了年月日以降
yyyyMMdd形式
apply_end_date_to String 8 - ○ 適用終了年月日Ｔｏ
入力値の適用終了年月日以前
yyyyMMdd形式
display_flag String 1 - ○ 表示フラグ
カテゴリの表示フラグ
service_code String 10 - ○ サービスコード
商品ＩＤとして使用
半角英数字またはハイフン、アンダーバーのみ入力可能
upper_hierarchy_category_id String 15 - ○ 階層上位カテゴリＩＤ
上位のカテゴリを表す
language_locale String 2 - ○ 言語ロケール
free_item1 String 1
～
1000		 - ○ フリー項目１
free_item2 String 1
～
1000		 - ○ フリー項目２
free_item3 String 1
～
1000		 - ○ フリー項目３
free_item4 String 1
～
1000		 - ○ フリー項目４
free_item5 String 1
～
1000		 - ○ フリー項目５
free_item6 String 1
～
1000		 - ○ フリー項目６
free_item7 String 1
～
1000		 - ○ フリー項目７
free_item8 String 1
～
1000		 - ○ フリー項目８
free_item9 String 1
～
1000		 - ○ フリー項目９
free_item10 String 1
～
1000		 - ○ フリー項目１０

URI#

/API/v2/api/categorycount

Sample request uri#

カテゴリ名と適用開始日Fromを指定しての検索

/API/v2/api/categorycount?category_name=カテゴリ名&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#

Top