入所系スケジュール登録API

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

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

API ID

SC0004

Request URL

staysch/add
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/staysch/add/{{カテゴリ}}
環境 URL
本番環境 https://api.link.carekarte.jp/staysch/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等から取得してください。
職員ID staffId String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
ブロックコード blockCd String 2 半角英数字 MST0003 部屋マスタ取得APIから取得してください。
ユニットコード unitCd String 3 半角英数字 MST0003 部屋マスタ取得APIから取得してください。
居室コード roomCd String 3 半角英数字 MST0003 部屋マスタ取得APIから取得してください。
ベッドコード bedCd String 3 半角英数字 MST0003 部屋マスタ取得APIから取得してください。
開始日時 sdateTime String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
利用者の所属期間内を指定してください。
CAREKARTEでは秒数以下は切り捨てとなります。
終了日時 edateTime   String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
指定しない場合は、終了日時が未定として登録されます
デフォルト記録フラグ defaultFlag   Boolean     CAREKARTEでは記録に対してあらかじめデフォルトの値を設定でき、
そのデフォルト値を使用するか否かのフラグです。

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

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

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

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

URL:/staysch/add/longstay //longstayがカテゴリ

HTTPメソッド:POST

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

body:
{ 
   "userId": "0000000001",
   "staffId": "0000000001",
   "blockCd": "01",
   "unitCd": "001",
   "roomCd": "001",
   "bedCd": "001",
   "sdateTime":"2022-06-01T09:00:00.000Z",
   "defaultFlag":false,
 //以下リンクパラメータ
    "note":"備考",
    "inStatus":"1",
    "incomment":"入所状況コメント",
    "innote":"入所備考"
 }

レスポンス

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ名 必須 文字桁数 文字種/形式 仕様
登録スケジュール schedule   [array]      
結果   recordResult Boolean     登録に成功した場合 true
登録に失敗した場合 false
が返却されます
falseとなったスケジュールのみ、再度リクエストを送信してください。
利用者ID   userId String 10 半角英数字  
記録ID   recordId Number     利用者IDと記録IDの組み合わせでユニークとなります。
開始日時   sdateTime String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
登録したスケジュールの開始日時が返却されます

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

{ 
  "schedule":[
  {
    "recordResult":true,
    "userId":"0000000001",
    "recordid":12345,
    "sdateTime":"2022-06-01T09:00:00.000Z"
  }
  ]
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

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