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

Operation: Put_External_Form_I-9

This web services allows a record of an External Form I-9 to be put into Workday with only critical field information.


@ - 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: Put_External_Form_I-9_Request

The element containing all necessary information to put/get an External Form I-9 for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
External_Form_I-9_Data  External_Form_I-9_Data  [1..1]  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
 

Response Element: Put_External_Form_I-9_Response

The response element containing all necessary information to upload an External Form I-9 for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Complete_Form_I-9_Event_Reference  Unique_IdentifierObject  [0..1]  The Complete Form I-9 Event Process created from the request.   
top
 

Business_Process_Parameters

part of: Put_External_Form_I-9_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, 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  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
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

part of: Put_External_Form_I-9_Request
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
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
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
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top