帳票取得API(PDF版)

CAREKARTEの帳票の記録をPDFで取得することができるAPI

PDFで取得できる帳票記録はCAREKARTEの「フェイスシート」「施設サービス計画表第２表」等、CAREKARTEの帳票の記録がPDFに表示されるとなります。具体例はページ下部にあるリクエスト・レスポンスのサンプルデータとCAREKARTE連携イメージを参照してください。

このAPIを使用するにはCCJ側の設定が必須となります。どのような帳票をCAREKARTEからPDFで取得したいかを確認の上で、お問い合わせよりご相談ください。

API ID

D0004

Request URL

documents/pdf-select

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

環境	URL
本番環境	https://api.link.carekarte.jp/documents/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)の形式で日時データを連携します。

ボディ

パラメータ名	物理パラメータ名	必須	型	文字桁数	文字種/形式	仕様
利用者ID	userId	○	String	10	半角数字	CAREKARTEに登録されている利用者番号です
記録ID	recordId	△	Number	–	–	userIdに紐づけられたCAREKARTE記録IDです
帳票有効期間終了日	selectEdateTime	△	String	–	YYYY-MM-DD HH:mm:ss または ISO8601形式
帳票有効期間終了日時	selectEdateTime		String	–	YYYY-MM-DD HH:mm:ss または ISO8601形式	selectSdateTimeが宣言されているが、selectEdateTimeが宣言されていない場合、selectEdateTimeにselectSdateTimeを格納する

フェイスシートの記録を取得するサンプルデータ（実際にリクエストしても使用できません）

URL：documents/pdf-select/linktest-facesheet　//linktest-facesheetがカテゴリ

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

body：
{
   "userId": "0000000001",
   "recordId": 9169,
   "selectSdateTime":"2022-08-01T00:00:00.000Z",
   "selectEdateTime":"2022-08-31T23:59:00.000Z"
 }

レスポンス

ボディ

パラメーター名	物理パラメータ名	型	文字行数	文字種/形式	仕様
利用者ID	userId	String	10		リクエストのuserIdと同値です。
記録ID	recordId	Number
記録タイトル名	recordTitle	String
帳票有効期間開始日	sdateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
帳票有効期間終了日	edateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
記録作成職員ID	staffId	String	10	半角英数字
帳票更新日	lastUpdateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
記録更新職員ID	updateStaffId	String	10	半角英数字
申し送りフラグ	handoverFlag	Boolean			true：申し送りの記録です false：申し送りの記録ではありません
削除フラグ	delFlag	Boolean			true：削除された記録です（論理削除） false：削除された記録ではありません
帳票のPDF化	pdf	String		base64文字列	帳票APIの出力

帳票（フェイスシート）の記録の取得に成功した際のサンプルデータ

{ 
 "userId": "0000000001",
    "recordId": 9169,
    "recordTitle": "フェイスシート(特養)",
    "sdateTime": "2024-03-11 10:00:00",
    "edateTime": "2500-01-01 00:00:00",
    "staffId": "0000000013",
    "lastUpdateTime": "2024-03-11 11:17:00",
    "updateStaffId": "0000000013",
    "handoverFlag": false,
    "pdf": "JVBERi0xLjcKCjQgMCBvY.....
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEの標準の特養フェイスシートのレイアウトです。

リクエスト・レスポンス例ではフェイスシートをしているため、左記（CAREKARTE上の帳票）が右記のようなPDFとして返却されます。

※PDFの取得は、Base64での返却となりますためデコーディングツールが必要となります

イメージ画像はCAREKARTEの帳票のレイアウトです。

「カレンダー部品」「動画エリア」「文書エリア」は次頁以降に表示され、レイアウトが自動調整されます。
また、「動画エリア」「文書エリア」の内容は本APIでは取得できません。