Retrieve Requestable Open Shifts, Request Subtypes, or Submission Periods (Deprecated)

post deprecatedhttps://{hostname}/api/v1/scheduling/employee_self_schedule_requests/apply_read

This operation is deprecated; instead use GET /v1/scheduling/employee_self_schedule_requests/request_subtypes, GET /v1/scheduling/employee_self_schedule_requests/submission_periods and POST /v1/scheduling/employee_self_schedule_requests/open_shifts/multi_read.

This operation retrieves either the requestable open shifts, request subtypes, or submission periods available for an employee self-schedule request.

Responses

Response body

object

requestableOpenShifts

array of objects

A collection of requestable open shifts.

requestableOpenShifts

object

employee

object

Model describing the details of an employee.

shift

object

availableRequestSubTypes

array of objects

A collection of available request subtypes.

availableRequestSubTypes

object

description

string

parameters

array of objects

parameters

object

localizedValue

string

symbolicId

string

parameterId

int64

value

string

localizedDescription

string

requestType

string

REQUEST_TYPE_TIME_OFF REQUEST_TYPE_LEAVE REQUEST_TYPE_SWAP REQUEST_TYPE_SELF_SCHEDULE REQUEST_TYPE_OPEN_SHIFT REQUEST_TYPE_TIMECARD_CHANGE REQUEST_TYPE_AVAILABILITY_REQUEST REQUEST_TYPE_AVAILABILITY_PATTERN_REQUEST REQUEST_TYPE_COVER REQUEST_TYPE_EMPLOYEE_PREFERENCES

localizedName

string

int64

name

string

requestSubmissionPeriods

array of objects

requestSubmissionPeriods

object

recurrenceFrequency

int32

The number of time units for the recurrence type of an employee visibility period.

triggerSettings

object

The object reference model which contains an ID and qualifier.

openingAndClosingByEmployeesPriorityEnabled

boolean

submissionPeriod

object

recurrenceEndDate

date

The inclusive end date by which to terminate the recurrence of an employee visibility period in ISO_LOCAL_DATE format (YYYY-MM-DD).

hyperFindQuery

object

The object reference model which contains an ID and qualifier.

int64

The unique ID of an employee visibility period.

periodOfSimpleType

boolean

effectivePeriods

object

Model representing a list of effective periods.

employeesHyperFindPeriods

array of objects

The list of employees and their Hyperfind periods by priority of an employee visibility period.

employeesHyperFindPeriods

object

employee

object

The object reference model which contains an ID and qualifier.

positions

array of objects

positions

object

int64

The unique ID of an object.

qualifier

string

The qualifier of an object.

localizedQualifier

string

The localized qualifier of an object reference. The value of this property is imported from the Setup Data component by means of an XLS file.

period

object

description

string

The description of an employee visibility period.

showUnpostedSchedule

boolean

A Boolean indicator of whether or not to reveal the unposted schedule to employees during an employee visibility period.

createdByName

string

The name of the user who created an employee visibility period.

requestSubType

object

The object reference model which contains an ID and qualifier.

suppressNotification

boolean

A Boolean indicator of whether or not to suppress notifications associated with an employee visibility period.

createdBy

object

The object reference model which contains an ID and qualifier.

multiHyperFindSettings

object

Model representing multi-group HyperFind settings.

showOpenShifts

boolean

A Boolean indicator of whether or not to reveal open shifts to employees during an employee visibility period.

name

string

The name of an employee visibility period.

requestPeriod

object

A local date span object that defines the span of shifts retrieved. This object contains start and end dates in ISO_LOCAL_DATE format (YYYY-MM-DD).

employeePrioritySetupId

object

The object reference model which contains an ID and qualifier.

recurrenceType

string

The recurrence type of an employee visibility period.

0 1 2 3 4

timeZone

object

The object reference model which contains an ID and qualifier.

400

Retrieval of requestable open shifts, request subtypes or submissino periods was unsuccessful.

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/api/v1/scheduling/employee_self_schedule_requests/apply_read \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Successfully retrieved requestable open shifts, request subtypes, or submission periods.