Service Directory > v31.2 > Human_Resources > Get_External_Form_I-9_Source
 

Operation: Get_External_Form_I-9_Source

This web services allows an External Form I-9 Source to be extracted from Workday.


@ - 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_External_Form_I-9_Source_Request

Get External Form I-9 Sources Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   External_Form_I-9_Source_Request_References  [0..1]  External Form I-9 Source Request References   
Request_Criteria [Choice]   External_Form_I-9_Source_Request_Criteria  [0..1]  External Form I-9 Source Request Criteria   
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  External_Form_I-9_Source_Response_Group  [0..1]  External Form I-9 Source Response Group   
top
 

Response Element: Get_External_Form_I-9_Source_Response

Get External Form I-9 Sources Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  External_Form_I-9_Source_Request_References  [0..1]  External Form I-9 Source Request References   
Request_Criteria  External_Form_I-9_Source_Request_Criteria  [0..1]  External Form I-9 Source Request Criteria   
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  External_Form_I-9_Source_Response_Group  [0..1]  External Form I-9 Source Response Group   
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  External_Form_I-9_Source_Response_Data  [0..1]  External Form I-9 Source Response Data   
top
 

External_Form_I-9_Source_Request_References

part of: Get_External_Form_I-9_Source_Response, Get_External_Form_I-9_Source_Request
External Form I-9 Source Request References
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Source_Reference  External_Form_I-9_SourceObject  [1..*]  External Form I-9 Source Reference   
top
 

External_Form_I-9_SourceObject

part of: External_Form_I-9_Source_Request_References, External_Form_I-9_Source
 
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  External_Form_I-9_SourceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

External_Form_I-9_SourceObjectID

part of: External_Form_I-9_SourceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, External_Form_I-9_Source_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
 

External_Form_I-9_Source_Request_Criteria

part of: Get_External_Form_I-9_Source_Response, Get_External_Form_I-9_Source_Request
External Form I-9 Source Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_External_Form_I-9_Source_Response, Get_External_Form_I-9_Source_Request
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
 

External_Form_I-9_Source_Response_Group

part of: Get_External_Form_I-9_Source_Response, Get_External_Form_I-9_Source_Request
External Form I-9 Source Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_External_Form_I-9_Source_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
 

External_Form_I-9_Source_Response_Data

part of: Get_External_Form_I-9_Source_Response
External Form I-9 Source Response Data
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Source  External_Form_I-9_Source  [0..*]  External Form I-9 Source   
top
 

External_Form_I-9_Source

part of: External_Form_I-9_Source_Response_Data
External Form I-9 Source
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Source_Reference  External_Form_I-9_SourceObject  [0..1]  External Form I-9 Source Reference   
External_Form_I-9_Source_Data  External_Form_I-9_Source_Data  [0..1]  External Form I-9 Source Data   
top
 

External_Form_I-9_Source_Data

part of: External_Form_I-9_Source
External Form I-9 Source Data
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Source_Name  string  [1..1]  External Form I-9 Source Name   
Inactive  boolean  [0..1]  Inactive   
External_Form_I-9_Source_ID  string  [0..1]  External Form I-9 Source ID   
top
 

External_Form_I-9_SourceReferenceEnumeration

part of: External_Form_I-9_SourceObjectID
Base Type
string
top