カテゴリ所属マスタを編集する
Description
入力情報をもとにカテゴリ所属マスタ情報の登録、変更、削除を行います。
変更を行う場合は、未設定の項目をnullで更新するため、編集を行わない項目も設定する必要があります。
また変更、削除を行う場合は、本API実行前に「カテゴリ所属マスタを検索する」にて対象のカテゴリ所属マスタ情報を検索し、「バージョン情報」を取得する必要があります。
共通リクエストヘッダーを参照してください。
Method
POST
Argument
なし
URI
/API/v2/api/categorybelonging
Parameters in request body
共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。
Example
{
"entry_id":"C10000000000001",
"category_belonging_master_edition_list": [
{
"category_id":"100000000000005",
"service_code":"0000000001",
"apply_start_date":"20170710",
"apply_end_date":"20231231",
"display_priority": 1,
"free_item":
{
"Item01":"AAA",
"Item02":"BBB"
},
"free_item1":"AAA",
"free_item2":"BBB",
"free_item3":"CCC",
"free_item4":"DDD",
"free_item5":"EEE",
"free_item6":"FFF",
"free_item7":"GGG",
"free_item8":"HHH",
"free_item9":"III",
"free_item10":"JJJ"
}
]
}
Parameters
Name |
Type |
Required |
Length
(Long/Decimalの場合はValue) |
Description |
entry_id |
String |
Yes |
1 ~ 15 |
登録者ID
登録の処理を行ったユーザーのID |
category_master_edition_list |
list |
|
Multiple |
カテゴリ所属マスタ編集リスト |
|
category_belonging_id |
String |
|
15 |
カテゴリ所属ID
カテゴリ所属を一意に識別するID
登録、変更時必須 |
category_id |
String |
|
15 |
カテゴリID
カテゴリを一意に識別するID
登録時必須 |
service_code |
String |
|
10 |
サービスコード
商品IDとして使用
登録時必須
半角英数字またはハイフン、アンダーバーのみ入力可能 |
apply_start_date |
String |
|
8 |
適用開始年月日
サービスの適用を開始する年月日(当日を含む)
登録、変更時必須
yyyyMMdd形式 |
apply_end_date |
String |
|
8 |
適用終了年月日
顧客の適用を終了する年月日(当日を含む)
yyyyMMdd形式 |
display_priority |
Long |
|
1 ~ 999 |
表示優先度
表示優先度を表す |
free_item |
String |
|
1 ~ 30000 |
フリー項目 |
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 |
version_info |
Long |
|
1 ~ 999999999 |
バージョン情報
変更、削除時必須
共通仕様はこちらを参照 |
deletion_targeted_flag |
String |
|
1 |
削除対象フラグ
削除時必須 |
Return Codes
Code |
Description |
200 |
レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。 |
401 |
認証エラー。API認証時のエラー。 |
403 |
アクセス不可 |
404 |
対象なし。対象の情報が見つからない場合。 |
409 |
排他エラー。対象の情報が別のプロセスによって処理されている場合。 |
500 |
業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。 |
なし
Response Parameter
共通仕様はこちらを参照してください。
Example
{
"result_information":{
"result":"OK"
},
"category_belonging_id_information_list":[
{
"category_belonging_id":"000000000000001"
}
]
Parameters
Name |
Type |
Required |
Length
(Long/Decimalの場合はValue) |
Description |
result_information |
list |
|
Single |
結果情報 |
|
result |
String |
|
2 |
結果
OKまたはNGを返却 |
detailed_result |
String |
|
1 ~ 256 |
結果詳細
NGの場合、エラー内容を返却 |
category_belonging_id_information_list |
list |
|
Multiple |
カテゴリ所属ID情報リスト |
|
category_belonging_id |
String |
Yes |
15 |
カテゴリ所属ID
カテゴリ所属を一意に識別するID |
Top