勤務パターン一覧

GET

/shift_patterns

サンドボックス
本番

勤務パターン一覧を取得します

対象

プラン
- スタンダード、旧無料
- プレミアム
- プレミアムプラス
- エンタープライズ、旧有料

対象ユーザー権限

事業所管理閲覧

Authorizations

AppAccessToken
timecard.stores:read
UserAccessToken
timecard.stores:read

Parameters

Query Parameters

store_id

string

事業所ID（カンマ区切りで複数指定可）

Examples

単一指定

複数指定

1,2

shift_pattern_id

string

勤務パターンID（カンマ区切りで複数指定可）

Examples

単一指定

複数指定

1,2

shift_pattern_name

string

>= 1 characters <= 15 characters

勤務パターン名（部分一致で検索）

Example

朝

limit

integer

default: 30 >= 1 <= 100

上限値

Example

page

integer

default: 1 >= 1

検索対象ページ番号

Example

sort

string

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

store_id
shift_pattern_id
attendance_time

指定しない場合、事業所ID、出勤時刻の昇順でデータがソートされます。

Examples

単一指定

store_id

複数指定

store_id:desc,attendance_time

Responses

200

取得成功

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

shiftPatterns

勤務パターン一覧

Array<object>

unique items

object

shiftPatternId

勤務パターンID

string

storeId

事業所ID

string

shiftPatternName

勤務パターン名

string

>= 1 characters <= 15 characters

shiftPatternShortName

略称

string

0 <= 4 characters

color

カラー

string

nullable /^#[a-fA-F0-9]{6}$/

attendanceTime

出勤時刻

string

/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

leavingTime

退勤時刻

string

/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

break1StartTime

休憩1 開始時刻

string

nullable /^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

break1EndTime

休憩1 終了時刻

string

nullable /^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

break2StartTime

休憩2 開始時刻

string

nullable /^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

break2EndTime

休憩2 終了時刻

string

nullable /^([0-1][0-9]|2[0-3]):[0-5][0-9]$/

{
  "count": 15,
  "page": 1,
  "pageCount": 2,
  "shiftPatterns": [
    {
      "shiftPatternId": "1",
      "storeId": "1",
      "shiftPatternName": "通常勤務",
      "shiftPatternShortName": "通常",
      "color": null,
      "attendanceTime": "09:00",
      "leavingTime": "18:00",
      "break1StartTime": "12:00",
      "break1EndTime": "13:00",
      "break2StartTime": null,
      "break2EndTime": null
    },
    {
      "shiftPatternId": "2",
      "storeId": "1",
      "shiftPatternName": "早番",
      "shiftPatternShortName": "早",
      "color": "#FFC107",
      "attendanceTime": "06:00",
      "leavingTime": "15:00",
      "break1StartTime": "09:00",
      "break1EndTime": "09:30",
      "break2StartTime": "12:00",
      "break2EndTime": "13:00"
    },
    {
      "shiftPatternId": "3",
      "storeId": "2",
      "shiftPatternName": "遅番",
      "shiftPatternShortName": "遅",
      "color": "#FF5722",
      "attendanceTime": "13:00",
      "leavingTime": "22:00",
      "break1StartTime": "17:00",
      "break1EndTime": "18:00",
      "break2StartTime": null,
      "break2EndTime": null
    }
  ]
}

Headers

Link

string

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

400

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

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "勤務パターン名は15文字以内の文字列を指定して下さい"
}