Skip to content

サービスマスタを検索する#

Description#

リクエストパラメータを検索条件として該当するサービスマスタ情報を検索します。

Method#

GET

Request Header#

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

Argument#

Name Type Required Length
Long/Decimalの場合はValue)		 URI Query String Description
service_code String 10 - ○ サービスコード
半角英数字またはハイフン、アンダーバーのみ入力可能
service_name String 1
～
200		 - ○ サービス名
service_division String 1 - ○ サービス区分
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形式
reception_start_date_from String 8 - ○ 受付開始年月日Ｆｒｏｍ
入力値の受付開始年月日以降
yyyyMMdd形式
reception_start_date_to String 8 - ○ 受付開始年月日Ｔｏ
入力値の受付開始年月日以前
yyyyMMdd形式
reception_end_date_from String 8 - ○ 受付終了年月日Ｆｒｏｍ
入力値の受付終了年月日以降
yyyyMMdd形式
reception_end_date_to String 8 - ○ 受付終了年月日Ｔｏ
入力値の受付終了年月日以前
yyyyMMdd形式
release_start_date_from String 8 - ○ 公開開始年月日Ｆｒｏｍ
入力値の公開開始年月日以降
yyyyMMdd形式
release_start_date_to String 8 - ○ 公開開始年月日Ｔｏ
入力値の公開開始年月日以前
yyyyMMdd形式
release_end_date_from String 8 - ○ 公開終了年月日Ｆｒｏｍ
入力値の公開終了年月日以降
yyyyMMdd形式
release_end_date_to String 8 - ○ 公開終了年月日Ｔｏ
入力値の公開終了年月日以前
yyyyMMdd形式
basic_product_id String 10 - ○ 基本商品ＩＤ
半角英数字またはハイフン、アンダーバーのみ入力可能
administration_number Long 1
～
999		 - ○ 管理番号
product_type String 1 - ○ 商品種別
サービスの種別
category_id String 15 - ○ カテゴリＩＤ
カテゴリを一意に識別するＩＤ
status String 1
～
59		 - ○ ステータス
ステータスを表す任意のコード値を設定可能
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定
例)001：契約中、999：解約済
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		 - ○ フリー項目１０
sort_item1 String 1
～
40		 - ○ ソート項目名１
sort1 String 1 - ○ ソート順
sort_item2 String 1
～
40		 - ○ ソート項目名２
sort2 String 1 - ○ ソート順
sort_item3 String 1
～
40		 - ○ ソート項目名３
sort3 String 1 - ○ ソート順
start_position Long 1
～
9999999		 - ○ 開始位置
共通仕様はこちらを参照
end_position Long 1
～
9999999		 - ○ 終了位置
共通仕様はこちらを参照

URI#

/API/v2/api/services

Sample request uri#

ソート項目名１、ソート順１を指定しての検索

/API/v2/api/services?sort_item1=service_code&sort1=0

Parameters in request body#

なし

Return Codes#

Code Description
200 レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。
401 認証エラー。API認証時のエラー。
403 アクセス不可
404 対象なし。対象の情報が見つからない場合。
500 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。

Response Header#

なし

Response Parameter#

共通仕様はこちらを参照してください。

  • レスポンス（正常）

Example#

Parameters#

Top