【公開停止】巡回情報登録API(デフォルト記録対応版)

利用者の巡回の実施情報を、巡回の記録タイトルへ連携する登録用API
デフォルト記録に対応

API ID

VI0002

Request URL

visitation/add-d
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/visitation/add-d
環境 URL
本番環境 https://api.link.carekarte.jp/visitation/add-d

HTTPメソッド

POST

リクエスト

header（すべて必須）

Content-Type application/json
authorization tokenサービスで取得した値を設定

Body（JSON形式）

パラメータ 型 必須：○
条件付き：△(※)		 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId string ○ 10桁 利用者ID    
sdateTime string ○ YYYY-MM-DDTHH:mm:ss.sssZ 記録開始日時(UTC)    
edateTime string   YYYY-MM-DDTHH:mm:ss.sssZ 記録終了日時(UTC) パラメータがない、もしくは記録開始日時より以前の値が入っていた場合は、記録開始日時と同じ値を格納  
defaultFlag boolean     デフォルト記録フラグ trueの場合、デフォルト記録の処理を行う。
false、もしくはパラメータがない場合、デフォルト記録の処理は行わない。		  
handoverFlag boolean     申し送りフラグ trueの場合、申し送りフラグON
false、もしくはパラメータがない場合、申し送りフラグOFF		  
section string △   実施区分 連携可能文字列：実施
文字列内、前方より一致したものを優先する		 実施
state string △   様子   様子
support string △   対応   対応
staffId string ○ 10桁 職員ID    

※必須項目欄の入力項目△については、△部分が全て空の値の場合、記録を作成せず400エラーを返却する。空欄部分の入力有無は、記録の作成に影響しない。

サンプルデータ

{
    "userId": "0000000022",
    "sdateTime":"2021-09-18T12:00:00.000Z" ,
    "edateTime":"2021-09-18T12:00:00.000Z" ,
    "staffId": "0000000015",
    "defaultFlag":true,
    "handoverFlag":true,
    "section":"中止"
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10桁 利用者ID    
recordId Number[array] ○   記録ID 利用者ごとのユニークID  

サンプルデータ

記録の登録完了
{
    "userId": "0000000022",
    "recordId": [
        1977
    ]
}

エラー発生時（記録作成対象データがない場合）
{
    "code": 400,
    "timestamp": "9/18/2021, 9:29:23 AM",
    "path": "/visitation/add-d",
    "method": "POST",
    "message": "値が入力されていないため記録を作成できませんでした"
}

連携イメージ(CAREKARTE)

デフォルト記録 連携データ 連携記録の採用データ
あり あり 連携データ
あり なし デフォルト記録
なし あり 連携データ
なし なし 該当データなし