利用者所属取得API

利用者の所属期間を取得するAPI

取得期間開始日、取得期間終了日で指定された期間と、CAREKARTEの所属期間が重複するレコードが返却されます。
APIキーが関連付けされている事業所以外のレコードも取得されます。
法人コードや事業所コードはO0001：事業所情報取得APIなどで取得してください。

取得したレコードは以下の条件でソートされます
1.法人コードの昇順
2.事業所コードの昇順
3.ブロックコードの昇順
4.ユニットコードの昇順
5.所属開始日の昇順

API ID

UB0004

Request URL

user-belong/select
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/user-belong/select
環境 URL
本番環境 https://api.link.carekarte.jp/user-belong/select

HTTPメソッド

POST

リクエスト

ヘッダー

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

ボディ

パラメータ名 物理パラメータ名 型 必須 文字桁数 文字種/形式 仕様
利用者ID userId String 〇 10桁 半角数字 U0007　事業所所属利用者一覧取得API等から取得してください。
取得期間開始日 selectSdate String 〇 1桁 半角数字  
取得期間終了日 selectEdate String 〇 2桁 半角数字  

サンプルデータ

{
     "userId": "0000000001",
     "selectSdate": "2021-10-01",
     "selectEdate": "2022-10-01"
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ名 型 文字桁数 文字種/形式 仕様
利用者番号 userId   String 10桁   リクエストしたuserIdが返却されます
取得所属 belong   Array      
法人コード   corpCd String 1桁    
法人名   corpNm String      
事業所コード   officeCd String 2桁    
事業所名   officeNm String      
ブロックコード   blockCd String 2桁    
ブロック名   blockNm String      
ユニットコード   unitCd String 3桁    
ユニット名   unitNm String      
所属開始日   sdate String   YYYY-MM-DD  
所属終了日   edate String   YYYY-MM-DD  

 

利用者所属の取得に成功した際のサンプルデータ

{
    "userId": "0000000001",
    "belong": [
        {
            "corpCd": "1",
            "corpNm": "【linktest】社会福祉法人　富士会",
            "officeCd": "01",
            "officeNm": "【linktest】特別養護老人ホーム　新富士園",
            "blockCd": "01",
            "blockNm": "特養1F",
            "unitCd": "001",
            "unitNm": "特養ユニット1-1",
            "sdate": "2024-06-01",
            "edate": "2024-06-30"
        },
        {
            "corpCd": "1",
            "corpNm": "【linktest】社会福祉法人　富士会",
            "officeCd": "01",
            "officeNm": "【linktest】特別養護老人ホーム　新富士園",
            "blockCd": "02",
            "blockNm": "特養2F",
            "unitCd": "001",
            "unitNm": "特養ユニット2-1",
            "sdate": "2024-06-01",
            "edate": "2024-06-30"
        },
        {
            "corpCd": "1",
            "corpNm": "【linktest】社会福祉法人　富士会",
            "officeCd": "11",
            "officeNm": "【linktest】通所介護 フジケア",
            "blockCd": "01",
            "blockNm": "ブロック",
            "unitCd": "001",
            "unitNm": "デイサービス",
            "sdate": "2024-06-01",
            "edate": "2024-06-02"
        }
    ]
}

エラーレスポンス

メニューのエラーレスポンスを参照してください

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEで所属を確認できる画面です。