---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Workday API]
nav: wcp_docs
parent_url: /wcp_docs/
title: >- 
  Concept: Workday Web Services Response Filter Element
layout: subsection
---

Many Workday Web Services get request operations contain a <i>Response_Filter</i> element. Workday recommends that you use this element in any web service where it's available.

This element filters request results, and also affects:

-   Paging consistency.
-   Paging optimization
-   Performance.


The request element often contains:

<table><thead><tr><th>Element Name</th><th>Description</th></tr></thead><tbody><tr><td><i>Request_References</i></td><td>References for the specific entries to retrieve.</td></tr><tr><td><i>Request_Criteria</i></td><td>Categories of entries to retrieve.</td></tr><tr><td><i>Response_Filter</i></td><td>Filters and pages the returned results. Each element is optional.</td></tr><tr><td><i>Response_Date_Range_Filter</i></td><td>Filters by date range. The date range is used in combination with the dates set in <i>Response_Filter</i>.</td></tr><tr><td><i>Response_Group</i></td><td>Fields for each entry to return.</td></tr></tbody></table><br/>

Example: <i>Response_Filter</i> element where each element is optional

```
<bsvc:Response_Filter>
  <bsvc:As_Of_Effective_Date>2013-07-16</bsvc:As_Of_Effective_Date>
  <bsvc:As_Of_Entry_DateTime>2013-07-16T22:04:00Z</bsvc:As_Of_Entry_DateTime>
  <bsvc:Page>5</bsvc:Page>
  <bsvc:Count>50</bsvc:Count>
</bsvc:Response_Filter>
```

## <a id="section_N10027_N1000F_N10001"></a>As_Of Filter Elements

The <i>Response_Filter</i> element uses these <i>As_Of</i> elements:

<table><thead><tr><th>Element Name</th><th>Element Description</th></tr></thead><tbody><tr><td><i>As_Of_Effective_Date</i></td><td>Effective date for the changed data. <p>Examples:</p><ul><li>Business title change
</li><li>Change in compensation
</li><li>New worker employment date
</li><li>Promotion
</li><li>New benefits election
</li></ul></td></tr><tr><td><i>As_Of_Entry_DateTime</i></td><td>Set the date and time that you enter data into Workday. This value ensures consistent paging results and performance even for web services that don't support historic dates and times. Otherwise, the web service automatically populates this field with the current date and time.</td></tr></tbody></table><br/>

The <i>Response_Filter</i> element only returns elements up to and including the specified filter date or date and time. Workday doesn't return elements that have an effective date or an entry date and time after what filter specifies.

Some web services contain this message in the web service documentation: <i>The operation doesn't support criteria-based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request</i>. For these web service operations, even though they don't support request criteria for times in the past, Workday recommends that you still use the <i>As_Of_Entry_DateTime</i> element for optimized paging and consistent results.

## <a id="section_N10055_N1000F_N10001"></a>Paging

When you make a web service request that returns a large amount of data, Workday pages search results. The response only returns a subset of data.

These elements control paging:

<table><thead><tr><th>Element Name</th><th>Description</th></tr></thead><tbody><tr><td><i>Page</i></td><td>Page of data to return. Paging starts at 1 and the default is 1.</td></tr><tr><td><i>Count</i></td><td>Workday automatically returns 100 data elements per page. The maximum is 999.</td></tr></tbody></table><br/>

## <a id="section_N1006E_N1000F_N10001"></a>Paging Consistency

Always specify the same value of the <i>As_Of_Entry_DateTime</i> element as you page through the entries. Specifying the same value for this element will avoid inconsistent paging results. Inconsistent results include missing some entries and retrieving some entries multiple times. If you don’t specify a value for <i>As_Of_Entry_DateTime</i>, Workday uses the current time. Therefore, each page uses a different value and doesn’t enforce paging consistency.

Paged SOAP calls require both an <i>As_Of_Entry_DateTime</i> and <i>As_Of_Effective_Date</i>. If you do not include an <i>As_Of_Effective_Date</i>, then each page of the web service request will default to the current date for your timezone when you make the API request. Example: If your Integration System User is in the Pacific Timezone and needs to request data for a use case in a different timezone, such as Japan, then you need to specify an <i>As_Of_Effective_Date</i> that is accurate for Japan Standard Time, otherwise the request will default to Pacific Time.

## <a id="section_N1007A_N1000F_N10001"></a>Paging Optimization

If you specify an <i>As_Of_Entry_DateTime</i> value and a <i>Page</i> value of 1 in a request, Workday optimizes the retrieval of subsequent pages of data. For any large set of data, optimized paging gives you better performance.

Use the paging optimization pattern for all web services that have the <i>Response_Filter</i> element. There’s no disadvantage to following this pattern with those web services. You'll still have the advantage of consistent paging, even if the web service doesn’t support optimized paging.

To take advantage of optimized paging:

-   Specify an <i>As_Of_Entry_DateTime</i> value.
-   Retrieve page 1 first. Subsequent calls can be in any order (typically, you’ll retrieve them in order).
-   Perform paged results frequently to avoid error messages, otherwise the optimization will expire and you’ll receive an error message.
-   Change only the page number in subsequent requests.


If the optimization expires, request page 1 again and continue your requests for other pages. The subsequent requests will use the newly optimized paging data when returning the other pages.

The response won’t use optimized paging if:

-   There’s no <i>As_Of_Entry_DateTime</i> element in the request.
-   There’s only 1 page of data.


