顧客を変更する
Description
URIパラメータに指定された「顧客ID」とBody部に設定された「バージョン情報」に合致する顧客情報に対し、変更処理を行います。
なお、未設定の項目をnullで更新するため、変更を行わない項目も設定する必要があります。
Method
PUT
共通リクエストヘッダーを参照してください。
Argument
Name |
Type |
Required |
Length(Long /Decimalの場合はValue) |
URI |
Query String |
Description |
customer_id |
String |
Yes |
15 |
○ |
- |
顧客ID |
URI
/API/v2/api/customers/{customer_id}
Sample request uri
/API/v2/api/customers/C00000000000001
Parameters in request body
共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。
Example
{
"version_info":"1",
"entry_id":"test00000000001",
"customer_name1":"名前変更1",
"email_address1":"xxxxx@xx.xx",
"address_of_workplace1":"変更会社住所1",
"apply_start_date":"20170401",
"apply_end_date":"20990331",
"temporary_registration_date_and_time":"20170701093000000",
"official_registration_date_and_time":"20170801093000000",
"cancellation_date_and_time":"20191231093000000",
"status":"002",
"free_item":
{
"変更":"aaa"
},
"free_item1":"【変更】フリー項目1",
"free_item2":"【変更】フリー項目2",
"free_item3":"【変更】フリー項目3"
}
Parameters
Name |
Type |
Required |
Length
(Long /Decimalの場合はValue) |
Description |
version_info |
Long |
Yes |
1 ~ 999999999 |
バージョン情報
共通仕様はこちらを参照 |
entry_id |
String |
Yes |
1 ~ 15 |
登録者ID
登録の処理を行ったユーザーのID
|
customer_name1 |
String |
Yes |
1 ~ 128 |
顧客名1 |
customer_name2 |
String |
|
1 ~ 128 |
顧客名2 |
customer_name3 |
String |
|
1 ~ 128 |
顧客名3 |
customer_name4 |
String |
|
1 ~ 128 |
顧客名4 |
customer_name5 |
String |
|
1 ~ 128 |
顧客名5 |
customer_name6 |
String |
|
1 ~ 128 |
顧客名6 |
nationality |
String |
|
1 ~ 80 |
国籍 |
gender |
String |
|
1 ~ 2 |
性別
性別を表す任意のコード値を設定可能
例)01:男性、02:女性 |
date_of_birth |
String |
|
1 ~ 8 |
生年月日
yyyyMMdd形式 |
zip_code |
String |
|
1 ~ 7 |
郵便番号 |
address1 |
String |
|
1 ~ 30 |
住所1 |
address2 |
String |
|
1 ~ 30 |
住所2 |
address3 |
String |
|
1 ~ 30 |
住所3 |
address4 |
String |
|
1 ~ 30 |
住所4 |
phone_number1 |
String |
|
1 ~ 30 |
電話番号1 |
phone_number2 |
String |
|
1 ~ 30 |
電話番号2 |
email_address1 |
String |
|
1 ~ 256 |
メールアドレス1
メールアドレス形式 |
email_address2 |
String |
|
1 ~ 256 |
メールアドレス2
メールアドレス形式 |
occupation |
String |
|
1 ~ 100 |
職業 |
company_name |
String |
|
1 ~ 64 |
会社名 |
department |
String |
|
1 ~ 80 |
部署 |
position |
String |
|
1 ~ 60 |
役職 |
postcode_of_workplace |
String |
|
1 ~ 7 |
勤め先郵便番号 |
address_of_workplace1 |
String |
|
1 ~ 30 |
勤め先住所1 |
address_of_workplace2 |
String |
|
1 ~ 30 |
勤め先住所2 |
address_of_workplace3 |
String |
|
1 ~ 30 |
勤め先住所3 |
address_of_workplace4 |
String |
|
1 ~ 30 |
勤め先住所4 |
apply_start_date |
String |
Yes |
8 |
適用開始年月日
顧客の適用を開始する年月日(当日を含む)
yyyyMMdd形式 |
apply_end_date |
String |
|
8 |
適用終了年月日
顧客の適用を終了する年月日(当日を含む)
yyyyMMdd形式 |
temporary_registration_date_and_time |
String |
|
17 |
仮登録日時
yyyyMMddHHmmssSSS形式 |
official_registration_date_and_time |
String |
|
17 |
本登録日時
yyyyMMddHHmmssSSS形式 |
cancellation_date_and_time |
String |
|
17 |
解約日時
yyyyMMddHHmmssSSS形式 |
status |
String |
|
1 ~ 3 |
ステータス
ステータスを表す任意のコード値を設定可能
例) 000:仮登録、001:本登録、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 |
Return Codes
Code |
Description |
200 |
レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。 |
401 |
認証エラー。API認証時のエラー。 |
403 |
アクセス不可。 |
404 |
対象なし。対象の情報が見つからない場合。 |
409 |
排他エラー。対象の情報が別のプロセスによって処理されている場合。 |
500 |
業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。 |
なし
Response Parameter
共通仕様はこちらを参照してください。
Example
{
"customer_id":"C00000000000001",
"version_info":2,
"result_information":{
"result":"OK"
}
}
Parameters
Name |
Type |
Required |
Length
(Long /Decimalの場合はValue) |
Description |
customer_id |
String |
Yes |
15 |
顧客ID
顧客を一意に識別するID |
version_info |
Long |
Yes |
1 ~ 999999999 |
バージョン情報
共通仕様はこちらを参照 |
result_information |
list |
|
Single |
結果情報 |
|
result |
String |
|
2 |
結果
OKまたはNGを返却 |
detailed_result |
String |
|
1 ~ 256 |
結果詳細
NGの場合、エラー内容を返却 |
Top