訪問系スケジュール更新API

CAREKARTE訪問系サービスのスケジュール記録を更新することができるAPIです。

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

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

スケジュール登録APIで作成したスケジュールを更新する場合、同一のカテゴリを使用してください。

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

API ID

SC0012

Request URL

homesch/update
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/homesch/update/{{カテゴリ}}
環境 URL
本番環境 https://api.link.carekarte.jp/homesch/update/{{カテゴリ}}

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)の形式で日時データを連携します。

 

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ名 必須:○
条件付き必須:△
文字桁数 文字種/形式 仕様
更新スケジュール homeSchedule [array]
利用者ID userId String 10 半角英数字 U0007 事業所所属利用者一覧取得API等から取得してください。
記録ID recordId Number
職員ID staffId String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
担当者1ID careStfId1 String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
担当者2ID careStfId2 String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
ブロックコード blockCd String 2 半角英数字 MST0003 部屋マスタ取得API等から取得してください。
ブロック・ユニットの更新をする場合必須となります。
ユニットコード unitCd String 3 半角英数字 MST0003 部屋マスタ取得API等から取得してください。
ブロック・ユニットの更新をする場合必須となります。
開始日時 sdateTime String YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
sdateTime>edateTimeになる場合、入力値は無効となります。
終了日時 edateTime String YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
2500-01-01 00:00:00(もしくは2500-01-01T00:00:00.000Z等)指定した場合は、終了日時が未定として更新されます。
sdateTime>edateTimeになる場合、入力値は無効となります。
結果状態 result Number 1 半角数字 スケジュールの結果状態を更新するパラメータです。
1:計画
2:実施
3:中止
無効値・パラメータなし:更新しない
申し送りフラグ handoverFlag Boolean 記録を申し送りの記録とするパラメータです。
true:記録を申し送り記録にする
false:記録を申し送り記録としない
無効値・パラメータなし:更新しない
削除フラグ delFlag Boolean 記録を削除(論理削除)の記録とするパラメータです。
true:記録を削除記録にする
false:記録を削除記録としない
無効値・パラメータなし:更新しない
LINKパラメータ (CCJから提示) (CCJから提示) 登録したい内容を自由にカスタマイズできます。
具体的な物理パラメータ名については、登録したい内容をヒアリング後、CCJからお伝えします。

訪問スケジュールを更新するサンプルデータ (実際にリクエストしても使用できません)

URL:/homech/update/homecare //homecareがカテゴリ

HTTPメソッド:POST

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

body:
{ 
   "homechedule":[
      {
         "userId": "0000000001",
         "recordId": 1500,
         "staffId": "0000000001",
         "careStffId1": "0000000002",
         "careStffId2": "0000000003",
         "blockCd": "01",
         "unitCd": "001",
         "sdateTime":"2022-06-02T09:00:00.000Z",
         "edateTime":"2022-06-02T12:00:00.000Z",
         "handoverFlag":true,
         "delFlag":false,
 //以下リンクパラメータ
          "srvCont":"身体介護中心",
          "twoStf":"2人派遣"
      },
      {
         "userId": "0000000002",
         "recordId": 100,
         "staffId": "0000000001",
・・・
      }
   ]
 }

レスポンス

ボディ

パラメータ名 物理パラメータ 配列内パラメータ 文字行数 文字種/形式 仕様
更新スケジュール schedule [array]
利用者ID userId String 10 リクエストのuserIdと同じ
記録ID recordId Number リクエストのrecordIdと同じ
更新結果 recordResult Boolean 更新に成功した:true
更新に失敗した:false
リクエストメッセージコード rmCode String 詳細は「API仕様・公開仕様」>「RMメッセージ」を確認ください。
リクエストメッセージ rmMessage String 詳細は「API仕様・公開仕様」>「RMメッセージ」を確認ください。

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

{ 
  "schedule":[
    {
    "userId":"0000000001",
    "recordid":123,
    "recordResult":true,
    "rmcode";"",
    "rmMessage";""
    }
  ],
  [
    {
    "userId":"0000000002",
    "recordid":100,
    "recordResult":false,
    "rmcode";"RM003",
    "rmMessage";"スケジュールの保存に失敗しました"
    }
  ]
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

リクエスト例では更新した項目が「サービス内容」「加算項目」ですが、例えばイメージの画像にない項目も追加することが可能です。

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