サービス契約を編集する

Description

入力情報をもとにサービス契約の登録、変更、削除を行います。
変更を行う場合は、未設定の項目をnullで更新するため、編集を行わない項目も設定する必要があります。
また変更、削除を行う場合は、本API実行前に「サービス契約を検索する」にて対象のサービス契約マスタ情報を検索し、「バージョン情報」を取得する必要があります。
（本APIの実行前に「基本契約を編集する」、「サービスマスタを編集する」で基本契約情報とサービスマスタ情報を登録する必要があります。）

Method

POST

Request Header

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

Argument

なし

URI

/API/v2/api/servicecontracts

Parameters in request body

共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。

Example

▼ Exampleを展開

{
    "entry_id":"O00000000000001",
    "customer_id":"123456789012345",
    "administration_number":"1",
    "order_number_get_flag":"1",
    "contract_number_get_flag":"1",
    "individualized_service_contract_edition_list":[
        {
            "service_code":"C000000001",
            "number_of_contracts":"1",
            "service_application_date":"20150703",
            "bill_to_id":"000000000000011",
            "free_item":
                {
                    "free_item":"任意項目"
                },
            "free_item1":"任意項目１",
            "free_item2":"任意項目２",
            "free_item3":"任意項目３"
        }
    ]
}

Parameters

▼ Request Bodyを展開

Name		Type	Required	Length （Long/Decimalの場合はValue）	Description
entry_id		String	Yes	1 ～ 15	登録者ＩＤ 登録の処理を行ったユーザーのID
customer_id		String	Yes	15	顧客ＩＤ 顧客を一意に識別するＩＤ
order_number		String		15	注文番号
contract_number		String		15	契約番号
administration_number		Long	Yes	1 ～ 999	管理番号
order_number_get_flag		String		1	注文番号採番フラグ
contract_number_get_flag		String		1	契約番号採番フラグ
individualized_service_contract_edition_list		list		Multiple	個別サービス契約編集リスト
	version_info	Long		1 ～ 999999999	バージョン情報 変更、削除時必須 共通仕様はこちらを参照
	service_contract_id	String		15	サービス契約ＩＤ サービス契約を一意に識別するＩＤ 変更、削除時必須
	service_code	String	Yes	10	サービスコード 商品ＩＤとして使用 半角英数字またはハイフン、アンダーバーのみ入力可能
	number_of_contracts	Long	Yes	0 ～ 999	契約数
	service_application_date	String		8	サービス申込年月日 顧客がサービスを申し込んだ年月日 実際にサービス提供を行う日付とは異なる 登録、変更時必須 yyyyMMdd形式
	service_end_application_date	String		8	サービス終了申込年月日 顧客がサービス終了を申し込んだ年月日 実際にサービス提供が終了する日付とは異なる yyyyMMdd形式
	apply_start_date	String		8	適用開始年月日 顧客の適用を開始する年月日（当日を含む） 変更時必須 yyyyMMdd形式
	apply_end_date	String		8	適用終了年月日 顧客の適用を終了する年月日（当日を含む） yyyyMMdd形式
	charging_start_date	String		8	課金開始年月日 該当サービスの課金を開始する年月日 変更時必須 yyyyMMdd形式
	charging_end_date	String		8	課金終了年月日 該当サービスの課金を終了する年月日 yyyyMMdd形式
	price_plan_code	String		9	料金プランコード
	bill_to_id	String	Yes	15	請求先ＩＤ 請求先を一意に識別するＩＤ
	status	String		1 ～ 3	ステータス ステータスを表す任意のコード値を設定可能 例) 001：契約中、999：解約済
	free_item	String		1 ～ 30000	フリー項目
	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	フリー項目１０
	deletion_targeted_flag	String		1	削除対象フラグ 削除時必須

Return Codes

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

Response Header

なし

Response Parameter

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

• レスポンス（正常）

Example

▼ Exampleを展開

{
    "order_number":"000000000000007",
    "contract_number":"000000000000007",
    "result_information":{
        "result":"OK"
    },
    "servicecontract_id_information_list":[
        {
            "service_contract_id":"000000000000345"
        }
    ]
}

Parameters

▼ Responseを展開

Name		Type	Required	Length （Long/Decimalの場合はValue）	Description
order_number		String		15	注文番号
contract_number		String		15	契約番号
result_information		list		Single	結果情報
	result	String		2	結果 OKまたはNGを返却
	detailed_result	String		1 ～ 256	結果詳細 NGの場合、エラー内容を返却
servicecontract_id_information_list		list		Multiple	サービス契約ＩＤ情報リスト
	service_contract_id	String	Yes	15	サービス契約ＩＤ サービス契約を一意に識別するＩＤ

• レスポンス（異常）
  共通エラー情報を参照してください。

Top