ID指定利用者情報取得API

特定の利用者基本情報を取得するAPI

利用者IDを使用して最新の利用者情報を取得するAPIです。
利用者の基本情報とCAREKARTEの所属情報を返却します。

API ID

U0005

Request URL

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

HTTPメソッド

POST

リクエスト

header(すべて必須)

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

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様
userId String 10桁 利用者ID  

サンプルデータ

{ 
    "userId": "0000000012"
}

レスポンス

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様
status Number   処理結果を返却する  
updateDate String YYYY-MM-DDTHH:mm:ss.sssZ データ取得日時(UTC)  
userId String 10桁 利用者ID  
family String    
given String    
kanafamily String   姓フリガナ (半角カナ)  
kanagiven String   名フリガナ(半角カナ)  
nicknm String     ニックネーム  
birth String yyyy/mm/dd 生年月日  
sex Number 1桁 性別 1:男性
2:女性
postCd String   7桁 郵便番号  
tel String   12桁 電話番号  
addr String     住所 住所1+住所2
endflg Number 1桁 終結グラフ 0:有効状態
1:削除状態
belong [array]     所属 全事業所分
 officeCd String 2桁 事業所コード  
 officeNm String   事業所名  
 blockCd String   2桁 ブロックコード  
 blockNm String     ブロック名  
 unitCd String   3桁 ユニットコード  
 unitNm String     ユニット名  
 sdate String YYYY-MM-DDT00:00:00+09:00 所属開始日(JST)  
 edate String   YYYY-MM-DDT00:00:00+09:00 所属終了日(JST)  

サンプルデータ

正常データ取得時

{
"status": 0,
"updateDate": "2021-10-03T07:05:54.000Z",
"userId": "0000000012",
"family": "利用者",
"given": "001",
"kanafamily": "リヨウシャ",
"kanagiven": "アア",
"nicknm": "",
"birth": "1960/08/03",
"sex": 2,
"postCd": "",
"tel": "075-221-7744",
"addr": "静岡県静岡市葵区○○1-1",
"endflg": 0,
"belong": [
{
"officeCd": "11",
"officeNm": "【link01】通所介護 フジケア",
"blockCd": "01",
"blockNm": "ブロック",
"unitCd": "001",
"unitNm": "デイサービス",
"sdate": "2019-01-27T00:00:00+09:00",
"edate": ""
},
{
"officeCd": "21",
"officeNm": "【link01】訪問介護(予定・記録合体版)",
"blockCd": "01",
"blockNm": "ブロック",
"unitCd": "001",
"unitNm": "訪問介護",
"sdate": "2019-08-01T00:00:00+09:00",
"edate": ""
},
{
"officeCd": "12",
"officeNm": "【link01】通所リハビリ 富士園",
"blockCd": "01",
"blockNm": "ブロック",
"unitCd": "001",
"unitNm": "通所リハ",
"sdate": "2021-01-01T00:00:00+09:00",
"edate": ""
},
{
"officeCd": "25",
"officeNm": "【link01】訪問看護 富士",
"blockCd": "01",
"blockNm": "ブロック",
"unitCd": "001",
"unitNm": "訪問看護",
"sdate": "2019-11-18T00:00:00+09:00",
"edate": ""
},
{
"officeCd": "T1",
"officeNm": "【link01】特別養護老人ホーム コード文字列",
"blockCd": "01",
"blockNm": "特養1F",
"unitCd": "001",
"unitNm": "特養ユニット1-1",
"sdate": "2021-05-01T00:00:00+09:00",
"edate": ""
}
]
}

API個別エラー

HTTPコード message エラー説明
400 “該当するIDの利用者が存在しません” リクエスト内容を修正してください。
400 “Validation failed: userId must be a string” 利用者IDの形式を修正してください。
{
"code": 400,
"timestamp": "10/3/2021, 7:07:59 AM",
"path": "/user/get5",
"method": "POST",
"message": "該当するIDの利用者が存在しません"
}

連携イメージ(CAREKARTE)