役職一覧取得

GET

/positions

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/positions?position_id=1%2C2%2C3&limit=50&page=2&sort=position_rank%2Cposition_id%3Adesc' \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

役職一覧を取得します。

対象

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

Authorizations

• AppAccessToken
  timecard.staffs:read
• UserAccessToken
  timecard.staffs:read

Parameters

Query Parameters

position_id

string

役職ID（カンマ区切りで複数指定可）

Example

?position_id=1%2C2%2C3

limit

integer

default: 30 >= 1 <= 100

上限値

Example

50

page

integer

default: 1 >= 1

検索対象ページ番号

Example

2

sort

string

ソート順
パラメータ名で昇順、パラメータ名:descで降順指定可。カンマ区切りで複数項目指定可。
指定可能キー:

• position_rank
• position_id

指定しない場合、position_rank の昇順でソートされます。

Example

?sort=position_rank%2Cposition_id%3Adesc

Responses

200

取得成功

Media typeapplication/json

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

positions

役職一覧

Array<object>

object

positionId

役職ID

string

positionName

役職名

string

<= 32 characters

positionRank

役職順位

integer

>= 1 <= 999999999

Example

{
  "count": 2,
  "page": 1,
  "pageCount": 1,
  "positions": [
    {
      "positionId": "1",
      "positionName": "店長",
      "positionRank": 1
    },
    {
      "positionId": "2",
      "positionName": "一般",
      "positionRank": 2
    }
  ]
}

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"

400

• パラメータに誤りがある場合
• sort の指定形式が不正、または未許可キーが指定された場合

Media typeapplication/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "sort には position_rank, position_id のみ指定可能です。"
}