Skip to content

割引契約を検索する#

Description#

リクエストパラメータ「顧客ＩＤ」「基本契約ＩＤ」「請求先ＩＤ」「割引契約ＩＤ」「（割引対象の）サービス契約ＩＤ」「サービスコード」「ステータス」、各フリー項目を設定し、該当する割引契約情報を検索します。

Method#

GET

Request Header#

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

Argument#

Name Type Required Length
(Long/Decimalの場合はValue）		 URI Query String Description
service_application_date_from String 8 - ○ サービス申込年月日Ｆｒｏｍ
入力値のサービス申込年月日以降を検索
yyyyMMdd形式
service_application_date_to String 8 - ○ サービス申込年月日Ｔｏ
入力値のサービス申込年月日以前を検索
yyyyMMdd形式
service_end_application_date_from String 8 - ○ サービス終了申込年月日Ｆｒｏｍ
入力値のサービス終了申込年月日以降を検索
yyyyMMdd形式
service_end_application_date_to String 8 - ○ サービス終了申込年月日Ｔｏ
入力値のサービス終了申込年月日以前を検索
yyyyMMdd形式
service_code String 1
～
10		 - ○ サービスコード
商品ＩＤとして使用
半角英数字またはハイフン、アンダーバーのみ入力可能
customer_id String 15 - ○ 顧客ＩＤ
顧客を一意に識別するＩＤ
basic_contract_id String 15 - ○ 基本契約ＩＤ
契約グループを一意に識別するＩＤ
order_number String 15 - ○ 注文番号
contract_number String 15 - ○ 契約番号
administration_number Long 1
～
999		 - ○ 管理番号
status String 1
～
59		 - ○ ステータス
ステータスを表す任意のコード値を設定可能
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定
例)001：契約中、999：解約済
service_contract_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		 - ○ フリー項目１０
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		 - ○ 終了位置
共通仕様はこちらを参照
charge_info_retrieval_flg String 1 - ○ 料金情報取得有無フラグ
discount_contract_id String 15 - ○ 割引契約ＩＤ
割引契約を一意に識別するＩＤ
apply_start_month_from String 6 - ○ 適用開始年月Ｆｒｏｍ
入力値の適用開始年月以降
yyyyMM形式
apply_start_month_to String 6 - ○ 適用開始年月Ｔｏ
入力値の適用開始年月以前
yyyyMM形式
apply_end_month_from String 6 - ○ 適用終了年月Ｆｒｏｍ
入力値の適用終了年月以降
yyyyMM形式
apply_end_month_to String 6 - ○ 適用終了年月Ｔｏ
入力値の適用終了年月以前
yyyyMM形式

URI#

/API/v2/api/discountcontracts

Sample request uri#

「割引契約ＩＤ」、ページング指定の開始位置と終了位置、料金情報取得有無フラグを指定しての検索

/API/v2/api/discountcontracts?discount_contract_id=000000000001620
                             &start_position=1
                             &end_position=1
                             &charge_info_retrieval_flg=1

Parameters in request body#

なし

Return Codes#

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

Response Header#

なし

Response Parameter#

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

  • レスポンス（正常）

Example#

Parameters#

Top