Service Directory > v31.2 > Resource_Management > Get_Card_Holder_Listing_Files
 

Operation: Get_Card_Holder_Listing_Files

This operation will get all Card Holder Listing Files for the specified criteria. The response will include specific information about the Card Holder Listing Files such as the Card Holder Listing File Reference, Card Holder Listing File Number, Card Holder Listing File Name, etc...


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Card_Holder_Listing_Files_Request

This element is the top-level request element for all Card Holder Listing File "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Card_Holder_Listing_File_Request_References  [0..1]  This element content contains the echoed Card Holder Listing File Request Reference Element   
Request_Criteria [Choice]   Card_Holder_Listing_File_Request_Criteria  [0..1]  This element content contains the echoed Card Holder Listing File Request Criteria Element   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Card_Holder_Listing_File_Response_Group  [0..1]  This element content contains the echoed Card Holder Listing File Response Group Element   
top
 

Response Element: Get_Card_Holder_Listing_Files_Response

Element containing Card Holder Listing File response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Card_Holder_Listing_File_Request_References  [0..1]  Card Holder Listing File Reference element contains the specific instance set containing the requested Card Holder Listing File.   
Request_Criteria  Card_Holder_Listing_File_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Card Holder Listing File Request specific criteria needed to search for instances. All of the elements are "AND" conditions. There are currently no elements.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Card_Holder_Listing_File_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Card Holder Listing File response. If this element is not included then ALL of the Response Groups are included in the response.   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Card_Holder_Listing_File_Response_Data  [0..1]  This element content contains the Card Holder Listing File Response Data element.   
top
 

Card_Holder_Listing_File_Request_References

part of: Get_Card_Holder_Listing_Files_Request, Get_Card_Holder_Listing_Files_Response
Card Holder Listing File Reference element contains the specific instance set containing the requested Card Holder Listing File.
 
Parameter name Type/Value Cardinality Description Validations
Card_Holder_Listing_File_Reference  Cardholder_Listing_FileObject  [1..*]  Instance set containing the Card Holder Listing File object.   
top
 

Cardholder_Listing_FileObject

part of: Card_Holder_Listing_File_Request_References, Card_Holder_Listing_File
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Cardholder_Listing_FileObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Cardholder_Listing_FileObjectID

part of: Cardholder_Listing_FileObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cardholder_Listing_File_Number  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Card_Holder_Listing_File_Request_Criteria

part of: Get_Card_Holder_Listing_Files_Request, Get_Card_Holder_Listing_Files_Response
This element is the wrapper around a list of elements representing the Card Holder Listing File Request specific criteria needed to search for instances. All of the elements are "AND" conditions. There are currently no elements.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Card_Holder_Listing_Files_Request, Get_Card_Holder_Listing_Files_Response
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.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Card_Holder_Listing_File_Response_Group

part of: Get_Card_Holder_Listing_Files_Request, Get_Card_Holder_Listing_Files_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Card Holder Listing File response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Card Holder Listing File Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Card_Holder_Listing_Files_Response
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.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Card_Holder_Listing_File_Response_Data

part of: Get_Card_Holder_Listing_Files_Response
Wrapper element containing Card Holder Listing File response data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Card_Holder_Listing_File  Card_Holder_Listing_File  [0..*]  Wrapper element that includes Card Holder Listing File instance and data   
top
 

Card_Holder_Listing_File

part of: Card_Holder_Listing_File_Response_Data
Wrapper element that includes Card Holder Listing File instance and data
 
Parameter name Type/Value Cardinality Description Validations
Card_Holder_Listing_File_Reference  Cardholder_Listing_FileObject  [0..1]  Card Holder Listing File Reference   
Card_Holder_Listing_File_Data  Card_Holder_Listing_File_Data  [0..*]  Element containing all Card Holder Listing File data 
Validation Description
Data Load Status must be 'Loading Data' or 'Data Loaded'   
 
top
 

Card_Holder_Listing_File_Data

part of: Card_Holder_Listing_File
Element containing all Card Holder Listing File data
 
Parameter name Type/Value Cardinality Description Validations
Card_Holder_Listing_File_Number  string  [0..1]  Card Holder Listing File Number. This is the Card Holder Listing File unique identifier   
Card_Holder_Listing_File_Name  string  [0..1]  Card Holder Listing File Name   
Card_Holder_Listing_File_Date  date  [0..1]  Card Holder Listing File Date   
Data_Load_Status_Reference  Data_Load_StatusObject  [1..1]  Data Load Status Reference which will represent the loading status of all Expense Credit Cards for a Card Holder Listing File.   
Validation Description
Data Load Status must be 'Loading Data' or 'Data Loaded'   
top
 

Data_Load_StatusObject

part of: Card_Holder_Listing_File_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Data_Load_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Data_Load_StatusObjectID

part of: Data_Load_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Data_Load_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Cardholder_Listing_FileReferenceEnumeration

part of: Cardholder_Listing_FileObjectID
Base Type
string
top
 

Data_Load_StatusReferenceEnumeration

part of: Data_Load_StatusObjectID
Base Type
string
top