グループマスタ取得API

CAREKARTEでは利用者をグループに割り振ることができます。

グループマスタ取得APIは、事業所に作成されているグループ情報を取得します。
リクエストでブロックレベルやユニットレベルでの絞り込みが可能です。指定がない場合は、事業所にある全てのグループ情報を取得します。

API ID

MST0005

Request URL

group/select
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/group/select
環境 URL
本番環境 https://api.link.carekarte.jp/group/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"
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
result [array] ○   取得結果 グループ区分・グループが登録されていない場合、配列は空で返却されます
　corpCd String   1桁 法人コード  
　officeCd String   2桁 事業所コード  
　blockCd String   2桁 ブロックコード  
　unitCd String   3桁 ユニットコード  
　groupsecCd String   2桁 グループ区分コード  
　groupsecNm String     グループ区分名  
　groupsecSort Number     グループ区分ソート番号  
　groupCd String   8桁 グループコード グループがない場合空の値が返却されます
　groupNm String     グループ名 グループがない場合空の値が返却されます
　groupSort Number     グループソート番号 グループがない場合空の値が返却されます

 

サンプルデータ

グループマスタの取得完了
{
    "result": [
        {
            "corpCd": "1",
            "officeCd": "11",
            "blockCd": "01",
            "unitCd": "001",
            "groupsecCd": "01",
            "groupsecNm": "ユニ1-1区分1",
            "groupsecSort": 1,
            "groupCd": "00000001",
            "groupNm": "ユニ1-1区分1グル1",
            "groupSort": 2
        },
        {
            "corpCd": "1",
            "officeCd": "11",
            "blockCd": "01",
            "unitCd": "001",
            "groupsecCd": "01",
            "groupsecNm": "ユニ1-1区分1",
            "groupsecSort": 1,
            "groupCd": "00000002",
            "groupNm": "ユニ1-1区分1グル2",
            "groupSort": 1
        },
        {
            "corpCd": "1",
            "officeCd": "11",
            "blockCd": "01",
            "unitCd": "001",
            "groupsecCd": "02",
            "groupsecNm": "ユニ1-1区分2",
            "groupsecSort": 2,
            "groupCd": "00000001",
            "groupNm": "ユニ1-1区分2グル1",
            "groupSort": 1
        },
        {
            "corpCd": "1",
            "officeCd": "11",
            "blockCd": "01",
            "unitCd": "001",
            "groupsecCd": "02",
            "groupsecNm": "ユニ1-1区分2",
            "groupsecSort": 2,
            "groupCd": "00000002",
            "groupNm": "ユニ1-1区分2グル2",
            "groupSort": 2
        },
        {
            "corpCd": "1",
            "officeCd": "11",
            "blockCd": "01",
            "unitCd": "002",
            "groupsecCd": "01",
            "groupsecNm": "ユニ1-2区分のみ",
            "groupsecSort": 1,
            "groupCd": "",
            "groupNm": "",
            "groupSort": null
        }
    ]
}

エラー発生時（blockCdの値が不正だった場合）
{
    "ecErrorCode": "",
    "elErrorCode": "EL400001",
    "message": "[blockCd]の値が正しくありません。",
    "method": "POST",
    "path": "/group/select",
    "code": 400,
    "timestamp": "5/23/2022, 7:08:19 AM"
}

連携イメージ(CAREKARTE)