Response_Filter

Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.

Parameter name

Type/Value

Cardinality

Description

Validations

As_Of_Effective_Date

date

[0..1]

Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.

As_Of_Entry_DateTime

dateTime

[0..1]

Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.

Page

decimal (12, 0) >0

[0..1]

Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data.
Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.

Count

decimal (3, 0) >0

[0..1]

Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.

Response_Results

The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.

Parameter name

Type/Value

Cardinality

Description

Validations

Total_Results

decimal (12, 0) >0

[0..1]

The total number of results that have been returned from your request.

Total_Pages

decimal (12, 0) >0

[0..1]

The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset.
Each page contains a maximum of 100 entries.