Schedulebyday

A schedule by day [Schedulebyday] is an employee's work schedule on a specific date.

Review the Usage Guidelines for the Schedulebyday object.

—	XML	SOAP	REST	Database table
Object	Schedulebyday	oaSchedulebyday	—	schedule_by_day
Supported Commands	Read	read()	—	—

The Schedulebyday object has the following properties:

XML / SOAP	Database	Description
base_hours	base_hours	[Read-only] The number of base hours on this date for this user.
created	created	[Read-only] Time the record was created. See Date Fields.
date	date	[Read-only] The date. See Date Fields.
hours	hours	[Read-only] The number of schedule hours on this date for this user, including exceptions.
id	id	[Read-only] Unique ID. Automatically assigned by OpenAir.
target_base_hours	target_base_hours	[Read-only] The number of target base hours for this user on this date Target_utilization.percentage * base_hours.
target_hours	target_hours	[Read-only] The number of target hours for this user on this date. Target_utilization.percentage * hours.
updated	updated	[Read-only] Time the record was last updated or modified. See Date Fields.
user_id	user_id	[Read-only] The ID of the associated user.

Usage Guidelines

Review the following guidelines:

• You must use the following read attributes when reading Schedulebyday objects using the all read method: start_date, end_date and user_filter. See Read Attributes.

• When using the XML API, reading Schedulebyday objects using the all read method only returns exceptions to the base schedule. That is, the response includes only Schedulebyday objects for which hours is not equal to base_hours.

  For example, the following request, returns all schedule exceptions for the employees with internal ID 145 and 146, or the exceptions to the company work schedule associated with these employees, between October 1st and October 31st, 2023.

  <Read type="Schedulebyday" method="all" start_date="2023-10-01" end_date="2023-10-31" user_filter="145,146" limit="10"> ...</Read>

  To return all records instead of exceptions only use the equal to read method. See Read Methods.