サービスマスタを編集する

Description

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

Method

POST

Request Header

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

Argument

なし

URI

/API/v2/api/services

Parameters in request body

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

Example

▼ Exampleを展開

{
        "entry_id": "C00000000000043",
        "basic_product_id": "0000000001",
        "basic_product_id_tentative_flag": "1",
        "service_master_edition_list": [
                {
                        "service_code": "0000000001",
                        "service_division": "0",
                        "apply_start_date": "20171201",
                        "reception_start_date": "20171201",
                        "product_type": "1",
                        "administration_number": 1,
                        "release_start_date": "20171201",
                        "status": "3",
                        "free_item":
                        {
                            "release_start_preferred_date":"20171010",
                            "release_end_preferred_date":"20181009"
                        },
                        "free_item1": "1",
                        "service_code_tentative_flag": "1",
                        "service_master_formultilingual_information_list": [
                                {
                                        "language_locale": "ja",
                                        "service_name": "請求代行型サービス",
                                        "service_name_abbreviation": "サブタイトル",
                                        "description": "サービス説明"
                                }
                        ]
                }
        ]
}

Parameters

▼ Request Bodyを展開

Name			Type	Required	Length （Long/Decimalの場合はValue）	Description
entry_id			String	Yes	1 ～ 15	登録者ＩＤ 登録の処理を行ったユーザーのID
basic_product_id			String	Yes	10	基本商品ＩＤ 半角英数字またはハイフン、アンダーバーのみ入力可能
basic_product_id_tentative_flag			String		1	基本商品ＩＤ仮フラグ
service_master_edition_list			list		Multiple	サービスマスタ編集リスト
	service_code		String	Yes	10	サービスコード 商品ＩＤとして使用 半角英数字またはハイフン、アンダーバーのみ入力可能
	service_division		String	Yes	1	サービス区分
	apply_start_date		String		8	適用開始年月日 サービスの適用を開始する年月日（当日を含む） 登録、変更時必須 yyyyMMdd形式
	apply_end_date		String		8	適用終了年月日 サービスの適用を終了する年月日（当日を含む） yyyyMMdd形式
	service_version		String		1 ～ 8	サービスバージョン
	service_image_url		String		1 ～ 256	サービス画像ＵＲＬ
	link_url		String		1 ～ 256	連携先ＵＲＬ
	service_provider_code		String		1 ～ 256	サービス提供者コード
	reception_start_date		String		8	受付開始年月日 サービスの受付開始年月日 登録、変更時必須 yyyyMMdd形式
	reception_end_date		String		8	受付終了年月日 サービスの受付終了年月日 yyyyMMdd形式
	product_type		String	Yes	1	商品種別 サービスの種別
	administration_number		Long	Yes	1 ～ 999	管理番号
	subsidiary_product_id		String		10	従属商品ＩＤ 従属商品となるサービスを表すＩＤ 半角英数字またはハイフン、アンダーバーのみ入力可能
	release_start_date		String		8	公開開始年月日 サービスの公開開始年月日 yyyyMMdd形式
	release_end_date		String		8	公開終了年月日 サービスの公開終了年月日 yyyyMMdd形式
	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	フリー項目１０
	version_info		Long		1 ～ 999999999	バージョン情報 変更、削除時必須 共通仕様はこちらを参照
	service_code_tentative_flag		String		1	サービスコード仮フラグ
	subsidiary_product_id_tentative_flag		String		1	従属商品ＩＤ仮フラグ
	deletion_targeted_flag		String		1	削除対象フラグ 削除時必須
	service_master_formultilingual_information_list		list		Multiple	サービスマスタ多言語用情報リスト
		language_locale	String	Yes	2	言語ロケール
		service_name	String		1 ～ 200	サービス名 登録時必須
		service_name_abbreviation	String		1 ～ 200	サービス名略称
		description	String		1 ～ 3000	説明

Return Codes

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

Response Header

なし

Response Parameter

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

• レスポンス（正常）

Example

▼ Exampleを展開

{
    "basic_product_id":"0000000001",
    "result_information":{
            "result":"OK"
    },
    "service_code_information_list":[
        {
            "service_code":"0000000001",
            "processing_details":"1"
        }
    ]
}

Parameters

▼ Responseを展開

Name		Type	Required	Length （Long/Decimalの場合はValue）	Description
basic_product_id		String		10	基本商品ＩＤ
result_information		list		Single	結果情報
	result	String		2	結果 OKまたはNGを返却
	detailed_result	String		1 ～ 256	結果詳細 NGの場合、エラー内容を返却
service_code_information_list		list		Multiple	サービスコード情報リスト
	service_code	String	Yes	10	サービスコード 商品ＩＤとして使用
	processing_details	String		1	処理内容

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

Top