従業員所属事業所登録・更新

PUT

/staffs/{staff_id}/staff_stores/{store_id}

curl --request PUT \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/staffs/1/staff_stores/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "roleId": "2", "displaySequence": 1, "displayFlag": true, "applicationDisplayFlag": true, "mailFlag": false }'

• サンドボックス
• 本番

指定した従業員の所属事業所を登録・更新します（upsert）。

指定した staff_id × store_id の所属が未存在の場合は登録し（201）、 既存の場合は更新します（200）。

対象

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

対象ユーザー権限

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

Authorizations

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

Parameters

Path Parameters

staff_id

required

string

従業員ID

Example

1

store_id

required

string

事業所ID

Example

1

Request Body^required

Media typeapplication/json

object

roleId

required

役割ID

string

displaySequence

事業所内での表示順（0を除く整数）
管理画面では正の値（昇順）、未設定、負の値（降順） の順で表示しています。

登録時に指定しない場合、null（未設定）で登録されます。
更新時に指定しない場合、登録済みの値が保持されます。

integer

nullable >= -99999999 <= 999999999

displayFlag

事業所内での表示設定

• true: 表示する
• false: 表示しない

登録時に指定しない場合、true（表示する）で登録されます。
更新時に指定しない場合、登録済みの値が保持されます。

boolean

applicationDisplayFlag

required

アプリ表示設定

boolean

mailFlag

required

シフト関連の通知を受信するかどうか

• true: 希望する
• false: 希望しない

「希望する」を選択している場合、今月のシフトや、かんたんシフト作成利用時のシフト希望提出依頼を受信します。

boolean

Example

{
  "roleId": "2",
  "displaySequence": 1,
  "displayFlag": true,
  "applicationDisplayFlag": true,
  "mailFlag": false
}

Responses

200

更新成功

Media typeapplication/json

object

staffId

従業員ID

string

storeId

事業所ID

string

roleId

役割ID

string

displaySequence

事業所内での表示順（0を除く整数）
管理画面では正の値（昇順）、未設定、負の値（降順） の順で表示しています。

integer

nullable >= -99999999 <= 999999999

displayFlag

事業所内での表示設定

• true: 表示する
• false: 表示しない

boolean

applicationDisplayFlag

アプリ表示設定

boolean

mailFlag

シフト関連の通知を受信するかどうか

• true: 希望する
• false: 希望しない

「希望する」を選択している場合、今月のシフトや、かんたんシフト作成利用時のシフト希望提出依頼を受信します。

boolean

Example

{
  "staffId": "123",
  "storeId": "1",
  "roleId": "2",
  "displaySequence": 1,
  "displayFlag": true,
  "applicationDisplayFlag": true,
  "mailFlag": false
}

201

作成成功

Media typeapplication/json

object

staffId

従業員ID

string

storeId

事業所ID

string

roleId

役割ID

string

displaySequence

事業所内での表示順（0を除く整数）
管理画面では正の値（昇順）、未設定、負の値（降順） の順で表示しています。

integer

nullable >= -99999999 <= 999999999

displayFlag

事業所内での表示設定

• true: 表示する
• false: 表示しない

boolean

applicationDisplayFlag

アプリ表示設定

boolean

mailFlag

シフト関連の通知を受信するかどうか

• true: 希望する
• false: 希望しない

「希望する」を選択している場合、今月のシフトや、かんたんシフト作成利用時のシフト希望提出依頼を受信します。

boolean

Example

{
  "staffId": "123",
  "storeId": "1",
  "roleId": "2",
  "displaySequence": 1,
  "displayFlag": true,
  "applicationDisplayFlag": true,
  "mailFlag": false
}

400

• リクエスト形式が不正な場合
• 参照整合性・業務制約に違反する場合

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "roleId が指定された事業所に属していません。"
}

404

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

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

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