職員情報取得API

対象の事業所に所属のある職員の情報を取得するAPI

指定期間(updateDate~アクセス日時)に追加・更新が発生した職員情報の差分データのみを取得するAPIとなります。

API ID

ST0001

Request URL

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

HTTPメソッド

POST

リクエスト

header(すべて必須)

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

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
updateDate String YYYY-MM-DDTHH:mm:ss.sssZ 更新日時    

サンプルデータ

{ 
    "updateDate": "2021-01-03T10:00:00.000Z"
}

レスポンス

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
status Number   処理結果を返却する    
updateDate String   データ取得日時    
staff Array          
 staffId String   職員ID    
 family String      
 given String      
 kanafamily String   姓フリガナ (半角カナ)    
 kanagiven String   名フリガナ(半角カナ)    
 birth String   YYYY/MM/DD 生年月日    
 sex Number   性別(1:男性/2:女性)    
 loginID String   ログインID    
 belong Array     所属(全事業所)    
  officeCd String   事業所コード(CAREKARTE)    
  blockCd String     ブロックコード(CAREKARTE)    
  unitCd String     ユニットコード(CAREKARTE)    
  unitNm String     ユニット名(CAREKARTE)    

サンプルデータ

正常データ取得時

{
    "status": 0,
    "updateDate": "2021-10-03T15:15:40.400Z",
    "staff": [
        {
            "staffId": "0000000016",
            "family": "職員",
            "given": "テスト4",
            "kanafamily": "ショクイン",
            "kanagiven": "テストエ",
            "birth": "1989/09/03",
            "sex": 1,
            "loginID": "tes4",
            "belong": [
                {
                    "officeCd": "01",
                    "blockCd": "01",
                    "unitCd": "002",
                    "unitNm": "特養ユニット1-2"
                },
                {
                    "officeCd": "11",
                    "blockCd": "01",
                    "unitCd": "001",
                    "unitNm": "デイサービス"
                }
            ]
        },
        {
            "staffId": "2200000001",
            "family": "ST同期",
            "given": "テスト1",
            "kanafamily": "ドウキ",
            "kanagiven": "テスト",
            "birth": "2016/08/10",
            "sex": 1,
            "loginID": "01",
            "belong": [
                {
                    "officeCd": "11",
                    "blockCd": "01",
                    "unitCd": "001",
                    "unitNm": "デイサービス"
                },
                {
                    "officeCd": "01",
                    "blockCd": "00",
                    "unitCd": "000",
                    "unitNm": ""
                }
            ]
        }
    ]
}

エラー発生時

{
    "code": 400,
    "timestamp": "10/3/2021, 6:28:38 AM",
    "path": "/staff/get",
    "method": "POST",
    "message": "Validation failed: Invalid updateDate"
}

連携イメージ(CAREKARTE)