ヘルプセンター
background
SmartHR APIのリリースノート
  1. SmartHRヘルプセンター
  2. リリースノート
  3. SmartHR APIのリリースノート
  4. 2024/11/21 従業員リストを取得するAPIで、ビジネスネーム優先でフリーワード検索できるようになりました 他1件

2024/11/21 従業員リストを取得するAPIで、ビジネスネーム優先でフリーワード検索できるようになりました 他1件

2024年11月21日(木)に行なったアップデートの詳細をお知らせします。

SmartHR APIの変更点は、改善1件・不具合修正1件でした。

📈 改善

従業員リストを取得するAPIで、ビジネスネーム優先でフリーワード検索できるようになりました

[従業員]のAPIのリスト取得(GET /api/v1/crews)で、ビジネスネームを優先するパラメーター(prefer_business_name)を指定できるようになりました。

これまでは、氏名とビジネスネームの両方から従業員を検索する方法のみ提供していました。そのため、ビジネスネームで業務を行なう従業員が氏名からも検索されてしまい、使いにくい場合がありました。

このパラメーターを設定することで、ビジネスネームが設定されている従業員をビジネスネームで、それ以外の従業員を氏名で検索することが可能になりました。

なお、アクセストークンの設定でアトリビュート(従業員出力項目)の参照権限を有効にしているかどうかで、検索対象となる従業員が変わります。

氏名ビジネスネーム検索対象
参照権限あり参照権限ありすべての従業員
参照権限あり参照権限なしビジネスネームが未設定の従業員
参照権限なし参照権限ありビジネスネームが設定済の従業員
  • 氏名に該当する項目名
    • 姓(カタカナ)
    • 名(カタカナ)
  • ビジネスネームに該当する項目名
    • ビジネスネーム:姓
    • ビジネスネーム:名
    • ビジネスネーム:姓(カタカナ)
    • ビジネスネーム:名(カタカナ)

👨‍⚕️ 不具合修正

申請フォームから家族を別居から同居に変更するとエラーになる不具合を修正しました

家族情報を含む申請フォームを提出後、差し戻しされた後に再度、扶養しない家族を別居から同居に変更して提出すると「従業員情報に不整合が発生しています」というエラー画面が表示される不具合を修正しました。