【公開停止】食事情報取得API

利用者の食事情報を、食事の記録タイトルから連携する取得用API

日付指定でデータの取得が可能

API ID

ML0009

Request URL

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

HTTPメソッド

POST

リクエスト

header(すべて必須)

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

Body(JSON形式)

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10桁 利用者ID    
recordId Number     レコードID    
selectDate String   YYYY-MM-DD データ取得日

指定した日付の記録の一覧を取得

JST時刻

 

サンプルデータ

{
    "userId": "0000000068",
    "recordId":18394,
    "selectDate":"2021-11-24"
}

レスポンス

Body(JSON形式)

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10 利用者ID    
selectDate String ○ YYYY-MM-DD データ取得日 JST時刻  
message String     メッセージ エラー等、メッセージがあれば返却  
records Array ○   取得情報 データが存在しない場合は省略  
 recordId String ○   レコードID    
 dateTime String ○ YYYY-MM-DD HH:mm:ss 食事摂取開始日時 JST時刻  
 edateTime String ○ YYYY-MM-DD HH:mm:ss 食事摂取終了日時 JST時刻  
 mainMl Number ○   主食   主食
 subMl Number ○   副食   副食
 inMl Number ○   水分摂取量(cc)   水分量
 liquidMl Number ○   流動食摂取量(cc)   流動食
 assistLv String ○   介助レベル   介助
 place String ○   場所   場所
 state String ○   様子   様子
 support String ○   対応   対応

サンプルデータ

記録の取得完了

{
    "userId": "0000000068",
    "selectDate": "2021-11-24",
    "records": [
        {
            "recordId": 18394,
            "dateTime": "2021-11-24 20:00:00",
            "edateTime": "2021-11-24 20:15:00",
            "mainMl": 10,
            "subMl": 9,
            "inMl": 8,
            "liquidMl": 7,
            "assistLv": "見守り",
            "place": "ステーション",
            "state": "様子",
            "support": "対応"
        }
    ]
}

エラー発生時(seletDateで指定した日に食事の記録が存在しない場合)

{
    "userId": "0000000068",
    "selectDate": "2021-11-20",
    "message": "指定の記録は存在しませんでした"
}

連携イメージ(CAREKARTE)

その他

記録取得処理方法

記録取得の処理順は下記の通りです。No.1から処理の優先順となります。

No. 条件 処理
1 recordIdが入力されているかつ 
userIdに紐づけられた同値のrecordIdが存在する
入力されたrecordIdの記録を取得。
recordIdが存在するがTitleTagsの設定が異なる(別タイトル)での記録だった場合エラー返却
2 recordIdが入力されているかつ 
userIdに紐づけられた同値のrecordIdが存在しない 
もしくは削除された記録である場合
selectDateの処理(No.3)に移る。
3 recordIdが入力されていない 
もしくはuserIdに紐づけられた同値のrecordIdが無効
かつ selectDateが入力されている
指定日時の記録を取得。
同日時の記録が複数ある場合は指定日時の対応する記録を全て取得する。
指定日時に記録がない場合は「指定の記録は存在しませんでした」メッセージが表示される。
4 recordIdが入力されていない もしくは
userIdに紐づけられた同値のrecordIdが無効
かつ selectDateが入力されていない
userIdの対応する最新の記録を取得。
この時selectDateにはデータ取得リクエストを送った現在日が入力される