基本契約を検索する#
Description#
リクエストパラメータを検索条件として該当する基本契約情報を検索します。
Method#
GET
Request Header#
共通リクエストヘッダーを参照してください。
Argument#
Name | Type | Required | Length (Long/Decimalの場合はValue) |
URI | Query String | Description |
---|---|---|---|---|---|---|
basic_contract_id | String | 15 | - | ○ | 基本契約ID 契約グループを一意に識別するID |
|
customer_id | String | 15 | - | ○ | 顧客ID 顧客を一意に識別するID |
|
business_date | String | 8 | - | ○ | 業務日付 yyyyMMdd形式 |
|
group_id | String | 8 | - | ○ | グループID グループを一意に識別するID |
|
classification_of_contract | String | 1 | - | ○ | 契約種別 | |
bill_to_id | String | 15 | - | ○ | 請求先ID 請求先を一意に識別するID |
|
administration_number | Long | 1 ~ 999 |
- | ○ | 管理番号 | |
free_item1 | String | 1 ~ 1000 |
- | ○ | フリー項目1 | |
free_item2 | String | 1 ~ 1000 |
- | ○ | フリー項目2 | |
free_item3 | String | 1 ~ 1000 |
- | ○ | フリー項目3 | |
free_item4 | String | 1 ~ 1000 |
- | ○ | フリー項目4 | |
free_item5 | String | 1 ~ 1000 |
- | ○ | フリー項目5 | |
free_item6 | String | 1 ~ 1000 |
- | ○ | フリー項目6 | |
free_item7 | String | 1 ~ 1000 |
- | ○ | フリー項目7 | |
free_item8 | String | 1 ~ 1000 |
- | ○ | フリー項目8 | |
free_item9 | String | 1 ~ 1000 |
- | ○ | フリー項目9 | |
free_item10 | String | 1 ~ 1000 |
- | ○ | フリー項目10 | |
sort_item1 | String | 1 ~ 40 |
- | ○ | ソート項目名1 | |
sort1 | String | 1 | - | ○ | ソート順 | |
sort_item2 | String | 1 ~ 40 |
- | ○ | ソート項目名2 | |
sort2 | String | 1 | - | ○ | ソート順 | |
sort_item3 | String | 1 ~ 40 |
- | ○ | ソート項目名3 | |
sort3 | String | 1 | - | ○ | ソート順 | |
start_position | Long | 1 ~ 9999999 |
- | ○ | 開始位置 共通仕様はこちらを参照 |
|
end_position | Long | 1 ~ 9999999 |
- | ○ | 終了位置 共通仕様はこちらを参照 |
URI#
/API/v2/api/basiccontract
Sample request uri#
顧客IDとページング指定の開始位置と終了位置を指定しての検索
/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#
- レスポンス(異常)
共通エラー情報を参照してください。