Skip to content

サービス契約の件数を取得する#

Description#

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

Method#

GET

Request Header#

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

Argument#

Name Type Required Length
(Long/Decimalの場合はValue)		 URI Query String Description
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形式
charging_start_date_from String 8 - ○ 課金開始年月日Ｆｒｏｍ
入力値の課金開始年月日以降
yyyyMMdd形式
charging_start_date_to String 8 - ○ 課金開始年月日Ｔｏ
入力値の適用開始年月日以前
yyyyMMdd形式
charging_end_date_from String 8 - ○ 課金終了年月日Ｆｒｏｍ
入力値の課金終了年月日以降
yyyyMMdd形式
charging_end_date_to String 8 - ○ 課金終了年月日Ｔｏ
入力値の課金終了年月日以前
yyyyMMdd形式
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形式
cancel_date_from String 8 - ○ キャンセル年月日Ｆｒｏｍ
入力値のキャンセル年月日以降
yyyyMMdd形式
cancel_date_to String 8 - ○ キャンセル年月日Ｔｏ
入力値のキャンセル年月日以前
yyyyMMdd形式
service_code String 1
～
10		 - ○ サービスコード
商品ＩＤとして使用
半角英数字またはハイフン、アンダーバーのみ入力可能
customer_id String 15 - ○ 顧客ＩＤ
顧客を一意に識別するＩＤ
basic_contract_id String 15 - ○ 基本契約ＩＤ
契約グループを一意に識別するＩＤ
bill_to_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 - ○ サービス契約ＩＤ
サービス契約を一意に識別するＩＤ
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/servicecontractslistcount

Sample request uri#

適用開始年月日fromを指定しての検索

/API/v2/api/servicecontractslistcount?apply_start_date_from=20150620

Parameters in request body#

なし

Return Codes#

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

Response Header#

なし

Response Parameter#

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

  • レスポンス（正常）

Example#

Parameters#

Top