従業員基本情報更新

PATCH

/staffs/{staff_id}

• サンドボックス
• 本番

従業員基本情報を部分更新します。
送信されたキーのみ更新し、未送信キーは変更しません。

対象

• プラン
  • スタンダード
  • プレミアム
  • プレミアムプラス
  • エンタープライズ

対象ユーザー権限

• 従業員管理編集（全て）
• 従業員管理編集（給与情報除く）

Authorizations

• AppAccessToken
  timecard.staffs:write
• UserAccessToken
  timecard.staffs:write

Parameters

Path Parameters

staff_id

required

string

従業員ID

Example

1

Request Body ^required

object

>= 1 properties

staffName

従業員名

string

>= 1 characters <= 50 characters

staffKana

フリガナ（全角カナ）

string

>= 1 characters <= 50 characters

gender

性別

• 0: 男性
• 1: 女性
• 9: 未選択

string

Allowed values: 0 1 9

birthday

生年月日 [YYYY-MM-DD]

string format: date

nullable

postCode

郵便番号

string

nullable 0 <= 10 characters

address

住所

string

nullable 0 <= 200 characters

phone

電話番号

string

nullable 0 <= 15 characters

employeeClassificationId

従業員区分ID

string

dashboardType

ログイン直後の画面

• 0: 従業員トップ
• 1: 管理者トップ

integer

Allowed values: 0 1

staffCode

社員番号

string

nullable 0 <= 255 characters

hireDate

入社日 [YYYY-MM-DD]

string format: date

nullable

terminationDate

退職日 [YYYY-MM-DD]

string format: date

nullable

terminationReason

退職事由

string

nullable 0 <= 100 characters

roleInEmployeeList

従事する業務の種類

string

nullable 0 <= 100 characters

career

履歴

string

nullable 0 <= 2000 characters

passCode

出退勤パスコード（半角数字4桁）

string

nullable /^[0-9]{4}$/

displaySequence

表示順

integer

nullable >= -99999999 <= 999999999

memo

備考

string

0 <= 1000 characters

adminMemo

管理者メモ

string

0 <= 1000 characters

adminFlag

管理者権限の有無

boolean

foreignerFlag

外国人に該当するかどうか

boolean

stampScreenDisplayFlag

出退勤画面への表示フラグ

boolean

personalWebStampScreenDisplayFlag

個別WEB出退勤画面表示フラグ

boolean

Examples

1項目のみ更新する例

{
  "staffName": "スマレジ太郎（更新）"
}

nullable項目を null / 空文字でクリアする例

{
  "terminationDate": null,
  "memo": ""
}

Responses

200

更新成功

object

staffId

従業員ID

string

Example

{
  "staffId": "1"
}

400

• リクエスト形式が不正な場合
• 空更新、または有効更新キーなしの場合
• 定義外の項目を送信した場合（例: mail, activeFlag）

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Examples

リクエスト形式が不正な場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "リクエスト形式が不正です。"
}

空更新、または有効更新キーなしの場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "更新対象の項目を1つ以上指定してください。"
}

定義外の項目を送信した場合（例: `mail`, `activeFlag`）

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "定義外の項目はこのAPIでは指定できません。（例: mail）"
}

404

指定した従業員IDのデータが存在しない場合

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "データが確認できませんでした。従業員ID: 999"
}