事業所所属利用者情報(住所、電話番号追加版)取得API

任意の日付、ブロックユニットに所属する利用者の一覧情報を取得するAPI

日付指定がない場合は現在日に所属する利用者の一覧を取得します。
ブロックやユニットの指定がない場合は事業所に所属する利用者の一覧を取得します。
所属がない利用者、すでに利用が終結している利用者は返却対象外となります。

API ID

U0009

Request URL

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

HTTPメソッド

POST

リクエスト

header(すべて必須)

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

Body(JSON形式)

JSON形式
指定した日時、事業所、ブロック、ユニットに有効な所属がある かつ DAI.endflgが0の利用者を抽出する

パラメータ 必須 サイズ・形式 説明 仕様
selectDate String   YYYY-MM-DD 情報を取得する日付指定(JST時刻) 入力がない場合は現在日が自動で入力される
blockCd String 入力文字数2バイト ブロックコード(CAREKARTE) unitCdがリクエストされている場合必須
unitCd String   入力文字数3バイト ユニットコード(CAREKARTE)  

レスポンス

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様
selectDate String YYYY-MM-DD データ取得日時(JST) リクエストのsalectDateの日付が入力される
user Array        
 userId String     利用者ID(個人番号)  
 family String     入力文字数40バイト以内
 given String     入力文字数40バイト以内
 kanafamily String     姓フリガナ (半角カナ) 入力文字数60バイト以内
 kanagiven String     名フリガナ(半角カナ) 入力文字数60バイト以内
 nicknm String     ニックネーム  
 birth String   yyyy/mm/dd 生年月日  
 sex Number     性別(1:男性/2:女性)  
 tel String     電話番号  
 postCd String     郵便番号  
 addr String     住所  

サンプルデータ

正常データ取得時
{
    "selectDate": "2023-02-21",
    "user": [
        {
            "userId": "0000000001",
            "family": "利用者",
            "given": "1",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアア"
            "nicknm": "",
            "birth": "1950/05/29",
            "sex": "1",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
        },
        {
            "userId": "0000000003",
            "family": "利用者",
            "given": "3",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアウ"
            "nicknm": "",
            "birth": "1950/06/01",
            "sex": "1",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
        },
        {
            "userId": "0000000004",
            "family": "利用者",
            "given": "4",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアエ"
            "nicknm": "",
            "birth": "1950/06/02",
            "sex": "2",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",

        },
        {
            "userId": "0000000005",
            "family": "利用者",
            "given": "5",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアオ"
            "nicknm": "",
            "birth": "1950/06/03",
            "sex": "1",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
        },
        {
            "userId": "0000000006",
            "family": "利用者",
            "given": "6",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアカ"
            "nicknm": "",
            "birth": "1950/06/04",
            "sex": "2",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
        },
        {
            "userId": "0000000007",
            "family": "利用者",
            "given": "7",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアキ"
            "nicknm": "",
            "birth": "1950/06/05",
            "sex": "1",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
        },
        {
            "userId": "0000000008",
            "family": "利用者",
            "given": "8",
            "kanafamily": "リヨウシャ",
            "kanagiven": "アアク"
            "nicknm": "",
            "birth": "1950/06/06",
            "sex": "2",
            "tel": "075-221-7744",
            "postCd": "1234567",
            "addr": "静岡県静岡市葵区○○1-1",
       
        }
    ]
}

エラーレスポンス

エラーレスポンスを参照してください。

連携イメージ(CAREKARTE)