出勤打刻

POST

/shifts/attendance/{store_id}/{staff_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts/attendance/1/1';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"attendance":"2020-05-01T14:15:22+09:00","latitude":34.6833793,"longitude":135.4976512,"horizontalAccuracy":20,"verticalAccuracy":20,"callbackUrl":"https://example.com/callback"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts/attendance/1/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "attendance": "2020-05-01T14:15:22+09:00", "latitude": 34.6833793, "longitude": 135.4976512, "horizontalAccuracy": 20, "verticalAccuracy": 20, "callbackUrl": "https://example.com/callback" }'

出勤します

対象

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

Authorizations

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

Parameters

Path Parameters

store_id

required

string

事業所ID

Example

staff_id

required

string

従業員ID

Example

Request Body

application/json

object

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

{
  "attendance": "2020-05-01T14:15:22+09:00",
  "latitude": 34.6833793,
  "longitude": 135.4976512,
  "horizontalAccuracy": 20,
  "verticalAccuracy": 20,
  "callbackUrl": "https://example.com/callback"
}

Callbacks

`stampSucceeded`

POST

{$request.body#/callbackUrl}

Request Body

application/x-www-form-urlencoded

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

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

latitude

出勤緯度

string

longitude

出勤経度

string

horizontalAccuracy

出勤時水平精度（m）

string

verticalAccuracy

出勤時垂直精度（m）

string

tardyFlag

遅刻の有無

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

string

Allowed values: "" 1

tardyMinute

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

string

Example

shiftResultId=1&storeId=1&staffId=1&shiftDate=2020-05-01&attendance=2020-05-01T09%3A00%3A00%2B09%3A00&breakStartTime1=&breakEndTime1=&breakStartTime2=&breakEndTime2=&latitude=34.684206&longitude=135.507926&horizontalAccuracy=20&verticalAccuracy=20&tardyFlag=1&tardyMinute=20

Responses

200

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

Responses

200

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

application/json

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

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

latitude

出勤緯度

string

longitude

出勤経度

string

horizontalAccuracy

出勤時水平精度（m）

string

verticalAccuracy

出勤時垂直精度（m）

string

tardyFlag

遅刻の有無

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

string

Allowed values: "" 1

tardyMinute

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

string

Example

{
  "shiftResultId": "1",
  "storeId": "1",
  "staffId": "1",
  "shiftDate": "2020-05-01",
  "attendance": "2020-05-01T09:00:00+09:00",
  "breakStartTime1": "",
  "breakEndTime1": "",
  "breakStartTime2": "",
  "breakEndTime2": "",
  "latitude": "34.684206",
  "longitude": "135.507926",
  "horizontalAccuracy": "20",
  "verticalAccuracy": "20",
  "tardyFlag": "1",
  "tardyMinute": "20"
}

201

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

application/json

object

message

メッセージ

string

Example

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

400

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

application/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[スマレジ太郎]:既に出勤しています。"
}

404

データが存在しない場合

application/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "データが確認できませんでした。"
}

409

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

application/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

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