訪問系スケジュール登録API

CAREKARTEへ訪問系サービスのスケジュールを登録することができるAPI

リクエストの「LINKパラメータ」では、登録したいスケジュールに紐づくデータを自由にカスタマイズすることができます。具体例はページ下部にあるリクエスト・レスポンスのサンプルデータとCAREKARTE連携イメージを参照してください。
このAPIを使用するにはCCJ側の設定が必須となります。どんなスケジュールをCAREKARTEに登録したいかを確認の上で、お問い合わせよりご相談ください。
リクエストした内容はCAREKARTEに登録され「業務メニュー>スケジュール管理>訪問予定」の画面に表示されます。
※アクセスが集中する時間帯や事業所が多い法人でリクエストする場合、タイムアウトが発生する可能性があります。

API ID

SC0006

Request URL

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

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

 

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ名 必須 型 文字桁数 文字種/形式 仕様
利用者ID userId   ◯ String 10 半角英数字 U0007 事業所所属利用者一覧取得API等から取得してください。
登録スケジュール homeSchedule   ◯ [array] 10 半角英数字 31件までの要素を同時にリクエストできます。
シークエンス番号   seq ◯ String   半角英数字 レスポンスで要素ごとに返却されるシークエンス番号です。
職員ID   staffId ◯ String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
担当者1ID   careStfId1   String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
担当者2ID   careStfId2   String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
ブロックコード   blockCd ◯ String 2 半角英数字  
ユニットコード   unitCd ◯ String 3 半角英数字  
開始日時   sdateTime ◯ String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
利用者の所属期間内を指定してください。
CAREKARTEでは秒数以下は切り捨てとなります。
終了日時   edateTime   String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
開始日時以降である必要があります。
状態   result   Boolean     CAREKARTEではスケジュールのステータスを登録することができます。
1:計画
2:実施
3:中止
となります。

指定しない場合は、1:計画 で登録されます

デフォルト記録フラグ   defaultFlag   Boolean     CAREKARTEでは記録に対してあらかじめデフォルトの値を設定でき、
そのデフォルト値を使用するか否かのフラグです。

true:デフォルト記録を使用する

false または パラメータなし:デフォルト記録を使用しない

申し送りフラグ   handoverFlag   Boolean     申し送り記録とするか否かのフラグです。

true:申し送りの記録とする

false または パラメータなし:申し送りの記録としない

申し送り記録とすると、記録内容が赤く表示され「業務メニュー>日常記録管理>ホーム」にも表示されます。

LINKパラメータ   (CCJから提示)   (CCJから提示)     登録したい内容を自由にカスタマイズできます。
具体的な物理パラメータ名については、登録したい内容をヒアリング後、CCJからお伝えします。

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

URL:/homesch/add/homecare //homecareがカテゴリ

HTTPメソッド:POST

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

BODY
{ 
 "userId": "0000000001",
  "homeSchedule":[
  {
    "seq":"01",
    "staffId":"0000000001",
    "careStfId1":"0000000002",
    "careStfId2":"0000000003",
    "blockCd":"01",
    "unitCd":"001",
    "sdateTime":"2022-06-01T23:00:00.000Z",
    "edateTime":"2022-06-02T01:00:00.000Z",
    "result":1,
    "defaultFlag":false,
    "handoverFlag":true,
//以下リンクパラメータ
    "srvCont":"身体介護中心",
    "twoStf":"2人派遣"
  }
  ]
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ 型 文字行数 文字種/形式 備考
登録スケジュール schedule   [array]      
シークエンス番号   seq String   半角英数字  
結果   recordResult Boolean     登録に成功した場合 true
登録に失敗した場合 false
が返却されます
falseとなったスケジュールのみ、再度リクエストを送信してください。
リクエストメッセージコード   rmCode String     詳細は「API仕様・公開仕様」>「RMメッセージ」を確認ください。
リクエストメッセージ   rmMessage String     詳細は「API仕様・公開仕様」>「RMメッセージ」を確認ください。
利用者ID   userId String 10 半角英数字 利用者IDと記録IDの組み合わせでユニークとなります。
記録ID   recordId Number      
開始日時   sdateTime String   YYYY-MM-DD HH:mm:ss 登録したスケジュールの開始日時が返却されます

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

{ 
  "schedule":[
  {
    "seq":"01",
    "recordResult":true,
    "rmCode":"",
    "rmMessage":"",
    "userId":"0000000001",
    "recordid":12345,
    "sdateTime":"2022-06-01T23:00:00.000Z"
  }
   {
    "seq":"02",
    "recordResult":false,
    "rmCode":"RM001",
    "rmMessage":"[blockCd]の値が正しくありません",
    "userId":null,
    "recordid":null,
    "sdateTime":null
  }
  ]
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTE標準の訪問介護スケジュールのレイアウトですが、画像にない項目も追加することが可能です。