役割・役職取得

GET

/roles/{role_id}

サンドボックス
本番

役割・役職の一覧を取得します。

対象プラン

プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.staffs:read
UserAccessToken
pos.staffs:read

Parameters

Path Parameters

role_id

required

string

役割・役職ID

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

with_function_controls

string

default: none

Allowed values: all none

機能制限情報を付加するか(付加する場合はall, しない場合はnone)

with_inventory_function_controls

string

default: none

Allowed values: all none

対象プラン リテールビジネス
在庫機能制限情報を付加するか(付加する場合はall, しない場合はnone)

with_alert_function_controls

string

default: none

Allowed values: all none

対象プラン リテールビジネス
機能制限情報を付加するか(付加する場合はall, しない場合はnone)

Responses

200

取得成功

Array<object>

object

roleId

役割・役職ID

string

roleName

役割名・役職名

string

note

説明

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

functionControls

機能制限：POS機能における役割・役職に対する機能制限の一覧です。

Array<object>

object

functionId

機能ID：制限対象機能のIDです。
1:トップページ機能
2:商品管理機能 ※ 下記2000番台にある商品管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
3:日次処理機能
4:取引履歴機能
5:売上分析機能
6:店舗管理機能
7:スタッフ管理機能 ※ 下記7000番台にあるスタッフ管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
8:予算管理機能
9:会員管理機能
10:スマレジ・ストア機能
11:値札発行機能（非推奨）※ 商品管理機能個別設定へ移行するため将来的に入力チェックでエラーとなる予定です。商品管理機能個別設定（2012:値札発行）の設定が存在する場合、個別設定権限の方が優先して適用されます。
12:各種設定機能
13:原価表示機能
14:一括削除機能
15:アプリ通知機能
16:PL管理機能
18:ポイント管理機能
19:集計パターン保存・削除権限
20:レジ端末印刷機能
2001:商品
2002:部門
2003:仕入先
2004:在庫調整
2005:お気に入り商品（アイコン）
2006:価格変更履歴
2007:セール
2008:オプショングループ
2009:バンドル販売
2010:販売商品パターン
2011:属性
2012:値札発行
7001:スタッフ
7002:役割・役職
7003:ログイン情報編集権限

string

controlDivision

制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

inventoryFunctionControls

対象プラン リテールビジネス
在庫機能制限：在庫機能における役割・役職に対する機能制限の一覧です。

Array<object>

object

functionId

対象プラン リテールビジネス
機能ID：制限対象機能のIDです。
1:発注管理機能
2:発注設定機能
3:入荷管理機能
4:出庫管理機能
5:入庫管理機能
6:棚卸機能
7:在庫分析機能
8:在庫高機能
9:在庫一覧機能
10:ロス管理機能
11:出荷管理機能
12:棚卸完了権限

string

controlDivision

対象プラン リテールビジネス
制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

alertFunctionControls

対象プラン リテールビジネス
アラート機能制限：在庫アラートにおける役割・役職に対する機能制限の一覧です。

Array<object>

object

alertType

対象プラン リテールビジネス
アラート種別：制限対象アラートの種別です。（1:在庫切れ、2:発注点）

string

controlDivision

対象プラン リテールビジネス
制限区分：対象機能に対する制限区分です。（0:使用不可、1:使用可）

string

Example

[
  {
    "roleId": "string",
    "roleName": "string",
    "note": "string",
    "insDateTime": "string",
    "updDateTime": "string",
    "functionControls": [
      {
        "functionId": "string",
        "controlDivision": "string"
      }
    ],
    "inventoryFunctionControls": [
      {
        "functionId": "string",
        "controlDivision": "string"
      }
    ],
    "alertFunctionControls": [
      {
        "alertType": "string",
        "controlDivision": "string"
      }
    ]
  }
]

404

指定された役割・役職が存在しない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}