利用者所属削除API

利用者の所属期間を削除するAPI
所属期間を終了させたい場合は、利用者所属更新APIで終了日を変更してください。

APIキーが関連付けされている事業所以外も削除可能です。
法人コードや事業所コードはO0001：事業所情報取得APIなどで取得してください。

削除方法は物理削除になるため、誤って削除した場合、UB0001：利用者所属登録APIで登録しなおしてください。

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

API ID

UB0003

Request URL

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

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等から取得してください。
所属開始日 sdate String 〇   YYYY-MM-DD  
職員ID staffId String 〇 10桁 半角数字 ST0003　事業所所属職員一覧取得API等から取得してください。
CAREKAETE上では基本情報の更新者として保存されます。

サンプルデータ

{
    "corpCd": "1",
    "officeCd": "01",
    "blockCd": "01",
    "unitCd": "001",
    "userId": "0000000001",
    "sdate": "2021-10-01"
    "staffId": "0000000002"
}

レスポンス

ボディ

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

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

{
    "userId": "0000000001",
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

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