利用者基本情報登録API

利用者基本情報を登録するAPI

利用者の基本情報とCAREKARTEの所属情報を登録するAPIです。
1人1件ずつの登録ですが、所属情報は複数登録可能となります。
CAREKARTEの仕様上、所属情報が存在しない利用者は画面上に表示されないため、
入所前等で所属が不明な場合も、API登録時には仮としていずれかのユニットに所属が必要となります。

API ID

U0006

Request URL

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

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]     所属 必須ではないが、対象事業所の所属登録がないとCAREKARTEから参照不可
　corpCd String ○ 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)  

サンプルデータ

{
    "userId": null,
    "family": "新規",
    "given": "利用者太郎",
    "kanafamily": "ｼﾝｷｷﾞ",
    "kanagiven": "ﾘﾖｳｼｬﾀﾛｳ",
    "birth": "19800101",
    "sex": 1,
    "nicknm": "シンキタロウ",
    "postCd": "0791143111",
    "telarea": "11112222",
    "telcity": "22223333",
    "telnm": "33334444",
    "kencd": "01",
    "citycd": "001",
    "addr1": "静岡県静岡市葵区XX-XXX",
    "addr2": "住所2住所2住所2住所2",
    "belong": [
        {
            "corpCd": "1",
            "officeCd": "01",
            "blockCd": "01",
            "unitCd": "001",
            "sdate": "2021-09-24 15:00:00",
            "edate": "2022-10-24 15:00:00"
        }
    ]
}

レスポンス

Body（JSON形式）

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

サンプルデータ

正常データ登録時
{
    "userId": "1400052182"
}

API個別エラー

400 “Invalid belong” 所属が既存レコードと重複しています。
400 ” 個人番号が大きすぎます。登録可能な個人番号を入力してください “ リクエスト内容を修正してください。
400 ” 個人番号が適切ではありません “ 個人番号が既存レコードと重複しています。
400 “Validation failed: 個人番号が適切ではありません” 個人番号の形式を修正してください。
400 “Validation failed: 入力が適切ではありません” 各パラメータの形式を確認して、修正してください。 
{
    "code": 400,
    "timestamp": "10/3/2021, 7:26:03 AM",
    "path": "/user/add1",
    "method": "POST",
    "message": " 個人番号が適切ではありません "
}

連携イメージ(CAREKARTE)