【公開停止】来客情報登録API

来客情報を来客記録タイトル(カスタマイズ)へ連携する登録用API

API ID

C0002

Request URL

caller/add2
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/caller/add2
環境 URL
本番環境 https://api.link.carekarte.jp/caller/add2

HTTPメソッド

POST

リクエスト

header(すべて必須)

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

Body(JSON形式)

パラメータ 必須:○ サイズ・形式 説明 仕様 CAREKARTEタイトル項目
callerNm String   来訪者氏名   来客者氏名
dateTime String YYYY-MM-DDTHH:mm:ss.sssZ 来客日時   来客日時
callerTell String   来訪者連絡先   来客者連絡先
reason String     来客の理由   来客理由
userId String   10桁 利用者ID    
userNm String     来訪先利用者名    
userRm String     来訪先部屋名    
callerRs String     来訪先との関係 連携可能項目:ご家族/ご親戚/ご友人/その他 来訪先との関係
baggage String     持ち込み品   持ち込み品
callerTemp Number     体温   体温
check1 String     汎用選択項目1 連携可能項目::あり/なし/その他 ※汎用項目名1
check2 String     汎用選択項目2 連携可能項目::あり/なし/その他 ※汎用項目名2
check3 String     汎用選択項目3 連携可能項目::あり/なし/その他 ※汎用項目名3

サンプルデータ

{ 
    "callerNm":"来客 太郎",
    "dateTime":"2021-09-11T00:03:11.123Z",
    "callerTell":"090-1111-1111",
    "reason":"面会",
    "userId": "0000000025",
    "userNm": "利用者009",
    "userRm":"卯月",
    "baggage":"お菓子、ジュースの差し入れ",
    "callerTemp":36.7,
    "check1":"あり",
    "check2":"あり",
    "check3":"なし"
}

レスポンス

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
status Number   処理結果    
recordId Number[array]   記録ID 利用者ごとのユニークID  

サンプルデータ

記録の取得完了
{
    "status": 0,
    "recordId": [
        350
    ]
}

エラー発生時(存在しない利用者のIDの場合)
{
    "code": 400,
    "timestamp": "9/11/2021, 2:28:50 AM",
    "path": "/caller/add2",
    "method": "POST",
    "message": "userId does not belonging to API KEY's Office"
}

連携イメージ(CAREKARTE)