池田介護研究所リモートデイサービスAPI仕様書 (1.0.2)

Download OpenAPI specification:Download

池田介護研究所リモートデイサービスのAPI仕様書です
左側のメニューから特定のAPIまで飛ぶことができます

会社

会社一覧取得API

  • ログイン認証 [401]
  • 権限チェック(運営者のみ)[404]

会社の一覧データを取得して返却するAPI(削除済みの会社を除く一覧を返却する)。
IDの降順に返却する。
運営者ではない場合、404エラーを返却する。

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    [
    ]
}

会社新規登録API

  • ログイン認証 [401]
  • 権限チェック(運営者のみ)[401]
  • バリデーションチェック [422]

会社を新規登録するAPI。

query Parameters
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

メールアドレス

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

会社詳細取得API

  • ログイン認証 [401]
  • 権限チェック(運営者のみ)[401]
  • データ存在チェック [404]

IDに紐づく会社の詳細情報を取得して返却するAPI。
運営者ではない場合・すでに削除された会社の場合、404エラーを返却する。

path Parameters
id
required
integer

会社ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

会社更新API

  • ログイン認証 [401]
  • 権限チェック(運営者のみ)[401]
  • データ存在チェック [404]
  • バリデーションチェック [422]

IDに紐づく会社の情報を更新するAPI。
password, email はリクエストに値が存在している場合のみ更新する。

path Parameters
id
required
integer

会社ID

query Parameters
company_name
required
string <= 256 characters
Example: company_name=株式会社XYZ

会社名

password
string <= 128 characters
Example: password=password

パスワード

email
string <= 256 characters
Example: email=example@email.com

メールアドレス

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

会社削除API

  • ログイン認証 [401]
  • 権限チェック(運営者のみ)[401]
  • データ存在チェック [404]
  • 自社チェック [412]

IDに紐づく会社のレコードを削除するAPI。
運営者を削除しようとした場合、412エラーを返却する。

path Parameters
id
required
integer

会社ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

事業所

事業所一覧取得API

  • ログイン認証 [401]

事業所の一覧データを取得して返却するAPI。(既に削除されている事業所は表示しない)

  • 運営者の場合:全事業所データを取得する。
  • 運営者以外の場合:会社IDに紐づく事業所データを取得する。
    IDの降順に返却する。

ログインユーザーの会社IDがリクエストパラメーターで渡された場合

  • パラメータの会社IDに紐づく事業所の一覧を返却する(降順)
query Parameters
m_company_id
string

ログインユーザーの会社ID

Responses

Response samples

Content type
application/json
Example
{
  • "message": "OK",
  • "data":
    [
    ]
}

事業所新規登録API

  • ログイン認証 [401]
  • バリデーションチェック [422]

事業所データの登録を行うAPI。
(ログインユーザーが運営者以外の場合は、会社ID m_company_id は必ずログインユーザーの会社IDとなる)※フロント対応

query Parameters
office_name
required
string <= 256 characters
Example: office_name=むつ事業

事業所名

m_company_id
required
integer
Example: m_company_id=2

会社ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

事業所詳細取得

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく事業所の詳細情報を取得するAPI。
運営者以外の場合:パスパラメーターのidに紐づく事業所データが、ログインユーザーの会社IDに紐づく事業所データではない場合、404エラーを返す。

path Parameters
id
required
integer

事業所ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

事業所更新

  • ログイン認証 [401]
  • データ存在チェック [404]
  • バリデーションチェック [422]

IDに紐づく事業所の情報を更新するAPI
(ログインユーザーが運営者以外の場合は、会社ID m_company_id は必ずログインユーザーの会社IDとなる)※フロント対応

path Parameters
id
required
integer

事業所ID

query Parameters
office_name
required
string <= 256 characters
Example: office_name=むつ事業

事業所名

m_company_id
required
integer
Example: m_company_id=2

会社ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

事業所削除

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく事業者のレコードを削除するAPI

path Parameters
id
required
integer

事業所ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

利用者

利用者一覧取得API

  • ログイン認証 [401]

会社IDに紐づく事業所の、利用者の一覧を取得して返却するAPI。
IDの降順で返却する。
バイタル系情報は、該当ユーザーの最新のバイタル情報を取得してくる。

  • new_fallen_datetime:t_fallens.fallen_startdatetime

※削除済みユーザーは一覧には表示しない

Responses

Response samples

Content type
application/json
{}

利用者新規登録API

  • ログイン認証 [401]
  • バリデーションチェック [422]

利用者の新規登録の登録を行うAPI。

  • 登録時、端末ID(uuid)を生成し利用者マスタに登録する。

※sign in with apple 対応(user_id の取得)

・既に 存在する user_id がリクエストされた場合、

  • 削除フラグが true の場合:既に存在している重複した user_id にランダム文字列追加(会社のemailと同様の形式に)・新たにユーザーを新規登録
  • 削除フラグが false の場合:422エラー「この apple IDは既に使用されているため登録できません。」 を返却する。
query Parameters
m_office_id
required
integer

事業所ID

user_id
string

ユーザーID

full_name
required
string

名前

full_name_furigana
required
string

フリガナ

email
string

メールアドレス

address
string

住所

address_latitude
number <double>

住所(緯度)

address_longitude
number <double>

住所(経度)

birthday
string <date-time>

誕生日

gender
integer

性別

blood_type
integer

血液型

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

利用者詳細取得API

  • ログイン認証 [401]
  • データ存在チェック [404]
  • ユーザーチェック(削除済みか否か) [404]

IDに紐づく利用者の詳細情報を取得して返却するAPI。

  • 利用者の事業所ID(m_office_id)が、ログインユーザーの会社IDに紐づく事業所と一致しない場合は、404エラーを返す。
path Parameters
id
required
integer

利用者ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

利用者更新API

  • ログイン認証 [401]
  • データ存在チェック [404]
  • バリデーションチェック [422]

利用者のデータ更新を行うAPI

  • ログインユーザーが運営者以外の場合
    • 利用者の事業所ID(m_office_id)が、ログインユーザーの事業所IDと一致しない場合は、404エラーを返す
  • weeks:リモートの接続曜日タイプ
    DBに保存するとき(remote_connection_date_type)は、カンマ区切りの文字列として保存する。(例:"1,3,4")
  • exclude_schedule:リモートの接続例外日
    DBに保存するときは、remote_exception_date_1(1の部分は、1~5の値が入る)として、各値を保存する。
  • additional_schedule:リモートの接続追加日
    DBに保存するときは、remote_additional_date_1(1の部分は、1~5の値が入る)として、各値を保存する。
    ※住所(緯度)address_latitude、住所(経度)address_longitude は、フロントエンド側で住所を元に算出された値を保存する。

・既に 存在する user_id がリクエストされた場合、

  • 削除フラグが true の場合:既に存在している重複した user_id にランダム文字列追加(会社のemailと同様の形式に)・リクエストされた利用者の user_id を更新(追加)
  • 削除フラグが false の場合:422エラー「この apple IDは既に使用されているため登録できません。」 を返却する。
path Parameters
id
required
integer

利用者ID

Request Body schema: application/json

リモート接続日程内データ

user_id
string

apple認証用 user_id

m_office_id
required
integer

事業所ID

full_name
required
string

名前

full_name_furigana
required
string

フリガナ

email
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

Responses

Request samples

Content type
application/json
{
  • "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":
    [
    ]
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

利用者削除API

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく利用者のレコードを削除するAPI。

path Parameters
id
required
integer

利用者ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

利用者バイタル情報取得API

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく利用者の最新バイタル情報を取得し、返却するAPI。

  • 利用者の事業所ID(m_office_id)が、ログインユーザーの会社IDに紐づく事業所と一致しない場合は、404エラーを返す。
path Parameters
id
required
integer

利用者ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

利用者バイタル統計取得API

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく利用者のバイタル統計を取得し、返却するAPI。
(心拍数・血中酸素濃度以外のバイタルデータは、現状フロントエンドで使用していないのでnull可)

  • 利用者の事業所ID(m_office_id)が、ログインユーザーの会社IDに紐づく事業所と一致しない場合は、404エラーを返す。

クエリの表示期間タイプに沿った表示期間でデータを取得する(period_type)。

period_type バイタル情報の期間 date の間隔 返却方法
1 1時間 5分 一時間分の全データ
2 24時間 1時間 一時間ごとの平均
3 1週間 1日(24時間) 一日後との平均
path Parameters
id
required
integer

利用者ID

query Parameters
period_type
required
integer
Example: period_type=1

表示期間タイプ(1~3)

Responses

Response samples

Content type
application/json
Example
{
  • "message": "OK",
  • "data":
    {
    }
}

利用者位置情報取得API

  • ログイン認証 [401]
  • データ存在チェック [404]

IDに紐づく利用者の、最新の位置情報を取得するAPI。

  • ログインユーザーが運営者以外の場合
    • 利用者の事業所ID(m_office_id)が、ログインユーザーの会社IDに紐づく事業所と一致しない場合は、404エラーを返す。
  • full_name:登録した利用者の名前
  • address:登録した利用者の住所
path Parameters
id
required
integer

利用者ID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

利用者転倒情報取得API

  • ログイン認証 [401]

利用者の転倒情報を取得するAPI。
ログインユーザーの事業所IDに紐づく利用者から、以下のデータを返却する。

  • 即時フラグ(t_fallens.immediate)が trueで、通知確認フラグ(t_fallens.is_read_notice)がfalse(未確認)の 利用者の一覧を返す。
  • 最新転倒日時が古い順番で返す
  • new_fallen_datetime:t_fallens.fallen_startdatetime

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    [
    ]
}

未分類

ログインAPI

  • ログインIDに一致するユーザーが存在するかチェック [401]
  • バリデーションチェック [422]

ログインに使用するAPI。
認証には Laravel Sanctum のSPA認証を使用する。

query Parameters
email
required
string

メールアドレス(会社単位)

password
required
string

パスワード

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

ログイン情報取得API

  • ログインチェック [401]

既にログイン済みの場合、ログイン情報を取得して返却するAPI。
401エラーが返却された場合、ログアウトさせる。

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

通知確認フラグ変更API

  • ログインチェック [401]
  • データ存在チェック [404]

管理画面で転倒情報を既に表示したユーザーの通知確認フラグを変更するAPI。

path Parameters
id
required
integer

バイタル情報ID(転倒テーブル)

query Parameters
is_read_notice
required
integer
Example: is_read_notice=1

通知確認フラグ

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

モバイルAPI

デバイストークン更新API

  • バリデーションチェック [422]
  • データ存在チェック [404]

デバイストークンを更新するAPI。 既に削除されているユーザーの場合は 404エラーを返却する。

path Parameters
uuid
required
string

端末ID

Request Body schema: application/json
device_token
string

デバイストークン

Responses

Request samples

Content type
application/json
{
  • "device_token": "xxxxxxxxxxxxxxxxxxxxx"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

アカウント情報取得API

  • データ存在チェック [404]

アカウント情報を返却するAPI。

  • remote_day_service : 当月の前後一か月(前月・今月・来月)のデータを返す。
  • remote_day_service.end_time ・ remote_day_service.additional_schedule.end_time : start_time の 1時間後を返却する 既に削除済みユーザー・app_url_hash に一致するユーザーが存在しない場合は 404 エラーを返却する
path Parameters
app_url_hash
required
string

アプリURLハッシュ

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

端末ID取得API

  • 存在チェック [404]

端末IDを返却するAPI。
user_id が一致する利用者のuuid を返却する。
既に削除済みユーザー・user_id に一致するユーザーが存在しない場合は 404 エラーを返却する。

path Parameters
user_id
required
string

ユーザーID

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data":
    {
    }
}

サブスクリプション登録API

  • データ存在チェック [404]
  • バリデーションチェック [422]

ユーザのサブスクリプションを登録するAPI。
通知が許可され、サブスクリプションを購読したら、登録する。 既にデータがある状態で、再度サブスクリプションの値が存在したら更新する。

path Parameters
app_url_hash
required
string

アプリURLハッシュ

query Parameters
endpoint
required
string

PushサーバーURL

public_key
required
string

Pushサーバー公開鍵

token
required
string

Pushサーバートークン

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}

トラッキングAPI

  • バリデーションチェック [422]
  • データ存在チェック [404]

バイタル情報や位置情報を登録するAPI。
転倒時(即時)の場合、管理者側に転倒データをメールで別途通知する。

path Parameters
uuid
required
string

端末ID

Request Body schema: application/json
object

バイタル情報

object

転倒情報

required
object

位置情報

Responses

Request samples

Content type
application/json
{
  • "vital":
    {
    },
  • "fallen":
    {
    },
  • "location":
    {
    }
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "data": { }
}