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

Operation: Get_External_Form_I-9

This web services allows a record of an External Form I-9 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_Request

The Worker Reference to extract External Form I-9 for Workers.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_External_Form_I-9_Request_References  [0..1]  The Worker Reference to extract External Form I-9 for Workers.   
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. 
 
top
 

Response Element: Get_External_Form_I-9_Response

The response element that contains all necessary information when getting an External Form I-9.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_External_Form_I-9_Request_References  [0..*]  The Worker Reference to extract External Form I-9 for Workers.   
Response_Filter  Response_Filter  [0..*]  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_Results  Response_Results  [0..*]  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  Change_External_Form_I-9_Response_Data  [0..*]  The element containing all necessary information to put/get an External Form I-9 for a Worker.   
top
 

Get_External_Form_I-9_Request_References

part of: Get_External_Form_I-9_Request, Get_External_Form_I-9_Response
The Worker Reference to extract External Form I-9 for Workers.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..*]  The Worker Reference to extract External Form I-9 for Workers.   
top
 

WorkerObject

part of: External_Form_I-9_Data, Get_External_Form_I-9_Request_References, Change_External_Form_I-9
 
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  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

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

Response_Filter

part of: Get_External_Form_I-9_Request, Get_External_Form_I-9_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
 

Response_Results

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

Change_External_Form_I-9_Response_Data

part of: Get_External_Form_I-9_Response
The element containing all necessary information to put/get an External Form I-9 for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9  Change_External_Form_I-9  [0..*]  The element containing all necessary information to put/get an External Form I-9 for a Worker.   
top
 

Change_External_Form_I-9

part of: Change_External_Form_I-9_Response_Data
The element containing all necessary information to put/get an External Form I-9 for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  The Worker Reference to extract External Form I-9 for Workers.   
External_Form_I-9_Data  External_Form_I-9_Data  [0..*]  The element containing all necessary information to put/get an External Form I-9 for a Worker. 
Validation Description
If nothing is entered in List A, you must enter documents in both List B and List C.   
The External Form I-9 Source is inactive.   
 
top
 

External_Form_I-9_Data

part of: Change_External_Form_I-9
The element containing all necessary information to put/get an External Form I-9 for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  The Worker for this business process.   
Form_I-9_Reference_ID  string  [0..1]  Unique Reference ID for Form I-9   
E-Verify_Case_Number  string  [0..1]  The E-Verify Case Number assigned to the Worker.   
External_Form_I-9_Source_Reference  External_Form_I-9_SourceObject  [1..1]  The External Form I-9 Source assigned to the Worker.   
External_Form_I-9_Section_1_Data  External_Form_I-9_Section_1_Data  [1..1]  The request element containing all necessary information for Form I-9 Section 1 to assign to the worker.   
External_Form_I-9_Section_2_Data  External_Form_I-9_Section_2_Data  [1..1]  The request element containing all necessary information for Form I-9 Section 2 to assign to the worker.   
External_Form_I-9_Attachment_Data  External_Form_I-9_Attachment_Data  [0..*]  The request element containing all necessary information for Form I-9 Attachment to assign to the Worker.   
Validation Description
If nothing is entered in List A, you must enter documents in both List B and List C.   
The External Form I-9 Source is inactive.   
top
 

External_Form_I-9_SourceObject

part of: External_Form_I-9_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  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_Section_1_Data

part of: External_Form_I-9_Data
The request element containing all necessary information for Form I-9 Section 1 to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Last_Name  string  [1..1]  The Last Name to be assigned to the Worker.   
Employee_First_Name  string  [1..1]  The First Name to be assigned to the Worker.   
Employee_Middle_Initial  string (3)   [0..1]  The Middle Name to be assigned to the Worker.   
Employee_Other_Names_Used  string  [0..1]  The Other Names Used to be assigned to the Worker.   
Citizenship_Status_Reference  Form_I-9_Citizenship_Status__Workday_Owned_Object  [1..1]  The Form I-9 Citizenship Status to be assigned to the Worker.   
top
 

Form_I-9_Citizenship_Status__Workday_Owned_Object

part of: External_Form_I-9_Section_1_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  Form_I-9_Citizenship_Status__Workday_Owned_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Form_I-9_Citizenship_Status__Workday_Owned_ObjectID

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

External_Form_I-9_Section_2_Data

part of: External_Form_I-9_Data
The request element containing all necessary information for Form I-9 Section 2 to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Start_Date  date  [1..1]  The Start Date for the Worker to be assigned to the Form I-9.   
Form_I-9_Additional_Information  string  [0..1]  Any Additional Information to be assigned to the Form I-9.   
Form_I-9_Employer_Signature_Date  date  [1..1]  The Employer Signature Date to be assigned to the Form I-9.   
External_Form_I-9_Section_2_List_A_Data  External_Form_I-9_Section_2_List_A_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List A to assign to the worker.   
External_Form_I-9_Section_2_List_B_Data  External_Form_I-9_Section_2_List_B_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List B to assign to the worker.   
External_Form_I-9_Section_2_List_C_Data  External_Form_I-9_Section_2_List_C_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List C to assign to the worker.   
top
 

External_Form_I-9_Section_2_List_A_Data

part of: External_Form_I-9_Section_2_Data
The request element containing all necessary information for Form I-9 Section 2 List A to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Section_2_List_A_Doc_1_Data  External_Form_I-9_Section_2_List_A_Doc_1_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List A Doc 1 to assign to the worker.   
External_Form_I-9_Section_2_List_A_Doc_2_Data  External_Form_I-9_Section_2_List_A_Doc_2_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List A Doc 2 to assign to the worker.   
External_Form_I-9_Section_2_List_A_Doc_3_Data  External_Form_I-9_Section_2_List_A_Doc_3_Data  [0..1]  The request element containing all necessary information for Form I-9 Section 2 List A Doc 3 to assign to the worker.   
top
 

External_Form_I-9_Section_2_List_A_Doc_1_Data

part of: External_Form_I-9_Section_2_List_A_Data
The request element containing all necessary information for Form I-9 Section 2 List A Doc 1 to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Document_Title_Reference  Form_I-9_Identifier_Type__Workday_Owned_Object  [0..1]  The Section 2 List A Doc 1 Document Title to assign to the Worker's Form I-9.   
Expiration_Date  date  [0..1]  The Section 2 List A Doc 1 Expiration Date to assign to the Worker's Form I-9.   
top
 

Form_I-9_Identifier_Type__Workday_Owned_Object

part of: External_Form_I-9_Section_2_List_C_Data, External_Form_I-9_Section_2_List_A_Doc_1_Data, External_Form_I-9_Section_2_List_A_Doc_2_Data, External_Form_I-9_Section_2_List_A_Doc_3_Data, External_Form_I-9_Section_2_List_B_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  Form_I-9_Identifier_Type__Workday_Owned_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Form_I-9_Identifier_Type__Workday_Owned_ObjectID

part of: Form_I-9_Identifier_Type__Workday_Owned_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, I9_Government_Identifier_Type_Code, I9_License_Identifier_Type_Code, I9_Passport_Identifier_Type_Code, National_ID_Type_Code  [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_Section_2_List_A_Doc_2_Data

part of: External_Form_I-9_Section_2_List_A_Data
The request element containing all necessary information for Form I-9 Section 2 List A Doc 2 to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Document_Title_Reference  Form_I-9_Identifier_Type__Workday_Owned_Object  [0..1]  The Section 2 List A Doc 2 Document Title to assign to the Worker's Form I-9.   
Expiration_Date  date  [0..1]  The Section 2 List A Doc 2 Expiration Date to assign to the Worker's Form I-9.   
top
 

External_Form_I-9_Section_2_List_A_Doc_3_Data

part of: External_Form_I-9_Section_2_List_A_Data
The request element containing all necessary information for Form I-9 Section 2 List A Doc 3 to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Document_Title_Reference  Form_I-9_Identifier_Type__Workday_Owned_Object  [0..1]  The Section 2 List A Doc 3 Document Title to assign to the Worker's Form I-9.   
Expiration_Date  date  [0..1]  The Section 2 List A Doc 3 Expiration Date to assign to the Worker's Form I-9.   
top
 

External_Form_I-9_Section_2_List_B_Data

part of: External_Form_I-9_Section_2_Data
The request element containing all necessary information for Form I-9 Section 2 List B to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Document_Title_Reference  Form_I-9_Identifier_Type__Workday_Owned_Object  [0..1]  The Section 2 List B Document Title to be assigned to the Worker's Form I-9.   
Expiration_Date  date  [0..1]  The Section 2 List B Expiration Date to be assigned to the Worker's Form I-9.   
top
 

External_Form_I-9_Section_2_List_C_Data

part of: External_Form_I-9_Section_2_Data
The request element containing all necessary information for Form I-9 Section 2 List C to assign to the worker.
 
Parameter name Type/Value Cardinality Description Validations
Document_Title_Reference  Form_I-9_Identifier_Type__Workday_Owned_Object  [0..1]  The Section 2 List C Document Title to be assigned to the Worker's Form I-9.   
Expiration_Date  date  [0..1]  The Section 2 List C Expiration Date to be assigned to the Worker's Form I-9.   
top
 

External_Form_I-9_Attachment_Data

part of: External_Form_I-9_Data
The request element containing all necessary information for Form I-9 Attachment to assign to the Worker.
 
Parameter name Type/Value Cardinality Description Validations
External_Form_I-9_Attachment_Reference  Form_I-9_AttachmentObject  [0..1]  The Form I-9 Attachment to be assigned to the Worker's Form I-9.   
Attachment_WWS_Data  Attachment_WWS_Data  [0..*]  Attachment WWS Data element   
top
 

Form_I-9_AttachmentObject

part of: External_Form_I-9_Attachment_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  Form_I-9_AttachmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Form_I-9_AttachmentObjectID

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

Attachment_WWS_Data

part of: External_Form_I-9_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

part of: Attachment_WWS_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  Mime_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Mime_TypeObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

External_Form_I-9_SourceReferenceEnumeration

part of: External_Form_I-9_SourceObjectID
Base Type
string
top
 

Form_I-9_Citizenship_Status__Workday_Owned_ReferenceEnumeration

part of: Form_I-9_Citizenship_Status__Workday_Owned_ObjectID
Base Type
string
top
 

Form_I-9_Identifier_Type__Workday_Owned_ReferenceEnumeration

part of: Form_I-9_Identifier_Type__Workday_Owned_ObjectID
Base Type
string
top
 

Form_I-9_AttachmentReferenceEnumeration

part of: Form_I-9_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top