レコル
レコルWebAPIについて説明します。
APIエンドポイントやアクセストークンによる認証についてはレコルWebApi概要をご確認ください。
勤務表
GET /ws/s4/v1/attendance/{loginId}/workdays  勤務データ取得

目的

指定した年月日、利用者の勤務データを取得します。

パラメータ

フィールド 必須 説明
worktime-date 年月日(yyyymmdd形式)を指定します
format 時刻の表示形式を指定します("1": 時分(hh:mm)、"2": 10進数、"3":60進数、"4":分単位)
 ※未指定の場合は時分(hh:mm)

レスポンス

コード 説明
200
勤務データ取得APIのレスポンスはシステム管理者権限の表示項目設定で有効な項目を返します。
{
      "login_id": "000001",
      "user_name": "レコル 太郎",
      "attendance_datas": [
          {
              "worktime_date": "20250522",
              "worktime_no": 1,
              "day_type": "01",
              "attend_kbn_code_1": "01",
              "attend_kbn_name_1": "出勤",
              "worktime_start": "10:00",
              "worktime_end": "20:30",
              "worktime_total": "09:30",
              "breaktime_total": "02:00",
              "breaktime_datas": [
                  {
                      "breaktime_start": "12:00",
                      "breaktime_end": "13:00"
                  },
                  {
                      "breaktime_start": "15:00",
                      "breaktime_end": "16:00"
                  }
              ],
              "yukyutime": "00:00",
              "leavetime": "01:00",
              "leavetime_datas": [
                  {
                      "leave_config_code": "01",
                      "leave_config_name": "子の看護等休暇",
                      "leavetime": "01:00"
                  }
              ],
              "worktime_outside": "01:30",
              "worktime_night": "00:00",
              "worktime_legal_holiday": "00:00",
              "worktime_legal_holiday_night": "00:00",
              "worktime_memo": "",
              "worktime_setting_code": "001",
              "worktime_setting_name": "基本設定",
              "work_place_code": "",
              "work_place_name": "",
              "summary_item_datas": [
                  {
                      "summary_item_code": "001",
                      "summary_item_name": "平日時間",
                      "summary_item_time": "09:30"
                  },
                  {
                      "summary_item_code": "002",
                      "summary_item_name": "休日時間",
                      "summary_item_time": "00:00"
                  }
              ],
              "custom_item_datas": [
                  {
                      "custom_item_name": "自己学習",
                      "custom_item_type": "time",
                      "custom_item_value": "01:00"
                  },
                  {
                      "custom_item_name": "備考",
                      "custom_item_type": "text",
                      "custom_item_value": ""
                  }
              ],
              "approved_1": false
          }
      ]
  }

エラーレスポンス

status type 説明
422 unprocessable_entity ・表示対象の日付が参照範囲外
・表示対象のログインIDの利用者が在籍していない、または未登録
GET /ws/s4/v1/attendance/workdays  勤務データ取得(複数人)

目的

指定した年月日の複数の利用者の勤務データを取得します。

パラメータ

フィールド 必須 説明
worktime-date 年月日(yyyymmdd形式)を指定します
format 時刻の表示形式を指定します("1": 時分(hh:mm)、"2": 10進数、"3":60進数、"4":分単位)
 ※未指定の場合は時分(hh:mm)
page ページ数を指定します
※未指定の場合は1
limit 表示件数を1~100以内で指定します
※未指定の場合は10

レスポンス

コード 説明
200
勤務データ取得APIのレスポンスはシステム管理者権限の表示項目設定で有効な項目を返します。
レスポンス内の利用者の表示順はログインIDの昇順となります。
{
      "attendances": [
          {
              "login_id": "000001",
              "user_name": "レコル 太郎",
              "attendance_datas": [
                  {
                      "worktime_date": "20250522",
                      "worktime_no": 1,
                      "day_type": "01",
                      "attend_kbn_code_1": "01",
                      "attend_kbn_name_1": "出勤",
                      "worktime_start": "10:00",
                      "worktime_end": "20:30",
                      "worktime_total": "09:30",
                      "breaktime_total": "02:00",
                      "breaktime_datas": [
                          {
                              "breaktime_start": "12:00",
                              "breaktime_end": "13:00"
                          },
                          {
                              "breaktime_start": "15:00",
                              "breaktime_end": "16:00"
                          }
                      ],
                      "yukyutime": "00:00",
                      "leavetime": "01:00",
                      "leavetime_datas": [
                          {
                              "leave_config_code": "01",
                              "leave_config_name": "子の看護等休暇",
                              "leavetime": "01:00"
                          }
                      ],
                      "worktime_outside": "01:30",
                      "worktime_night": "00:00",
                      "worktime_legal_holiday": "00:00",
                      "worktime_legal_holiday_night": "00:00",
                      "worktime_memo": "",
                      "worktime_setting_code": "001",
                      "worktime_setting_name": "基本設定",
                      "work_place_code": "",
                      "work_place_name": "",
                      "summary_item_datas": [
                          {
                              "summary_item_code": "001",
                              "summary_item_name": "平日時間",
                              "summary_item_time": "09:30"
                          },
                          {
                              "summary_item_code": "002",
                              "summary_item_name": "休日時間",
                              "summary_item_time": "00:00"
                          }
                      ],
                      "custom_item_datas": [
                          {
                              "custom_item_name": "自己学習",
                              "custom_item_type": "time",
                              "custom_item_value": "01:00"
                          },
                          {
                              "custom_item_name": "備考",
                              "custom_item_type": "text",
                              "custom_item_value": ""
                          }
                      ],
                      "approved_1": false
                  }
              ]
          },{
              "login_id": "000002",
              "user_name": "レコル 次郎",
              "attendance_datas": [
                  {
                      "worktime_date": "20250522",
                      "worktime_no": 1,
                      "day_type": "01",
                      "attend_kbn_code_1": "01",
                      "attend_kbn_name_1": "出勤",
                      "worktime_start": "10:00",
                      "worktime_end": "18:00",
                      "worktime_total": "08:00",
                      "breaktime_total": "01:00",
                      "breaktime_datas": [
                          {
                              "breaktime_start": "12:00",
                              "breaktime_end": "13:00"
                          }
                      ],
                      "yukyutime": "00:00",
                      "leavetime": "00:00",
                      "leavetime_datas": [],
                      "worktime_outside": "00:00",
                      "worktime_night": "00:00",
                      "worktime_legal_holiday": "00:00",
                      "worktime_legal_holiday_night": "00:00",
                      "worktime_memo": "",
                      "worktime_setting_code": "001",
                      "worktime_setting_name": "基本設定",
                      "work_place_code": "",
                      "work_place_name": "",
                      "summary_item_datas": [
                          {
                              "summary_item_code": "001",
                              "summary_item_name": "平日時間",
                              "summary_item_time": "08:00"
                          },
                          {
                              "summary_item_code": "002",
                              "summary_item_name": "休日時間",
                              "summary_item_time": "00:00"
                          }
                      ],
                      "custom_item_datas": [
                          {
                              "custom_item_name": "自己学習",
                              "custom_item_type": "time",
                              "custom_item_value": "00:00"
                          },
                          {
                              "custom_item_name": "備考",
                              "custom_item_type": "text",
                              "custom_item_value": ""
                          }
                      ],
                      "approved_1": false
                  }
              ]
          }
      ]
  }

エラーレスポンス

コード type 説明
422 unprocessable_entity ・表示件数が1~100の範囲外
・表示対象の日付が参照範囲外
・表示対象の利用者が存在しない
打刻
POST /ws/s4/v1/attendance/{loginId}/punch  打刻

目的

指定したログインIDの利用者で打刻を実行します。
打刻方法は"WebAPI"として記録されます。

パラメータ

フィールド 必須 説明
punch-button-code 打刻ボタンコードを指定します
打刻ボタンコードは打刻ボタン設定画面から確認できます
punch-memo 打刻メモを指定します
work-place-code 作業場所コードをします
作業場所コードは作業場所設定画面から確認できます
punch-term-id 端末IDを指定します(任意の文字列を指定できます)
※使用可能な文字種は半角英数字と記号(-_.)
punch-term-name 端末名称を指定します(任意の文字列を指定できます)
latitude 緯度を指定します
longitude 経度を指定します
punch-location-address 打刻位置の住所を指定します

レスポンス

コード 説明
200
{
    "login_id": "000001",
    "user_name": "レコル 太郎",
    "punch_datetime": "2025-05-26 14:28:34.841",
    "punch_method_name": "WebAPI",
    "punch_button_code": "02",
    "punch_button_name": "退勤"
}

エラーレスポンス

コード type 説明
422 unprocessable_entity ・指定したログインIDの利用者が在籍していない、または未登録
・指定した打刻ボタンコードが存在しない
・指定した作業場所コードが存在しない
・有休/休暇残り日数が不足(打刻ボタン設定で勤務区分が指定されている場合に発生する可能性があります)
・対象の利用者が打刻ボタン設定の共有範囲外(打刻ボタン設定で共有範囲が指定されている場合に発生する可能性があります)
© 2017 Chuo System Corporation