Schedulerequest

A time off request [Schedulerequest] is a change to an employee work schedule requested by the employee.

Review the Usage Guidelines for the Schedulerequest object.

XML

SOAP

REST

Database table

Object

Schedulerequest

oaSchedulerequest

schedule_request

Supported Commands

Add, Read, Modify, DeleteUnapprove

add(), read(), modify(), upsert(), delete()unapprove()

The Schedulerequest object has the following standard properties:

Note:

Schedulerequest object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP

Database

Description

approval_status

approval_status

A one-character string indicating the approval status of the schedule request. Possible values:

  • O - Open

  • P - Pending approval

  • A - Approved

  • R - Rejected

attachmentid

attachment_id

If non-zero, the attachment record associated with this schedule request.

categoryid

category_id

The ID of the associated category.

created

created

[Read-only] Time the record was created. See Date Fields.

customerid

customer_id

The ID of the associated customer.

date

date

The date of the schedule request creation. See Date Fields.

date_approved

date_approved

The date the schedule request was approved. See Date Fields.

date_submitted

date_submitted

The date the schedule request was submitted. See Date Fields.

description

description

The description or purpose for the schedule request.

enddate

enddate

The end date of the schedule request. See Date Fields.

externalid

external_id

If the record was imported from an external system, you store the unique external record ID here.

id

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

name

name

The name of the schedule request. Defaults to a concatenation of prefix and number unless set when adding a schedule request.

notes

notes

Notes to print on the schedule request.

number

number

The schedule request number that increments by 1. Assigned automatically unless set when adding a schedule request. Must be unique.

prefix

prefix

A static alphanumeric schedule request number prefix. Defaults to SR- unless set when adding a schedule request.

project_taskid

project_task_id

The ID of the associated project task.

projectid

project_id

The ID of the associated project.

startdate

startdate

The start date of the schedule request. See Date Fields.

timetype

The time type of this schedule request: R - regular time or P - personal time.

timetypeid

timetype_id

The ID of the associated time type.

updated

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

user_id

The ID of the user creating the schedule request. Defaults to the internal ID of the authenticated user if not set when adding a schedule request. If

Usage Guidelines

To add or modify a Schedulerequest object either the schedule request must be for the authenticated user or the authenticated user must be and account administrator.

You cannot delete a Schedulerequest object if this object is referenced by a Schedulerequest_item object. Delete any dependent objects first before you delete a Schedulerequest object.