【公開停止】水分補給情報登録API(デフォルト記録対応版)

利用者の水分摂取状況を、水分補給の記録タイトルへ連携する登録用API
デフォルト記録に対応

API ID

ML0007

Request URL

hydration/add-d

環境	URL
Staging環境	https://stage-api.link.carekarte.jp/hydration/add-d

環境	URL
本番環境	https://api.link.carekarte.jp/hydration/add-d

HTTPメソッド

POST

リクエスト

header（すべて必須）

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

Body（JSON形式）

パラメータ	型	必須：○ 条件付き：△(※)	サイズ・形式	説明	仕様	CAREKARTEタイトル項目
userId	String	◯	10桁	利用者ID
sdateTime	String	◯	YYYY-MM-DDTHH:mm:ss.sssZ	記録開始日時(UTC)
edateTime	String		YYYY-MM-DDTHH:mm:ss.sssZ	記録終了日時(UTC)	パラメータがない、もしくは記録開始日時より以前の値が入っていた場合は、記録開始日時と同じ値を格納
defaultFlag	boolean			デフォルト記録フラグ	trueの場合、デフォルト記録の処理を行う。 false、もしくはパラメータがない場合、デフォルト記録の処理は行わない。
handoverFlag	boolean			申し送りフラグ	trueの場合、申し送りフラグON false、もしくはパラメータがない場合、申し送りフラグOFF
drink	String	△		飲料		飲料
inMl	Number	△	4桁	水分摂取量（cc）		水分量
place	String	△		場所		※場所
assistLv	String	△		介助レベル		※介助
assistWay	String	△		介助方法		※方法
state	String	△		様子		様子
support	String	△		対応		対応
staffId	String	◯	10桁	職員ID

※必須項目欄の入力項目△については、△部分が全て空の値の場合、記録を作成せず400エラーを返却する。空欄部分の入力有無は、記録の作成に影響しない。
※標準マスタにはない項目（カスタマイズが必要です）

サンプルデータ

{ 
    "userId": "0000000022",
    "sdateTime":"2021-09-18T09:00:00.000Z" ,
    "edateTime":"2021-09-18T09:30:00.000Z" ,
    "staffId": "0000000015",
    "defaultFlag":true,
    "handoverFlag":true,
    "inMl":250,
    "state":"少しずつ時間をかけて摂取されていた"
}

レスポンス

Body（JSON形式）

パラメータ	型	必須	サイズ・形式	説明	仕様	CAREKARTEタイトル項目
userId	String	○	10桁	利用者ID
recordId	Number[array]	○		記録ID	利用者ごとのユニークID

サンプルデータ

記録の登録完了

{
    "userId": "0000000022",
    "recordId": [
        1959
    ]
}

エラー発生時（記録作成対象データがない場合）

{
    "code": 400,
    "timestamp": "9/18/2021, 7:27:02 AM",
    "path": "/hydration/add-d",
    "method": "POST",
    "message": "値が入力されていないため記録を作成できませんでした"
}

連携イメージ(CAREKARTE)

デフォルト記録	連携データ	連携記録の採用データ
あり	あり	連携データ
あり	なし	デフォルト記録
なし	あり	連携データ
なし	なし	該当データなし