休憩開始

PUT

/shifts/break_start_time/{shift_result_id}

• サンドボックス
• 本番

休憩開始を打刻します

対象

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

Authorizations

• AppAccessToken
  timecard.attendances.write
• UserAccessToken
  timecard.attendances.write

Parameters

Path Parameters

shift_result_id

required

string

シフト実績ID

Example

1

Request Body

object

breakDivision

required

休憩区分

• 1: 休憩1 開始
• 2: 休憩2 開始

string

Allowed values: 1 2

breakStartTime

required

休憩開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

latitude

休憩開始時緯度

number format: double

longitude

休憩開始時経度

number format: double

horizontalAccuracy

水平誤差精度（m）

number

verticalAccuracy

垂直誤差精度（m）

number

callbackUrl

コールバックURL（指定した場合、コールバックURLにレスポンスが返却されます）

string format: uri

Example

{
  "breakDivision": "1",
  "breakStartTime": "2020-05-01T12:00:00+09:00",
  "latitude": 34.684206,
  "longitude": 135.507926,
  "horizontalAccuracy": 20,
  "verticalAccuracy": 20,
  "callbackUrl": "https://example.com/callback"
}

Callbacks

stampSucceeded

POST

{$request.body#/callbackUrl}

Request Body

object

shiftResultId

シフト実績ID

string

storeId

事業所ID

string

staffId

従業員ID

string

shiftDate

勤務日 [YYYY-MM-DD]

string format: date

attendance

出勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

leaving

退勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime1

休憩1 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime1

休憩1 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime2

休憩2 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime2

休憩2 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

attendanceLatitude

出勤緯度

string

attendanceLongitude

出勤経度

string

leavingLatitude

退勤緯度

string

leavingLongitude

退勤経度

string

breakStart1Latitude

休憩1 開始緯度

string

breakStart1Longitude

休憩1 開始経度

string

breakEnd1Latitude

休憩1 終了緯度

string

breakEnd1Longitude

休憩1 終了経度

string

breakStart2Latitude

休憩2 開始緯度

string

breakStart2Longitude

休憩2 開始経度

string

breakEnd2Latitude

休憩2 終了緯度

string

breakEnd2Longitude

休憩2 終了経度

string

attendanceHorizontalAccuracy

出勤時水平精度（m）

string

attendanceVerticalAccuracy

出勤時垂直精度（m）

string

leavingHorizontalAccuracy

退勤時水平精度（m）

string

leavingVerticalAccuracy

退勤時垂直精度（m）

string

breakStart1HorizontalAccuracy

休憩1 開始水平精度（m）

string

breakStart1VerticalAccuracy

休憩1 開始垂直精度（m）

string

breakEnd1HorizontalAccuracy

休憩1 終了水平精度（m）

string

breakEnd1VerticalAccuracy

休憩1 終了垂直精度（m）

string

breakStart2HorizontalAccuracy

休憩2 開始水平精度（m）

string

breakStart2VerticalAccuracy

休憩2 開始垂直精度（m）

string

breakEnd2HorizontalAccuracy

休憩2 終了水平精度（m）

string

breakEnd2VerticalAccuracy

休憩2 終了垂直精度（m）

string

tardyFlag

遅刻の有無

• "": 遅刻なし
• 1: 遅刻あり

string

Allowed values: "" 1

tardyMinute

遅刻時間（丸め後）（分）

string

earlyLeaving

早退の有無

• "": 早退なし
• 1: 早退あり

string

Allowed values: "" 1

Example

{
  "shiftResultId": "1",
  "storeId": "1",
  "staffId": "1",
  "shiftDate": "2020-05-01",
  "attendance": "2020-05-01T10:00:00+09:00",
  "leaving": "",
  "breakStartTime1": "2020-05-01T12:00:00+09:00",
  "breakEndTime1": "2020-05-01T13:00:00+09:00",
  "breakStartTime2": "2020-05-01T15:00:00+09:00",
  "breakEndTime2": "",
  "attendanceLatitude": "34.684206",
  "attendanceLongitude": "135.507926",
  "leavingLatitude": "",
  "leavingLongitude": "",
  "breakStart1Latitude": "34.684206",
  "breakStart1Longitude": "135.507926",
  "breakEnd1Latitude": "34.684206",
  "breakEnd1Longitude": "135.507926",
  "breakStart2Latitude": "34.684206",
  "breakStart2Longitude": "135.507926",
  "breakEnd2Latitude": "",
  "breakEnd2Longitude": "",
  "attendanceHorizontalAccuracy": "20",
  "attendanceVerticalAccuracy": "20",
  "leavingHorizontalAccuracy": "",
  "leavingVerticalAccuracy": "",
  "breakStart1HorizontalAccuracy": "20",
  "breakStart1VerticalAccuracy": "20",
  "breakEnd1HorizontalAccuracy": "20",
  "breakEnd1VerticalAccuracy": "20",
  "breakStart2HorizontalAccuracy": "20",
  "breakStart2VerticalAccuracy": "20",
  "breakEnd2HorizontalAccuracy": "",
  "breakEnd2VerticalAccuracy": "",
  "tardyFlag": "",
  "tardyMinute": "0",
  "earlyLeaving": ""
}

Responses

200

コールバックの受信に成功した場合

Responses

200

打刻成功（コールバックURLを指定しなかった場合）

object

shiftResultId

シフト実績ID

string

storeId

事業所ID

string

staffId

従業員ID

string

shiftDate

勤務日 [YYYY-MM-DD]

string format: date

attendance

出勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

leaving

退勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime1

休憩1 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime1

休憩1 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime2

休憩2 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime2

休憩2 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

attendanceLatitude

出勤緯度

string

attendanceLongitude

出勤経度

string

leavingLatitude

退勤緯度

string

leavingLongitude

退勤経度

string

breakStart1Latitude

休憩1 開始緯度

string

breakStart1Longitude

休憩1 開始経度

string

breakEnd1Latitude

休憩1 終了緯度

string

breakEnd1Longitude

休憩1 終了経度

string

breakStart2Latitude

休憩2 開始緯度

string

breakStart2Longitude

休憩2 開始経度

string

breakEnd2Latitude

休憩2 終了緯度

string

breakEnd2Longitude

休憩2 終了経度

string

attendanceHorizontalAccuracy

出勤時水平精度（m）

string

attendanceVerticalAccuracy

出勤時垂直精度（m）

string

leavingHorizontalAccuracy

退勤時水平精度（m）

string

leavingVerticalAccuracy

退勤時垂直精度（m）

string

breakStart1HorizontalAccuracy

休憩1 開始水平精度（m）

string

breakStart1VerticalAccuracy

休憩1 開始垂直精度（m）

string

breakEnd1HorizontalAccuracy

休憩1 終了水平精度（m）

string

breakEnd1VerticalAccuracy

休憩1 終了垂直精度（m）

string

breakStart2HorizontalAccuracy

休憩2 開始水平精度（m）

string

breakStart2VerticalAccuracy

休憩2 開始垂直精度（m）

string

breakEnd2HorizontalAccuracy

休憩2 終了水平精度（m）

string

breakEnd2VerticalAccuracy

休憩2 終了垂直精度（m）

string

tardyFlag

遅刻の有無

• "": 遅刻なし
• 1: 遅刻あり

string

Allowed values: "" 1

tardyMinute

遅刻時間（丸め後）（分）

string

earlyLeaving

早退の有無

• "": 早退なし
• 1: 早退あり

string

Allowed values: "" 1

Example

{
  "shiftResultId": "1",
  "storeId": "1",
  "staffId": "1",
  "shiftDate": "2020-05-01",
  "attendance": "2020-05-01T10:00:00+09:00",
  "leaving": "",
  "breakStartTime1": "2020-05-01T12:00:00+09:00",
  "breakEndTime1": "2020-05-01T13:00:00+09:00",
  "breakStartTime2": "2020-05-01T15:00:00+09:00",
  "breakEndTime2": "",
  "attendanceLatitude": "34.684206",
  "attendanceLongitude": "135.507926",
  "leavingLatitude": "",
  "leavingLongitude": "",
  "breakStart1Latitude": "34.684206",
  "breakStart1Longitude": "135.507926",
  "breakEnd1Latitude": "34.684206",
  "breakEnd1Longitude": "135.507926",
  "breakStart2Latitude": "34.684206",
  "breakStart2Longitude": "135.507926",
  "breakEnd2Latitude": "",
  "breakEnd2Longitude": "",
  "attendanceHorizontalAccuracy": "20",
  "attendanceVerticalAccuracy": "20",
  "leavingHorizontalAccuracy": "",
  "leavingVerticalAccuracy": "",
  "breakStart1HorizontalAccuracy": "20",
  "breakStart1VerticalAccuracy": "20",
  "breakEnd1HorizontalAccuracy": "20",
  "breakEnd1VerticalAccuracy": "20",
  "breakStart2HorizontalAccuracy": "20",
  "breakStart2VerticalAccuracy": "20",
  "breakEnd2HorizontalAccuracy": "",
  "breakEnd2VerticalAccuracy": "",
  "tardyFlag": "",
  "tardyMinute": "0",
  "earlyLeaving": ""
}

201

成功（コールバックURLを指定した場合）

object

message

メッセージ

string

Example

{
  "message": "実行中です"
}

400

• 既に休憩中になっている場合
• 退勤済み、出勤していない場合
• 事業所が非表示になっている場合
• シフト実績登録に失敗した場合
• ジオフェンシング打刻のエリア外である場合
• シフト実績IDが存在しない場合

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "退勤済み、あるいは出勤してない従業員です。"
}