【公開停止】申し送りフラグ更新API

作成済みの記録の申し送り設定を操作するAPI。

利用者IDと記録IDを指定し、申し送りフラグを更新したい対象の記録を特定します。
記録タイトルの種類を問わず操作可能です。

API ID

H0002

Request URL

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

HTTPメソッド

POST

リクエスト

header（すべて必須）

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

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10 利用者ID    
recordId Number ○   記録ID    
handoverFlag Boolean ○   申し送りフラグ true:申し送りセット。
false：申し送りセットなし。		  

サンプルデータ

{ 
    "userId": "0000000025",
    "recordId": 357,
    "handoverFlag":true
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10 利用者ID    
recordId Number ○   記録ID    
handoverFlag Boolean ○   申し送りフラグ true:申し送りセット。
false：申し送りセットなし。		  

サンプルデータ

記録の更新完了

{
    "userId": "0000000025",
    "recordId": 357,
    "handoverFlag": true
}

API個別エラー

HTTPコード message
400 “UserId does not exist”
400 “UserId and recordId does not exist”
400 “Error executing update statement” 
{
    "code": 400,
    "timestamp": "9/11/2021, 4:47:34 AM",
    "path": "/handover/update",
    "method": "POST",
    "message": "UserId and recordId does not exist"
}

連携イメージ(CAREKARTE)