利用者所属更新API

利用者の所属期間を更新するAPI

所属の開始日と終了日を変更するAPIです。
APIキーが関連付けされている事業所以外も更新可能です。
法人コードや事業所コードはO0001：事業所情報取得APIなどで取得してください。

当APIでは所属組織の変更はできないため、所属組織を変更する場合はUB0003：利用者所属削除API、UB0001：利用者所属登録APIを使用してください。

法人コード、事業所コード、ブロックコード、ユニットコード、利用者ID、更新前所属開始日で更新するレコードを指定してください。
CAREKARTEではこれらの値の組み合わせでレコードが一意となります。

更新後所属開始日、更新後所属終了日で更新後の値を指定してください。

既存のレコードと更新する期間が重複する場合、エラーコードEL409000が返却されます。
CAREKARTEからの操作では、所属期間が重複する場合があります。

API ID

UB0002

Request URL

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

HTTPメソッド

POST

リクエスト

ヘッダー

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

ボディ

パラメータ名 物理パラメータ名 型 必須 文字桁数 文字種/形式 仕様
法人コード corpCd String 〇 1桁 半角数字  
事業所コード officeCd String 〇 2桁 半角数字  
ブロックコード blockCd String 〇 2桁 半角数字  
ユニットコード unitCd String 〇 3桁 半角数字  
利用者ID userId String 〇 10桁 半角数字 U0007　事業所所属利用者一覧取得API等から取得してください。
更新前所属開始日 srcSdate String        
更新後所属開始日 updSdate String 〇   YYYY-MM-DD  
更新後所属終了日 updEdate String     YYYY-MM-DD 未定の場合、2500-01-01でリクエストしてください。
更新職員ID updStfId String 〇 10桁 半角数字 ST0003　事業所所属職員一覧取得API等から取得してください。
CAREKAETE上では基本情報の更新者として保存されます。

サンプルデータ

{
    "corpCd": "1",
    "officeCd": "01",
    "blockCd": "01",
    "unitCd": "001",
    "userId": "0000000001",
    "srcSdate": "2023-06-24",
    "updSdate": "2021-10-01",
    "updEdate": "2023-06-24",
    "updStfId":"0000000001"
}
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 型 文字桁数 文字種/形式 仕様
利用者番号 userId String 10桁   リクエストしたuserIdが返却されます

 

利用者所属の更新に成功した際のサンプルデータ

{
    "userId": "0000000001"
}

エラーレスポンス

メニューのエラーレスポンスを参照してください

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEで所属を確認できる画面です。