Download OpenAPI specification:Download
池田介護研究所リモートデイサービスのAPI仕様書です
左側のメニューから特定のAPIまで飛ぶことができます
会社の一覧データを取得して返却するAPI(削除済みの会社を除く一覧を返却する)。
IDの降順に返却する。
運営者ではない場合、404エラーを返却する。
{- "message": "OK",
- "data": [
- {
- "id": 1,
- "company_name": "株式会社XYZ",
- "is_adminer": true
}, - {
- "id": 2,
- "company_name": "ABC株式会社",
- "is_adminer": false
}
]
}会社を新規登録するAPI。
| company_name required | string <= 256 characters Example: company_name=株式会社XYZ 会社名 |
| password required | string <= 128 characters Example: password=password パスワード |
| email required | string <= 256 characters Example: email=example@email.com メールアドレス |
{- "message": "OK",
- "data": { }
}IDに紐づく会社の詳細情報を取得して返却するAPI。
運営者ではない場合・すでに削除された会社の場合、404エラーを返却する。
| id required | integer 会社ID |
{- "message": "OK",
- "data": {
- "company_name": "株式会社XYZ",
- "email": "test@email.com",
- "password": "password"
}
}IDに紐づく会社の情報を更新するAPI。
password, email はリクエストに値が存在している場合のみ更新する。
| id required | integer 会社ID |
| company_name required | string <= 256 characters Example: company_name=株式会社XYZ 会社名 |
| password | string <= 128 characters Example: password=password パスワード |
string <= 256 characters Example: email=example@email.com メールアドレス |
{- "message": "OK",
- "data": { }
}事業所の一覧データを取得して返却するAPI。(既に削除されている事業所は表示しない)
ログインユーザーの会社IDがリクエストパラメーターで渡された場合
| m_company_id | string ログインユーザーの会社ID |
{- "message": "OK",
- "data": [
- {
- "id": 1,
- "company_name": "株式会社XYZ",
- "m_company_id": 1,
- "office_name": "第一事業所"
}, - {
- "id": 2,
- "company_name": "株式会社XYZ",
- "m_company_id": 1,
- "office_name": "第二事業所"
}, - {
- "id": 3,
- "company_name": "ABC株式会社",
- "m_company_id": 2,
- "office_name": "介護施設事業所はちのへ"
}
]
}事業所データの登録を行うAPI。
(ログインユーザーが運営者以外の場合は、会社ID m_company_id は必ずログインユーザーの会社IDとなる)※フロント対応
| office_name required | string <= 256 characters Example: office_name=むつ事業 事業所名 |
| m_company_id required | integer Example: m_company_id=2 会社ID |
{- "message": "OK",
- "data": { }
}IDに紐づく事業所の詳細情報を取得するAPI。
運営者以外の場合:パスパラメーターのidに紐づく事業所データが、ログインユーザーの会社IDに紐づく事業所データではない場合、404エラーを返す。
| id required | integer 事業所ID |
{- "message": "OK",
- "data": {
- "office_name": "株式会社XYZ",
- "m_company_id": 1
}
}IDに紐づく事業所の情報を更新するAPI
(ログインユーザーが運営者以外の場合は、会社ID m_company_id は必ずログインユーザーの会社IDとなる)※フロント対応
| id required | integer 事業所ID |
| office_name required | string <= 256 characters Example: office_name=むつ事業 事業所名 |
| m_company_id required | integer Example: m_company_id=2 会社ID |
{- "message": "OK",
- "data": { }
}会社IDに紐づく事業所の、利用者の一覧を取得して返却するAPI。
IDの降順で返却する。
バイタル系情報は、該当ユーザーの最新のバイタル情報を取得してくる。
※削除済みユーザーは一覧には表示しない
{- "message": "OK",
- "data": [
- {
- "id": 1,
- "m_office_id": 1,
- "full_name": "山田太郎",
- "full_name_furigana": "ヤマダタロウ",
- "user_name": "yamada tarou",
- "gender": 1,
- "heart_rate": 100,
- "oxygen_saturation": 98,
- "number_of_times_fallen": 0,
- "new_fallen_datetime": "2022-01-28 08:00:00",
- "updated_at": "2022-02-01 10:00:00"
}, - {
- "id": 2,
- "m_office_id": 2,
- "full_name": "田中花子",
- "full_name_furigana": "タナカハナコ",
- "user_name": "tanaka hanako",
- "gender": 1,
- "heart_rate": 112,
- "oxygen_saturation": 99,
- "number_of_times_fallen": 1,
- "new_fallen_datetime": "2022-02-01 09:00:00",
- "updated_at": "2022-02-01 10:00:00"
}, - {
- "id": 3,
- "m_office_id": 2,
- "full_name": "田中花子",
- "full_name_furigana": "タナカハナコ",
- "user_name": null,
- "gender": 1,
- "heart_rate": 110,
- "oxygen_saturation": 99,
- "number_of_times_fallen": 1,
- "new_fallen_datetime": "2022-02-01 09:00:00",
- "updated_at": "2022-02-01 10:00:00"
}
]
}利用者の新規登録の登録を行うAPI。
※sign in with apple 対応(user_id の取得)
・既に 存在する user_id がリクエストされた場合、
| m_office_id required | integer 事業所ID |
| user_id | string ユーザーID |
| full_name required | string 名前 |
| full_name_furigana required | string フリガナ |
string メールアドレス | |
| address | string 住所 |
| address_latitude | number <double> 住所(緯度) |
| address_longitude | number <double> 住所(経度) |
| birthday | string <date-time> 誕生日 |
| gender | integer 性別 |
| blood_type | integer 血液型 |
{- "message": "OK",
- "data": { }
}IDに紐づく利用者の詳細情報を取得して返却するAPI。
| id required | integer 利用者ID |
{- "message": "OK",
- "data": {
- "m_office_id": 1,
- "user_id": "001612.cea7071a4b75404680ae5286a0ed1a1e.01xx",
- "full_name": "山田太郎",
- "full_name_furigana": "ヤマダタロウ",
- "email": "yamada@privaterelay.appleid.com",
- "is_use_remote": true,
- "address": "青森県八戸市小中野1丁目1-1",
- "birthday": "1980-02-01",
- "gender": 1,
- "blood_type": 1,
- "remote_url": "yamada@privaterelay.appleid.com",
- "remote_day_service": [
- {
- "month": "2022-04",
- "weeks": [
- 2,
- 4,
- 6
], - "start_time": "09:00",
- "exclude_schedule": [
- "2022-04-18"
], - "additional_schedule": [
- "2022-04-18 18:00"
]
}
]
}
}利用者のデータ更新を行うAPI
・既に 存在する user_id がリクエストされた場合、
| id required | integer 利用者ID |
リモート接続日程内データ
| user_id | string apple認証用 user_id |
| m_office_id required | integer 事業所ID |
| full_name required | string 名前 |
| full_name_furigana required | string フリガナ |
string メールアドレス | |
| address | string 住所 |
| address_latitude | number <double> 住所(緯度) |
| address_longitude | number <double> 住所(経度) |
| birthday | string 誕生日 |
| gender | integer 性別 |
| blood_type | integer 血液型 |
| is_use_remote required | boolean リモート使用状況(true:使用する、false:使用しない) |
| remote_url | string remote接続用URL |
Array of objects |
{- "user_id": "cea7071a4b75404680ae5286a0ed1axx",
- "m_office_id": 1,
- "full_name": "山田太郎",
- "full_name_furigana": "ヤマダタロウ",
- "email": "itc.day.member.001@gmail.com",
- "address": "青森県八戸市小中野1丁目1-1",
- "address_latitude": 40.48916,
- "address_longitude": 141.50064,
- "birthday": "1980-02-01",
- "gender": 1,
- "blood_type": 1,
- "is_use_remote": true,
- "remote_day_service": [
- {
- "month": "2022-04",
- "weeks": [
- 2,
- 4,
- 6
], - "start_time": "09:00",
- "exclude_schedule": [
- "2022-04-18"
], - "additional_schedule": [
- "2022-05-04 11:00"
]
}
]
}{- "message": "OK",
- "data": { }
}IDに紐づく利用者の最新バイタル情報を取得し、返却するAPI。
| id required | integer 利用者ID |
{- "message": "OK",
- "data": {
- "full_name": "山田太郎",
- "heart_rate": 98,
- "resting_heart_rate": 65,
- "oxygen_saturation": 101,
- "body_temperature": 36.3,
- "systolic_blood_pressure": 97,
- "diastolic_blood_pressure": 86,
- "number_of_times_fallen": 1,
- "heart_rate_updated_at": "2022-02-27 07:00:00",
- "vital_updated_at": "2022-02-27 07:00:00"
}
}IDに紐づく利用者のバイタル統計を取得し、返却するAPI。
(心拍数・血中酸素濃度以外のバイタルデータは、現状フロントエンドで使用していないのでnull可)
クエリの表示期間タイプに沿った表示期間でデータを取得する(period_type)。
| period_type | バイタル情報の期間 | date の間隔 | 返却方法 |
|---|---|---|---|
| 1 | 1時間 | 5分 | 一時間分の全データ |
| 2 | 24時間 | 1時間 | 一時間ごとの平均 |
| 3 | 1週間 | 1日(24時間) | 一日後との平均 |
| id required | integer 利用者ID |
| period_type required | integer Example: period_type=1 表示期間タイプ(1~3) |
{- "message": "OK",
- "data": {
- "vitals": [
- {
- "date": "2022-04-26 16:00:00",
- "heart_rate": 100,
- "resting_heart_rate": null,
- "oxygen_saturation": 92,
- "body_temperature": null,
- "systolic_blood_pressure": null,
- "diastolic_blood_pressure": null,
- "number_of_times_fallen": null
}, - {
- "date": "2022-04-26 15:55:00",
- "heart_rate": 96,
- "resting_heart_rate": null,
- "oxygen_saturation": 90,
- "body_temperature": null,
- "systolic_blood_pressure": null,
- "diastolic_blood_pressure": null,
- "number_of_times_fallen": null
}, - {
- "date": "2022-04-26 15:50:00",
- "heart_rate": 99,
- "resting_heart_rate": 56,
- "oxygen_saturation": 93,
- "body_temperature": null,
- "systolic_blood_pressure": null,
- "diastolic_blood_pressure": null,
- "number_of_times_fallen": null
}
], - "label": [
- "9:00",
- "9:05",
- "9:10"
]
}
}IDに紐づく利用者の、最新の位置情報を取得するAPI。
| id required | integer 利用者ID |
{- "message": "OK",
- "data": {
- "full_name": "山田太郎",
- "address": "青森県八戸市小中野1丁目1-1",
- "address_latitude": 40.48916,
- "address_longitude": 141.50064,
- "latitude": 40.518872,
- "longitude": 141.513764,
- "accuracy": 3,
- "updated_at": "2022-03-01 07:00:00"
}
}利用者の転倒情報を取得するAPI。
ログインユーザーの事業所IDに紐づく利用者から、以下のデータを返却する。
{- "message": "OK",
- "data": [
- {
- "id": 1,
- "user_id": 1,
- "full_name": "田中一郎",
- "user_name": "tanaka itirou",
- "new_fallen_datetime": "2022-02-01 12:00:00"
}, - {
- "id": 2,
- "user_id": 3,
- "full_name": "田中次郎",
- "user_name": "tanaka jirou",
- "new_fallen_datetime": "2022-02-01 16:00:00"
}
]
}ログインに使用するAPI。
認証には Laravel Sanctum のSPA認証を使用する。
| email required | string メールアドレス(会社単位) |
| password required | string パスワード |
{- "message": "OK",
- "data": {
- "m_company_id": 1,
- "company_name": "介護支援事務所はちのへ",
- "is_adminer": true
}
}管理画面で転倒情報を既に表示したユーザーの通知確認フラグを変更するAPI。
| id required | integer バイタル情報ID(転倒テーブル) |
| is_read_notice required | integer Example: is_read_notice=1 通知確認フラグ |
{- "message": "OK",
- "data": { }
}デバイストークンを更新するAPI。 既に削除されているユーザーの場合は 404エラーを返却する。
| uuid required | string 端末ID |
| device_token | string デバイストークン |
{- "device_token": "xxxxxxxxxxxxxxxxxxxxx"
}{- "message": "OK",
- "data": { }
}アカウント情報を返却するAPI。
| app_url_hash required | string アプリURLハッシュ |
{- "message": "OK",
- "data": {
- "company": {
- "company_id": 1,
- "company_name": "株式会社○○○○○○○○○"
}, - "office": {
- "office_id": 1,
- "office_name": "○○○○○苑"
}, - "full_name": "やまだ りもうと",
- "remote_day_service": [
- {
- "month": "2022-04",
- "weeks": "2, 4, 6",
- "start_time": "09:00",
- "end_time": "10:00",
- "exclude_schedule": [
- {
- "exclusion_date": "2022-04-04"
}
], - "additional_schedule": [
- {
- "add_date": "2022-04-04",
- "start_time": "11:00",
- "end_time": "12:00"
}
], - "update_at": "2022-03-28 11:22:33"
}
]
}
}端末IDを返却するAPI。
user_id が一致する利用者のuuid を返却する。
既に削除済みユーザー・user_id に一致するユーザーが存在しない場合は 404 エラーを返却する。
| user_id required | string ユーザーID |
{- "message": "OK",
- "data": {
- "uuid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}ユーザのサブスクリプションを登録するAPI。
通知が許可され、サブスクリプションを購読したら、登録する。
既にデータがある状態で、再度サブスクリプションの値が存在したら更新する。
| app_url_hash required | string アプリURLハッシュ |
| endpoint required | string PushサーバーURL |
| public_key required | string Pushサーバー公開鍵 |
| token required | string Pushサーバートークン |
{- "message": "OK",
- "data": { }
}バイタル情報や位置情報を登録するAPI。
転倒時(即時)の場合、管理者側に転倒データをメールで別途通知する。
| uuid required | string 端末ID |
object バイタル情報 | |
object 転倒情報 | |
required | object 位置情報 |
{- "vital": {
- "heart_rate": {
- "heart_rate": 100,
- "hr_startdatetime": "2022-03-23 17:00:00",
- "hr_enddatetime": "2022-03-23 23:59:59"
}, - "resting_heart_rate": {
- "resting_heart_rate": 95,
- "resting_hr_startdatetime": "2022-03-23 17:00:00",
- "resting_hr_enddatetime": "2022-03-23 23:59:59"
}, - "oxygen_saturation": {
- "oxygen_saturation": 99,
- "spo2_startdatetime": "2022-03-23 17:00:00",
- "spo2_enddatetime": "2022-03-23 23:59:59"
}, - "blood_pressure": {
- "systolic_blood_pressure": 150,
- "diastolic_blood_pressure": 90,
- "bp_startdatetime": "2022-03-23 17:00:00",
- "bp_enddatetime": "2022-03-23 23:59:59"
}, - "body_temperature": {
- "body_temperature": 36.8,
- "bt_startdatetime": "2022-03-23 17:00:00",
- "bt_enddatetime": "2022-03-23 23:59:59"
}
}, - "fallen": {
- "number_of_times_fallen": 1,
- "immediate": 1,
- "fallen_startdatetime": "2022-03-23 17:00:00",
- "fallen_enddatetime": "2022-03-23 23:59:59"
}, - "location": {
- "latitude": 40.524987,
- "longitude": 141.508278,
- "accuracy": 100,
- "os_type": 1
}
}{- "message": "OK",
- "data": { }
}