利用者基本情報更新API

CAREKARTEに登録済みの利用者基本情報を更新するAPI

利用者を特定して基本情報を更新可能です。
基本情報以外に所属情報の期間も変更が可能です。

API ID

U0008

Request URL

user/update
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/user/update
環境 URL
本番環境 https://api.link.carekarte.jp/user/update

HTTPメソッド

POST

リクエスト

header（すべて必須）

名前 値
Content-Type application/json
authorization tokenサービスで取得した値を設定

Body（JSON形式）

パラメータ 型 必須：○
条件付き必須：●(※)		 サイズ・形式 説明 仕様
userId String ○ 10桁 個人番号  
family String ● 40Byte 姓  
given String ● 40Byte 名  
kanafamily String ● 半角20文字 姓フリガナ （半角カナ）  
kanagiven String ● 半角20文字 名フリガナ（半角カナ）  
birth String ● YYYYYMMDD 生年月日  
sex Number ● 1桁 性別 1：男
2：女
nicknm String   40Byte システム表示名  
postCd String   7桁 郵便番号  
telarea String   4桁 市外局番  
telcity String   4桁 市内局番  
telnm String   4桁 加入者番号  
kencd String   2桁 都道府県コード  
citycd String   3桁 区市町村コード  
addr1 String   60Byte 住所1  
addr2 String   60Byte 住所2  
staffId String   10桁 更新者  
belong [array]     所属 所属を追加登録する場合は下記パラメータ全ての入力が必要（一部のみの登録ではエラー返却）
すでにcorpCd+officeCd+blockCd+unitCdが重複する所属があった場合は、sdateおよびedateを更新する
同じ所属が存在しない場合は追加で所属を追加する
　corpCd String ○ 1桁 法人コード ※基本的には1
　officeCd String ○ 2桁 事業所コード  
　blockCd String ○ 2桁 ブロックコード  
　unitCd String ○ 3桁 ユニットコード  
　sdate String ● YYYY-MM-DD HH:㎜:ss 所属開始日(JST)  
　edate String   YYYY-MM-DD HH:㎜:ss 所属終了日(JST)  

※空欄（値なし）不可。パラメータに対して値なし(“”やnull指定)だった場合はエラーとして返却。パラメータを省略可能だがその場合はその項目の既存情報を更新しない。

サンプルデータ

{
    "userId": "1400052182",
    "family": "更新",
    "given": "テスト利用者",
    "kanafamily": "ｺｳｼﾝ",
    "kanagiven": "ﾃｽﾄﾘﾖｳｼｬ",
    "birth": "19800101",
    "sex": 2,
    "nicknm": "こ・う・し・ん",
    "postCd": "4521234",
    "telarea": "1111",
    "telcity": "2222",
    "telnm": "3333",
    "kencd": "22",
    "citycd": "100",
    "staffId":"0000000004",
    "addr1": "静岡県静岡市葵区XX-XXX",
    "addr2": "住所2住所2住所2住所2",
    "belong": [
        {
            "corpCd": "1",
            "officeCd": "01",
            "blockCd": "01",
            "unitCd": "001",
            "sdate": "2021-10-01 15:00:00",
            "edate": "2023-06-24 15:00:00"
        }
    ]
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
userId String ○ 10桁 利用者ID  
message String     エラーメッセージ エラー等、メッセージがあれば返却

サンプルデータ

正常データ更新時
{
    "userId": "1400052182"
}

API個別エラー

HTTPコード message エラー説明
400 “Invalid belong” 所属が既存レコードと重複しています。
400 “UserId does not exist” 指定した利用者IDのレコードが見つかりませんでした。
400 “Validation failed: userId must be longer than or equal to 10 characters” 利用者IDの文字数を修正してください。
400 “Validation failed: sex must be a number” 性別の形式を修正してください。 
{
    "code": 400,
    "timestamp": "10/3/2021, 7:51:14 AM",
    "path": "/user/update",
    "method": "POST",
    "message": "UserId does not exist"
}

連携イメージ(CAREKARTE)