【公開停止】睡眠サマリ情報登録API

主に睡眠中のセンサー取得情報をサマリ化し、睡眠情報の記録タイトルへ連携する登録用API

API ID

SLP0002

Request URL

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

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) 未記入の場合、記録開始日時と同じ日時をセット  
wakeuptm String   YYYY-MM-DDTHH:mm:ss.sss 臥床時刻 標準時は使わず、記録された時間をそのままセット ※臥床時刻
getouttm String   YYYY-MM-DDTHH:mm:ss.sss 離床時刻 標準時は使わず、記録された時間をそのままセット ※離床時刻
respavg Number     平均呼吸   ※平均呼吸数
hbavg Number     平均心拍   ※平均心拍
bodymv String     体動 連携可能文字列：体動
対象文字列があった場合チェックボックスON		 ※体動
bedhr String     在床時間   ※在床時間
sleephr String     睡眠時間   ※睡眠時間
awakecnt Number     覚醒回数   ※覚醒回数
getoutcnt Number     離床回数   ※離床回数
toiletcnt Number     トイレ回数   ※トイレ回数
sleepstt String     睡眠状態   ※睡眠状態
sleepstg String     睡眠段階 “0”,”1″,”2″,”3″,”4″,”5″の入力された文字列に対応する段階のチェックボックスON ※睡眠段階
bedstg String     ベッド段階 “0”,”1″,”2″,”3″,”10″,”255″の入力された文字列に対応する状態のチェックボックスON
0：不在
1：覚醒
2：浅い眠り
3：深い眠り
10：在(睡眠不明)
255：エラー		 ※ベッド段階
ncart Number     コール回数   ※コール回数
state String     様子   ※様子
support String     対応   ※対応
report String     申し送り   ※申し送り
summaryurl String     参照URL サマリ情報を記録した外部URLアドレスがある場合セット ※参照URL
staffId String   10桁 職員ID 未入力の場合、記録者は「CKAPI」と登録
または、連携用職員の用意により固定のIDをセット		  

※カスタマイズでの項目追加ではなく、睡眠情報連携用標準タイトルとなります

サンプルデータ

{ 
    "userId": "0000000025",
    "sdateTime":"2021-07-27T22:00:00.000Z" ,
    "edateTime":"2021-07-27T22:00:00.000Z",
    "staffId":"0000000004",
    "wakeuptm":"2021-07-27T22:00:00.000",
    "getouttm":"2021-07-27T22:00:00.000",
    "respavg":160.23,
    "hbavg":290.12,
    "bodymv": "体動",
    "bedhr":"21:38",
    "sleepstg": "3",
    "sleepstt":"覚醒状態にて臥床"
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
status Number ○ 1桁   処理結果を返却
recordId Number[array] ○   記録ID 利用者ごとのユニークID

サンプルデータ

記録の登録完了
{
    "status": 0,
    "recordId": [
        342
    ]
}

エラー発生時（日時のフォーマットが間違っている場合）
{
    "code": 400,
    "timestamp": "9/11/2021, 12:56:30 AM",
    "path": "/slp/add2",
    "method": "POST",
    "message": "Validation failed: wakeuptm must be a ISOString"
}

連携イメージ(CAREKARTE)