入所系スケジュール情報の取得するAPI。
対象事業所に作成された入所スケジュールを取得します。
ブロック・ユニット・指定日での絞り込みが可能で、特に指定しない場合はリクエスト時点での事業所にある入所スケジュールを取得します。
・アクセスが集中する時間帯や事業所が多い法人でリクエストする場合、タイムアウトが発生する可能性があります。
・ベッド情報のマスタを取得したい場合は、MST0003 部屋マスタ取得APIをご使用ください。
API ID
SC0003
Request URL
stayschedule/select
| 環境 | URL |
|---|---|
| Staging環境 | https://stage-api.link.carekarte.jp/stayschedule/select |
| 環境 | URL |
|---|---|
| 本番環境 | https://api.link.carekarte.jp/stayschedule/select |
HTTPメソッド
POST
リクエスト
header(すべて必須)
| 名前 | 値 |
| Content-Type | application/json |
| authorization | tokenサービスで取得した値を設定 |
Body(JSON形式)
| パラメータ | 型 | 必須:○ 条件付き:●(※) | サイズ・形式 | 説明 | 仕様 | CAREKARTEタイトル項目 |
| blockCd | String | ● | 2桁 | ブロックコード | CAREKARTE内コード 取得対象特定に使用 | |
| unitCd | String | 3桁 | ユニットコード | CAREKARTE内コード 取得対象特定に使用 | ||
| selectDate | String | YYYY-MM-DD | データ取得日 |
未指定の場合は、リクエスト日に有効なスケジュールデータが対象 JST時刻 |
※必須項目の●項目については、blockCdがBODY内に存在しないかつunitCdがBODY内に存在する場合、もしくはblockCd,unitCd,selectDateのいずれもBODY内で宣言されていない場合、エラーを返却します。
サンプルデータ
{
"blockCd": "01",
"unitCd": "001",
"selectDate": "2023-12-31"
}
レスポンス
Body(JSON形式)
| パラメータ | 型 | 必須 | サイズ・形式 | 説明 | 仕様 | CAREKARTEタイトル項目 |
| selectDate | String | ○ | YYYY-MM-DD | データ取得日 |
記録を取得する日付指定 JST時刻 |
|
| message | String | エラー等、 メッセージがあれば返却 | ||||
| records | [array] | 取得情報 | データが存在しない場合は省略 | TitleTagsの出力「予定」内「備考」を 設定されたタイトル記録を取得 | ||
| userId | String | 10桁 | 利用者ID | |||
| userNm | String | 利用者名 | ||||
| officeCd | String | 2桁 | 事業所コード | CAREKARTE内コード | ||
| blockCd | String | 2桁 | ブロックコード | CAREKARTE内コード | ||
| unitCd | String | 3桁 | ユニットコード | CAREKARTE内コード | ||
| roomCd | String | 3桁 | 居室コード | CAREKARTE内コード | ||
| bedCd | String | 3桁 | ベッドコード | CAREKARTE内コード | ||
| scheduleNm | String | スケジュール名 | ||||
| sdateTime | String | YYY-MM-DD HH:mm:ss | 記録開始日時 | JST時刻 | ||
| edateTime | String | YYY-MM-DD HH:mm:ss | 記録終了日時 |
JST時刻 終了日未定の場合は、2500-01-01 00:00:00 |
サンプルデータ
記録の取得完了
{
"selectDate": "2023-12-31",
"records": [
{
"userId": "0000000022",
"userNm": "青椿あい",
"officeCd": "01",
"blockCd": "01",
"unitCd": "001",
"roomCd": "001",
"bedCd": "001",
"scheduleNm": "長期",
"sdateTime": "2013-09-02 13:30:00",
"edateTime": "2500-01-01 00:00:00"
},
{
"userId": "0000000068",
"userNm": "青椿いお",
"officeCd": "01",
"blockCd": "01",
"unitCd": "001",
"roomCd": "003",
"bedCd": "001",
"scheduleNm": "長期",
"sdateTime": "2021-05-01 19:00:00",
"edateTime": "2023-12-31 19:34:00"
}
]
}
エラー発生時(存在しないユニットコードの場合)
{
"code": 400,
"timestamp": "12/27/2021, 9:14:56 AM",
"path": "/stayschedule/select",
"method": "POST",
"message": "unitCd does not belonging to API KEY's Office"
}
連携イメージ(CAREKARTE)

その他
その他処理
| No. | リクエスト時のパラメータ値条件 | 処理 |
| 1 | blockCdが事業所に存在する正しい値 かつ unitCdが事業所に存在する正しい値 | 入力されたブロック以下ユニットの記録を取得。 記録がない場合はrecords表記が省略される。 |
| 2 | blockCdが事業所に存在する正しい値 かつ unitCdが入力されていない | 入力されたブロック以下の全ユニット記録を取得。 記録がない場合はrecords表記が省略される。 |
| 3 | blockCdが入力されていない かつ unitCdが入力されている | エラー返却(ユニットの特定が出来ないため) |
| 4 | blockCd・unitCdがどちらも入力されていない | 事業所全体(全ブロック全ユニット)の記録を取得 |
| 5 | ・事業所に存在しないblockCdを入力された場合 ・事業所に存在しないunitCdを入力された場合 ・blockCd・unitCdに無効な値を入力された場合 | エラー返却 |