従業員利用ON/OFF更新

PUT

/staffs/{staff_id}/active

curl --request PUT \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/staffs/1/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "activeFlag": true }'

• サンドボックス
• 本番

従業員の利用設定を更新します。
当月（JST: Asia/Tokyo のカレンダー月）にプラットフォームAPI経由で
打刻・シフト登録・実績登録のいずれかを行なった従業員は利用OFFにすることはできません。

更新可否の最終判定は本API実行時に行います。
事前確認には「従業員利用OFF可否一括事前判定API」を利用してください。

対象

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

対象ユーザー権限

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

Authorizations

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

Parameters

Path Parameters

staff_id

required

string

従業員ID

Example

1

Request Body^required

Media typeapplication/json

object

activeFlag

required

利用設定

• true: 利用する（ON）
• false: 利用しない（OFF）

boolean

Example

{
  "activeFlag": true
}

Responses

200

更新成功

Media typeapplication/json

object

staffId

従業員ID

string

activeFlag

利用設定

boolean

Example

{
  "staffId": "1",
  "activeFlag": true
}

400

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

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Examples

ExampleinvalidFormat

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "activeFlag は true または false で指定してください。"
}

404

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

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

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

422

指定した従業員を利用OFFに更新できない場合

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "detail": "当月中に利用実績があるため、利用OFFに更新できません。従業員ID: 1"
}