Skip to main content

PRV_STF_002：【取得】スタッフ情報

処理概要​

PLAT 上で管理しているスタッフ情報を取得する。

機能 IDAPI 論理名HTTP メソッドURI
PRV_STF_002【取得】スタッフ情報GET{applicationPath}/providers/staffs/{staffId}
連携方式データ形式利用可能な接続先
REST APIJSON 形式（エンコーディング：utf-8）ローカル、リモート

リクエスト（認証）​

No.項目名物理名属性Nullable設定要領
1アクセストークンAuthorizationstring-認証処理で取得した Bearer Token を設定

リクエスト（クエリ）​

クエリパラメータとパスパラメータが指定されていない場合は、一覧を返却する。

No.項目名物理名属性Nullable設定要領
1参照先locationstring○参照先（スタッフ管理）
2名称namestring○漢字もしくはカナの前方一致検索

リクエスト（パスパラメータ）​

No.項目名物理名属性Nullable設定要領
1スタッフ IDstaffIdstring-スタッフ ID を設定する。

リクエスト(Body)​

No.項目名物理名L1L2L3L4L5L6繰返し属性Nullableリクエスト設定要領
-

サンプル（リクエスト）​

＜パスパラメータ指定の場合＞

　　{applicationPath}/providers/staffs/3fa04331-85fd-4cb5-819d-d240145a74ca

＜クエリパラメータ指定の場合＞

　　{applicationPath}/providers/staffs?name=ヤマダタロウ

レスポンス​

No.項目名物理名L1L2L3L4L5L6繰返し属性Nullableレスポンス設定要領
1リスト-○array-
2スタッフ IDstaffId○string-
3救急フラグemergencyFlg○string-救急フラグ
4名前(漢字)nameKanji○string-
5名前(カナ)namekana○string-
6バージョンversion○string-
7更新日時updatedDatetime○string-
エラー条件
システムエラー
・API 共通仕様に準拠
業務エラー
・なし

サンプル（レスポンス）​

正常終了
[
  {
    "staffId": "aef656e5-0735-4757-a369-83a2b34110bd",
    "emergencyFlg": 0,
    "nameKanji": "田中一郎",
    "nameKana": "タナカイチロウ",
    "version": 0,
    "updatedDatetime": "Oct 7, 2021, 7:50:46 PM"
  },
  {
    "staffId": "ececfc9e-4b53-48c0-96da-482ffdf69a95",
    "emergencyFlg": 0,
    "nameKanji": "佐藤次郎",
    "nameKana": "サトウジロウ",
    "version": 0,
    "updatedDatetime": "Oct 7, 2021, 7:50:50 PM"
  }
]
異常終了
{
  "errorCode": "PLAT500"
}

備考​

なし