睡眠中のセンサー取得情報を、睡眠情報の記録タイトルへ連携する登録用API
主に都度検知に使用する
API ID
SLP0001
Request URL
slp/add
| 環境 | URL |
|---|---|
| Staging環境 | https://stage-api.link.carekarte.jp/slp/add |
| 環境 | URL |
|---|---|
| 本番環境 | https://api.link.carekarte.jp/slp/add |
HTTPメソッド
POST
リクエスト
header(すべて必須)
| 名前 | 値 |
| Content-Type | application/json |
| authorization | tokenサービスで取得した値を設定 |
Body(JSON形式)
| パラメータ | 型 | 必須:○ | サイズ・形式 | 説明 | 仕様 | CAREKARTEタイトル項目 |
| userId | String | ◯ | 利用者ID | |||
| sdateTime | String | ◯ | YYYY-MM-DDTHH:mm:ss.sssZ | 記録開始日時(UTC) | ||
| edateTime | String | YYYY-MM-DDTHH:mm:ss.sssZ | 記録終了日時(UTC) | 未記入の場合、記録開始日時と同じ日時をセット | ||
| resp | Number | 呼吸 | ※呼吸数 | |||
| hb | Number | 心拍 | ※心拍数 | |||
| getoutart | String | 離床検知 | 連携可能文字列:離床検知 対象文字列があった場合チェックボックスON |
※離床検知 | ||
| wakeupart | String | 起き上がり | 連携可能文字列:起き上がり 対象文字列があった場合チェックボックスON |
※起き上がり | ||
| hblowart | String | 心拍低下 | 連携可能文字列:心拍低下 対象文字列があった場合チェックボックスON |
※心拍低下 | ||
| hbhighart | String | 心拍増加 | 連携可能文字列:心拍増加 対象文字列があった場合チェックボックスON |
※心拍増加 | ||
| resplowart | String | 呼吸低下 | 連携可能文字列:呼吸低下 対象文字列があった場合チェックボックスON |
※呼吸低下 | ||
| resphighart | String | 呼吸増加 | 連携可能文字列:呼吸増加 対象文字列があった場合チェックボックスON |
※呼吸増加 | ||
| staffId | String | 職員ID | 未入力の場合、記録者は「CKAPI」と登録 または、連携用職員の用意により固定のIDをセット |
※カスタマイズでの項目追加ではなく、睡眠情報連携用標準タイトルとなります
サンプルデータ
{
"userId": "0000000025",
"sdateTime":"2021-07-27T21:00:00.000Z" ,
"edateTime":"2021-07-27T21:00:00.000Z",
"staffId": "0000000004",
"resp":100,
"hb":200,
"getoutart":"離床検知",
"wakeupart":"起き上がり",
"hblowart":"心拍低下",
"resplowart":"呼吸低下",
"resphighart":"呼吸増加"
}
レスポンス
Body(JSON形式)
| パラメータ | 型 | 必須 | サイズ・形式 | 説明 | 仕様 |
| status | Number | ○ | 1桁 | 処理結果を返却 | |
| recordId | Number[array] | ○ | 記録ID | 利用者ごとのユニークID |
サンプルデータ
記録の登録完了
{
"status": 0,
"recordId": [
333
]
}
エラー発生時(ユーザーの所属が対象事業所にない場合)
{
"code": 400,
"timestamp": "9/10/2021, 11:58:41 PM",
"path": "/slp/add",
"method": "POST",
"message": "userId does not belonging to API KEY's Office"
}
連携イメージ(CAREKARTE)
