アクセス時点で所属のある職員の情報一覧を取得するAPI
指定した日付時点で対象事業所に所属がある職員情報を取得可能です。
所属情報はなく、職員情報のみを返却します。
Request URL
staff/officestfget
| 環境 |
URL |
|---|
| Staging環境 |
https://stage-api.link.carekarte.jp/staff/officestfget |
| 環境 |
URL |
|---|
| 本番環境 |
https://api.link.carekarte.jp/staff/officestfget |
リクエスト
header（すべて必須）
| 名前 |
値 |
| Content-Type |
application/json |
| authorization |
tokenサービスで取得した値を設定 |
Body（JSON形式）
| パラメータ |
型 |
必須 |
サイズ・形式 |
説明 |
仕様 |
CAREKARTEタイトル項目 |
| selectDate |
String |
○ |
YYYY-MM-DD |
データ取得日時 |
指定した日付時点で対象事業所に
所属がある職員の情報を取得する(JST) |
|
サンプルデータ
{
"selectDate":"2021-09-11"
}
レスポンス
Body（JSON形式）
| パラメータ |
型 |
必須 |
サイズ・形式 |
説明 |
仕様 |
CAREKARTEタイトル項目 |
| message |
String |
|
|
メッセージ |
エラー等、メッセージがあれば返却 |
|
| selectDate |
String |
○ |
YYYY-MM-DD |
データ取得日時 |
|
|
| staff |
Array |
|
|
|
|
|
| staffId |
String |
○ |
|
職員ID |
|
|
| family |
String |
○ |
|
姓 |
|
|
| given |
String |
○ |
|
名 |
|
|
| kanafamily |
String |
○ |
|
姓フリガナ （半角カナ） |
|
|
| kanagiven |
String |
○ |
|
名フリガナ（半角カナ） |
|
|
| loginID |
String |
○ |
|
ログインID |
|
|
サンプルデータ
記録の取得完了
{
"selectDate": "2021-09-11",
"staff": [
{
"staffId": "0000000001",
"family": "職員",
"given": "イチ",
"kanafamily": "ｼｮｸｲﾝ",
"kanagiven": "ｲﾁ",
"loginID": "staff01"
},
{
"staffId": "0000000001",
"family": "職員",
"given": "二",
"kanafamily": "ｼｮｸｲﾝ",
"kanagiven": "ﾆ",
"loginID": "staff02"
},
{
"staffId": "0000000001",
"family": "職員",
"given": "さん",
"kanafamily": "ｼｮｸｲﾝ",
"kanagiven": "ｻﾝ",
"loginID": "staff03"
}
]
}
API個別エラー
| HTTPコード |
message |
エラー説明 |
| 400 |
“所属が有効な職員が存在していません。” |
リクエスト内容を修正してください。 |
| 400 |
“selectDate must in YYYY-MM-DD format” |
日付の形式を修正してください。 |
{
"code": 400,
"timestamp": "10/14/2021, 9:55:40 AM",
"path": "/staff/officestfget",
"method": "POST",
"message": "selectDate must in YYYY-MM-DD format"
}
