CAREKARTEでは職員をチームに割り振ることができます。
チームマスタ取得APIは、事業所に作成されているチーム情報を取得します。
リクエストでブロックレベルやユニットレベルでの絞り込みが可能です。指定がない場合は、事業所にある全てのチーム情報を取得します。
API ID
MST0004
Request URL
team/select
| 環境 | URL |
|---|---|
| Staging環境 | https://stage-api.link.carekarte.jp/team/select |
| 環境 | URL |
|---|---|
| 本番環境 | https://api.link.carekarte.jp/team/select |
HTTPメソッド
POST
リクエスト
header（すべて必須）
| 名前 | 値 |
| Content-Type | application/json |
| authorization | tokenサービスで取得した値を設定 |
Body（JSON形式）
| パラメータ | 型 | 必須：○ 条件付き必須：●(※) |
サイズ・形式 | 説明 | 仕様 |
| blockCd | String | ● | 2桁 | ブロックコード | 絞り込みが不要な場合、パラメータの指定は必要ありません |
| unitCd | String | 3桁 | ユニットコード | 絞り込みが必要な場合、bLockCdの指定も必要となります 絞り込みが不要な場合、パラメータの指定は必要ありません |
※unitCdを指定する場合はblockCdの宣言が必須となります。（blockCdを宣言しない状態でunitCdを宣言するとエラーとなります）
サンプルデータ
{
"blockCd":"01",
"unitCd":"002"
}
レスポンス
Body（JSON形式）
| パラメータ | 型 | 必須 | サイズ・形式 | 説明 | 仕様 |
| result | [array] | ○ | 取得結果 | チーム区分・チームが登録されていない場合、配列は空で返却されます | |
| corpCd | String | 1桁 | 法人コード | ||
| officeCd | String | 2桁 | 事業所コード | ||
| blockCd | String | 2桁 | ブロックコード | ||
| unitCd | String | 3桁 | ユニットコード | ||
| teamsecCd | String | 2桁 | チーム区分コード | ||
| teamsecNm | String | チーム区分名 | |||
| teamsecSort | Number | チーム区分ソート番号 | |||
| teamCd | String | 8桁 | チームコード | チームがない場合空の値が返却されます | |
| teamNm | String | チーム名 | チームがない場合空の値が返却されます | ||
| teamSort | Number | チームソート番号 | チームがない場合空の値が返却されます |
サンプルデータ
チームマスタ取得完了
{
"result": [
{
"corpCd": "1",
"officeCd": "05",
"blockCd": "01",
"unitCd": "002",
"teamsecCd": "01",
"teamsecNm": "ユニ1-2区分1",
"teamsecSort": 1,
"teamCd": "00000001",
"teamNm": "ユニ1-2区分1チム1",
"teamSort": 1
},
{
"corpCd": "1",
"officeCd": "05",
"blockCd": "01",
"unitCd": "002",
"teamsecCd": "01",
"teamsecNm": "ユニ1-2区分1",
"teamsecSort": 1,
"teamCd": "00000002",
"teamNm": "ユニ1-2区分1チム2",
"teamSort": 2
},
{
"corpCd": "1",
"officeCd": "05",
"blockCd": "01",
"unitCd": "002",
"teamsecCd": "02",
"teamsecNm": "ユニ1-2区分2",
"teamsecSort": 2,
"teamCd": "00000001",
"teamNm": "ユニ1-2区分2チム1",
"teamSort": 1
},
{
"corpCd": "1",
"officeCd": "05",
"blockCd": "01",
"unitCd": "002",
"teamsecCd": "02",
"teamsecNm": "ユニ1-2区分2",
"teamsecSort": 2,
"teamCd": "00000002",
"teamNm": "ユニ1-2区分2チム2",
"teamSort": 2
},
{
"corpCd": "1",
"officeCd": "05",
"blockCd": "01",
"unitCd": "002",
"teamsecCd": "03",
"teamsecNm": "ユニ1-2区分3区分のみ",
"teamsecSort": 3,
"teamCd": "",
"teamNm": "",
"teamSort": null
}
]
}
エラー発生時（blockCdが指定されていなかった場合）
{
"ecErrorCode": "",
"elErrorCode": "EL400001",
"message": "[blockCd]の値が正しくありません。",
"method": "POST",
"path": "/team/select",
"code": 400,
"timestamp": "5/19/2022, 4:48:47 AM"
}
連携イメージ(CAREKARTE)
