コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

応援打刻

PUT
/shifts/cheering/{store_id}/{staff_id}
curl --request PUT \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts/cheering/1/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "leavingShiftResultId": "1", "leavingLatitude": 34.684206, "leavingLongitude": 135.507926, "leavingHorizontalAccuracy": 20, "leavingVerticalAccuracy": 20, "attendance": "2020-05-01T18:00:00+09:00", "latitude": 34.684206, "longitude": 135.507926, "horizontalAccuracy": 20, "verticalAccuracy": 20, "callbackUrl": "https://example.com/callback" }'

応援出勤します

対象

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
store_id
required
string

事業所ID

Example
1
staff_id
required
string

従業員ID

Example
1

Request Body

Section titled “Request Body”
Media typeapplication/json
object
leavingShiftResultId
required

退勤シフト実績ID

string
leavingLatitude

退勤時緯度

number format: double
leavingLongitude

退勤時経度

number format: double
leavingHorizontalAccuracy

退勤時水平誤差精度（m）

number
leavingVerticalAccuracy

退勤時垂直誤差精度（m）

number
attendance
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
{
  "leavingShiftResultId": "1",
  "leavingLatitude": 34.684206,
  "leavingLongitude": 135.507926,
  "leavingHorizontalAccuracy": 20,
  "leavingVerticalAccuracy": 20,
  "attendance": "2020-05-01T18:00:00+09:00",
  "latitude": 34.684206,
  "longitude": 135.507926,
  "horizontalAccuracy": 20,
  "verticalAccuracy": 20,
  "callbackUrl": "https://example.com/callback"
}

Callbacks

Section titled “Callbacks”

stampSucceeded

Section titled “stampSucceeded”
POST
{$request.body#/callbackUrl}

Request Body

Section titled “Request Body”
Media typeapplication/x-www-form-urlencoded
object
leavingShiftResult

退勤実績データ

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
attendanceHorizontalAccuracy

出勤時水平精度（m）

string
attendanceVerticalAccuracy

出勤時垂直精度（m）

string
leavingHorizontalAccuracy

退勤時水平精度（m）

string
leavingVerticalAccuracy

退勤時垂直精度（m）

string
attendanceAddress

出勤住所

string
leavingAddress

退勤住所

string
tardyFlag

遅刻の有無

  • "": 遅刻なし
  • 1: 遅刻あり
string
Allowed values: "" 1
tardyMinute

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

string
earlyLeaving

早退の有無

  • "": 早退なし
  • 1: 早退あり
string
Allowed values: "" 1
attendanceShiftResult

出勤実績データ

object
shiftResultId

シフト実績ID

string
storeId

事業所ID

string
staffId

従業員ID

string
shiftDate

勤務日

string
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
attendanceHorizontalAccuracy

出勤時水平精度（m）

string
attendanceVerticalAccuracy

出勤時垂直精度（m）

string
leavingHorizontalAccuracy

退勤時水平精度（m）

string
leavingVerticalAccuracy

退勤時垂直精度（m）

string
attendanceAddress

出勤住所

string
leavingAddress

出勤住所

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%3A00%3A00%2B09%3A00&leaving=2020-05-01T18%3A00%3A00%2B09%3A00&breakStartTime1=2020-05-01T12%3A00%3A00%2B09%3A00&breakEndTime1=2020-05-01T13%3A00%3A00%2B09%3A00&breakStartTime2=2020-05-01T14%3A00%3A00%2B09%3A00&breakEndTime2=2020-05-01T15%3A00%3A00%2B09%3A00&attendanceLatitude=34.684206&attendanceLongitude=135.507926&leavingLatitude=34.684206&leavingLongitude=135.507926&attendanceHorizontalAccuracy=20&attendanceVerticalAccuracy=20&leavingHorizontalAccuracy=20&leavingVerticalAccuracy=20&attendanceAddress=%E5%A4%A7%E9%98%AA%E5%BA%9C%E5%A4%A7%E9%98%AA%E5%B8%82%E4%B8%AD%E5%A4%AE%E5%8C%BA%E6%9C%AC%E7%94%BA&leavingAddress=%E5%A4%A7%E9%98%AA%E5%BA%9C%E5%A4%A7%E9%98%AA%E5%B8%82%E4%B8%AD%E5%A4%AE%E5%8C%BA%E6%9C%AC%E7%94%BA&tardyFlag=&tardyMinute=0&earlyLeaving=&shiftResultId=2&storeId=2&staffId=1&shiftDate=2020-05-01&attendance=2020-05-01T18%3A00%3A00%2B09%3A00&leaving=&breakStartTime1=&breakEndTime1=&breakStartTime2=&breakEndTime2=&attendanceLatitude=34.684206&attendanceLongitude=135.507926&leavingLatitude=&leavingLongitude=&attendanceHorizontalAccuracy=20&attendanceVerticalAccuracy=20&leavingHorizontalAccuracy=&leavingVerticalAccuracy=&attendanceAddress=%E5%A4%A7%E9%98%AA%E5%BA%9C%E5%A4%A7%E9%98%AA%E5%B8%82%E4%B8%AD%E5%A4%AE%E5%8C%BA%E6%9C%AC%E7%94%BA&leavingAddress=&tardyFlag=&tardyMinute=0&earlyLeaving=

Responses

Section titled “Responses”
200
Section titled “200”

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

Responses

Section titled “Responses”

200

Section titled “200”

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

Media typeapplication/json
object
leavingShiftResult

退勤実績データ

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
attendanceHorizontalAccuracy

出勤時水平精度（m）

string
attendanceVerticalAccuracy

出勤時垂直精度（m）

string
leavingHorizontalAccuracy

退勤時水平精度（m）

string
leavingVerticalAccuracy

退勤時垂直精度（m）

string
attendanceAddress

出勤住所

string
leavingAddress

退勤住所

string
tardyFlag

遅刻の有無

  • "": 遅刻なし
  • 1: 遅刻あり
string
Allowed values: "" 1
tardyMinute

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

string
earlyLeaving

早退の有無

  • "": 早退なし
  • 1: 早退あり
string
Allowed values: "" 1
attendanceShiftResult

出勤実績データ

object
shiftResultId

シフト実績ID

string
storeId

事業所ID

string
staffId

従業員ID

string
shiftDate

勤務日

string
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
attendanceHorizontalAccuracy

出勤時水平精度（m）

string
attendanceVerticalAccuracy

出勤時垂直精度（m）

string
leavingHorizontalAccuracy

退勤時水平精度（m）

string
leavingVerticalAccuracy

退勤時垂直精度（m）

string
attendanceAddress

出勤住所

string
leavingAddress

出勤住所

string
tardyFlag

遅刻の有無

  • "": 遅刻なし
  • 1: 遅刻あり
string
Allowed values: "" 1
tardyMinute

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

string
earlyLeaving

早退の有無

  • "": 早退なし
  • 1: 早退あり
string
Allowed values: "" 1
Example
{
  "leavingShiftResult": {
    "shiftResultId": "1",
    "storeId": "1",
    "staffId": "1",
    "shiftDate": "2020-05-01",
    "attendance": "2020-05-01T10:00:00+09:00",
    "leaving": "2020-05-01T18:00:00+09:00",
    "breakStartTime1": "2020-05-01T12:00:00+09:00",
    "breakEndTime1": "2020-05-01T13:00:00+09:00",
    "breakStartTime2": "2020-05-01T14:00:00+09:00",
    "breakEndTime2": "2020-05-01T15:00:00+09:00",
    "attendanceLatitude": "34.684206",
    "attendanceLongitude": "135.507926",
    "leavingLatitude": "34.684206",
    "leavingLongitude": "135.507926",
    "attendanceHorizontalAccuracy": "20",
    "attendanceVerticalAccuracy": "20",
    "leavingHorizontalAccuracy": "20",
    "leavingVerticalAccuracy": "20",
    "attendanceAddress": "大阪府大阪市中央区本町",
    "leavingAddress": "大阪府大阪市中央区本町",
    "tardyFlag": "",
    "tardyMinute": "0",
    "earlyLeaving": ""
  },
  "attendanceShiftResult": {
    "shiftResultId": "2",
    "storeId": "2",
    "staffId": "1",
    "shiftDate": "2020-05-01",
    "attendance": "2020-05-01T18:00:00+09:00",
    "leaving": "",
    "breakStartTime1": "",
    "breakEndTime1": "",
    "breakStartTime2": "",
    "breakEndTime2": "",
    "attendanceLatitude": "34.684206",
    "attendanceLongitude": "135.507926",
    "leavingLatitude": "",
    "leavingLongitude": "",
    "attendanceHorizontalAccuracy": "20",
    "attendanceVerticalAccuracy": "20",
    "leavingHorizontalAccuracy": "",
    "leavingVerticalAccuracy": "",
    "attendanceAddress": "大阪府大阪市中央区本町",
    "leavingAddress": "",
    "tardyFlag": "",
    "tardyMinute": "0",
    "earlyLeaving": ""
  }
}

201

Section titled “201”

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

Media typeapplication/json
object
message

メッセージ

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

400

Section titled “400”
  • 出勤中の事業所に応援しようとした場合
  • 事業所が非表示になっている場合
  • シフト実績登録に失敗した場合
  • 退勤事業所で退勤済み、出勤していない場合
  • ジオフェンシング打刻のエリア外である場合
  • 事業所IDが存在しない場合
  • 従業員IDが存在しない場合
Media typeapplication/json
object
type

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

string
title

エラーの概要

string
detail

エラーの詳細

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

409

Section titled “409”

勤怠が締められているため、応援打刻できない場合

Media typeapplication/json
object
type

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

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "勤怠が締められているため、応援打刻できません。"
}