Schedules

Queryable, Introduced in version 22.2

GET https://localhost:8001/sv/001.1/api/v1/TimeRecording/Schedules

Represents a schedule used for time recording.

GUID

7A50172F-FE1F-40F7-9BDA-6C8566C34991

Required permission

Show basic data for attendance

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the schedule.
Code String The human readable identifier of the schedule.
Description String The translated description of the schedule.
ScheduleLength Int64 The length of the schedule.
 Introduced in version 23.1
Start Int64 Information about the start of the schedule.
 Introduced in version 23.1
End Int64 Information about the end of the schedule.
 Introduced in version 23.1
OvertimeScheduleId Int64? The business key identifier of the Overtime schedule.

 Introduced in version 23.1
FlexInStart Int64? The flex in start of the schedule.
 Introduced in version 23.1
FlexInEnd Int64? The flex in end of the schedule.
 Introduced in version 23.1
FlexOutStart Int64? The flex out start of the schedule.
 Introduced in version 23.1
FlexOutEnd Int64? The flex out end of the schedule.
 Introduced in version 23.1
IsNightSchedule Boolean The boolean value for the night schedule.
 Introduced in version 23.1
Type Int32 A type of schedule.

  • NotInitialized: 0
  • Ordinary: 1
  • Overtime: 2

  • Bitmask
 Introduced in version 23.1
AmountSwh Decimal? The amount of shorter work hours (SWH)
 Introduced in version 24.4
ScheduleNumberForExport String The schedule number for export
 Introduced in version 24.4
BlockedContextType Int32 The context type of block

  • None: 0
  • RegisterScheduleCycle: 1
  • CreateRecording: 2

  • Bitmask
 Introduced in version 24.4
BlockedById Int64? The business key identifier of the application user that blocked the entity.
 Introduced in version 24.4
BlockedFromDate DateTimeOffset? The date when the entity starts being blocked.
 Introduced in version 24.4
BlockedToDate DateTimeOffset? The date when the entity stops being blocked.
 Introduced in version 24.4
BlockedStatus Int32 The block status of the entity.

  • None: 0
  • Message: 1
  • Blocked: 2
 Introduced in version 24.4
BlockMessageId Int64? The business key identifier of the entity block message comment.

References Comments.
 Introduced in version 24.4
BlockMessage Comments The entity block message comment

 Introduced in version 24.4

Example

{
  "Id": 0,
  "Code": null,
  "Description": null,
  "ScheduleLength": 0,
  "Start": 0,
  "End": 0,
  "OvertimeScheduleId": null,
  "FlexInStart": null,
  "FlexInEnd": null,
  "FlexOutStart": null,
  "FlexOutEnd": null,
  "IsNightSchedule": false,
  "Type": 0,
  "AmountSwh": null,
  "ScheduleNumberForExport": null,
  "BlockedContextType": 0,
  "BlockedById": null,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "BlockedStatus": 0,
  "BlockMessageId": null,
  "BlockMessage": null
}