Skip to content

基本契約を検索する#

Description#

リクエストパラメータを検索条件として該当する基本契約情報を検索します。

Method#

GET

Request Header#

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

Argument#

Name Type Required Length
(Long/Decimalの場合はValue）		 URI Query String Description
basic_contract_id String 15 - ○ 基本契約ＩＤ
契約グループを一意に識別するＩＤ
customer_id String 15 - ○ 顧客ＩＤ
顧客を一意に識別するＩＤ
business_date String 8 - ○ 業務日付
yyyyMMdd形式
group_id String 8 - ○ グループＩＤ
グループを一意に識別するＩＤ
classification_of_contract String 1 - ○ 契約種別
bill_to_id String 15 - ○ 請求先ＩＤ
請求先を一意に識別するＩＤ
administration_number Long 1
～
999		 - ○ 管理番号
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/basiccontract

Sample request uri#

顧客ＩＤとページング指定の開始位置と終了位置を指定しての検索

/API/v2/api/basiccontract?customer_id=C00000000000001&start_position=1&end_position=100

Parameters in request body#

なし

Return Codes#

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

Response Header#

なし

Response Parameter#

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

  • レスポンス（正常）

Example#

Parameters#

Top