入所系スケジュール取得API

CAREKARTE入所系サービスのスケジュール記録を取得することができるAPIです。

リクエストの「LINKパラメータ」では、取得したいスケジュールに紐づくデータを自由にカスタマイズすることができます。具体例はページ下部にあるリクエスト・レスポンスのサンプルデータとCAREKARTE連携イメージを参照してください。
（基本的にはSC0004等、スケジュール登録APIの設定に準拠する形になると思われます）

このAPIを使用するにはCCJ側の設定が必須となります。どのスケジュールをCAREKARTEから取得したいかを確認の上で、お問い合わせよりご相談ください。
リクエストした内容はCAREKARTEの「業務メニュー>スケジュール管理>居室管理」画面から取得されます。

※アクセスが集中する時間帯や事業所が多い法人でリクエストする場合、タイムアウトが発生する可能性があります。

API ID

SC0007

Request URL

staysch/select

環境	URL
Staging環境	https://stage-api.link.carekarte.jp/staysch/select/{{カテゴリ}}

環境	URL
本番環境	https://api.link.carekarte.jp/staysch/select/{{カテゴリ}}

HTTPメソッド

POST

リクエスト

パスパラメータ

パスパラメータ名	値	仕様
カテゴリ	（CCJから提示）	URLのパスパラメータ。具体的な値については登録したい内容をヒアリング後、CCJからお伝えします。

ヘッダー

名前	必須	値	仕様
Content-Type	○	application/json
authorization	○	tokenサービスで取得した値を設定
X-CCJ-Datetime-Format		ISO8601/UTC	ISO8601の拡張形式（YYYY-MM-DDThh:mm:ss.sssZ）で日時データを連携したい場合のみ使用します。指定しない場合はYYYY-MM-DD HH:mm:ss(JST)の形式で日時データを連携します。

ボディ

パラメータ名	物理パラメータ名	配列内パラメータ	必須	型	文字桁数	文字種/形式	仕様
取得期間開始日時	selectSdateTime		△	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	userIdをリクエストしない場合、必須 selectEdateTimeをリクエストする場合、必須 CAREKARTEでは秒数以下は切り捨ててデータを取得となります。 selectEdateTimeをリクエストしない場合には、selectSdateTimeから、同日23:59:59までのスケジュールを取得します
取得期間終了日時	selectEdateTime			String		YYYY-MM-DD HH:mm:ss または ISO8601形式	CAREKARTEでは秒数以下は切り捨ててデータを取得となります。取得の開始日～終了日の上限日数は31日となります。
取得対象者	selectUsers		△	[array]
利用者ID		userId	△	String	10	半角英数字	selectSdateTimeをリクエストしない場合、必須 recordIdをリクエストする場合、必須利用者IDはU0007　事業所所属利用者一覧取得API等から取得してください。
記録ID		recordId		Number			利用者ID + 記録IDでユニークとなります。記録IDをnullとすると記録IDに関わらず利用者の記録を取得します。
ブロックコード	blockCd		△	String	2	半角英数字	unitCdをリクエストする場合、必須 O0002　組織情報取得APIから取得してください。
ユニットコード	unitCd			String	3	半角英数字	O0002　組織情報取得APIから取得してください。
申し送り記録のみ取得フラグ	onlyHandoverFlag			Boolean			申し送り記録を取得するか選択するフラグです。 true：申し送り記録のみを取得する false またはパラメータなし：申し送りを含む記録を取得する
削除済み記録を含むフラグ	includeDelFlag			Boolean			CAREKARTE上で削除された記録も取得するか選択するフラグです。 true：削除された介護記録を取得する false またはパラメータなし：削除された介護記録は取得しない
外泊・入院の表示フラグ	outside			Boolean			入院・外泊の記録を取得するか選択するフラグです CAREKARTEでは、入院・外泊の記録はブロックコード91になります。 true：外泊・入院のスケジュールを取得する false またはパラメータなし：外泊・入院のスケジュールを取得しない(ブロックコード91のスケジュールを取得しない)

長期スケジュールを取得するサンプルデータ（実際にリクエストしても使用できません）

URL：/staysch/select/longstay　//longstayがカテゴリ

HTTPメソッド：POST

header：
Authorization：Bearer eyJhbGc…
Content-Type：application/json
CCJ-Datetime-Format：ISO8601/UTC

body：
{
"selectSdateTime":"YYYY-MM-DDT00:00:00.000Z",
"selectEdateTime":"YYYY-MM-DDT00:01:00.000Z",
"selectUsers":[
    {
        "userId":"0000000002",
        "recordId":1
    },
    {
        "userId":"0000000003",
        "recordId":4
    }
   ],
"blockCd": "01",
"unitCd": "001",
"onlyHandoverFlag":true,
"includeDelFlag":true,
"outside":false
}

レスポンス

ボディ

パラメータ名	物理パラメータ名	配列内パラメータ	型	文字桁数	文字種/形式	備考
記録件数	numberOfRecords		Number			スケジュールを取得できる上限件数は200件です。
取得記録	schedules		[array]
利用者ID		userId	String	10	半角英数字
記録ID		recordId	Number
記録職員ID		staffId	String	10	半角英数字
記録開始日時		sdateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式
記録終了日時		edateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	未定の場合 2500-01-01 00:00:00 が返却されます
ブロックコード		blockCd	String	2
ユニットコード		unitCd	String	3
居室コード		roomCd	String	3
ベッドコード		bedCd	String	3
申し送りフラグ		handoverFlag	Boolean
削除フラグ		delFlag	Boolean
LINKパラメータ		（CCJから提示）	（CCJから提示）			取得したい内容を自由にカスタマイズできます。具体的な物理パラメータ名については、登録したい内容をヒアリング後、CCJからお伝えします。

データの登録成功のサンプルデータ

{
    "numberOfRecords": 2,
    "schedules": [
        {
            "userId": "0000000002",
            "recordId": 1,
            "staffId": "9800000001",
            "sdateTime": "2022-10-02 10:00:00",
            "edateTime": "2022-10-03 11:00:00",
            "blockCd": "01",
            "unitCd": "001",
            "roomCd": "003",
            "bedCd": "001",
            "handoverFlag": true,
            "delFlag": true,
            "inStatus": "1",　//LINKパラメータ
            "inComment": "入所前状況について",　//LINKパラメータ
        },
        {
            "userId": "0000000003",
            "recordId": 4,
            "staffId": "0000000001",
            "sdateTime": "2022-10-02 10:00:00",
            "edateTime": "2022-10-03 11:00:00",
            "blockCd": "01",
            "unitCd": "001",
            "roomCd": "001",
            "bedCd": "002",
            "handoverFlag": true,
            "delFlag": false,
            "inStatus": "1",　//LINKパラメータ
            "inComment": "入所前状況について",　//LINKパラメータ
        },
    ]
}

エラーレスポンス

エラーレスポンスを参照してください。

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEの標準の長期入所スケジュールのレイアウトですが、このAPIを使用する際には、基本的にパートナー様専用のレイアウトを作成いたします。こちらもヒアリングの後にCCJから提案させていただきます。