Service Directory > v33.1 > Human_Resources > Get_Form_I-9_Business_Address
 

Operation: Get_Form_I-9_Business_Address

This web services allows a Form I-9 Business Address 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_Form_I-9_Business_Address_Request

Get Form I-9 Business Address Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Form_I-9_Business_Address_Request_References  [0..1]  Form I-9 Business Address Request References   
Request_Criteria [Choice]   Form_I-9_Business_Address_Request_Criteria  [0..1]  Form I-9 Business Address 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  Form_I-9_Business_Address_Response_Group  [0..1]  Form I-9 Business Address Response Group   
top
 

Response Element: Get_Form_I-9_Business_Address_Response

Get Form I-9 Business Addresses Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Form_I-9_Business_Address_Request_References  [0..1]  Form I-9 Business Address Request References   
Request_Criteria  Form_I-9_Business_Address_Request_Criteria  [0..1]  Form I-9 Business Address 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  Form_I-9_Business_Address_Response_Group  [0..1]  Form I-9 Business Address 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  Form_I-9_Business_Address_Response_Data  [0..1]  Form I-9 Business Address Response Data   
top
 

Form_I-9_Business_Address_Request_References

part of: Get_Form_I-9_Business_Address_Request, Get_Form_I-9_Business_Address_Response
Form I-9 Business Address Request References
 
Parameter name Type/Value Cardinality Description Validations
Form_I-9_Business_Address_Reference  Form_I-9_Business_AddressObject  [1..*]  Form I-9 Business Addresses Reference   
top
 

Form_I-9_Business_AddressObject

part of: Form_I-9_Business_Address_Request_References, Form_I-9_Business_Address
 
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_Business_AddressObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Form_I-9_Business_AddressObjectID

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

Form_I-9_Business_Address_Request_Criteria

part of: Get_Form_I-9_Business_Address_Request, Get_Form_I-9_Business_Address_Response
Form I-9 Business Address Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Form_I-9_Business_Address_Request, Get_Form_I-9_Business_Address_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Form_I-9_Business_Address_Response_Group

part of: Get_Form_I-9_Business_Address_Request, Get_Form_I-9_Business_Address_Response
Form I-9 Business Address Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Form_I-9_Business_Address_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Form_I-9_Business_Address_Response_Data

part of: Get_Form_I-9_Business_Address_Response
Form I-9 Business Address Response Data
 
Parameter name Type/Value Cardinality Description Validations
Form_I-9_Business_Address  Form_I-9_Business_Address  [0..*]  Form I-9 Business Address   
top
 

Form_I-9_Business_Address

part of: Form_I-9_Business_Address_Response_Data
Form I-9 Business Address
 
Parameter name Type/Value Cardinality Description Validations
Form_I-9_Business_Address_Reference  Form_I-9_Business_AddressObject  [0..1]  Form I-9 Business Addresses Reference   
Form_I-9_Business_Address_Data  Form_I-9_Business_Address_Data  [0..1]  The element containing all necessary information to put/get a Form I-9 Business Address. 
Validation Description
A default Form I-9 Business Address already exists.   
 
top
 

Form_I-9_Business_Address_Data

part of: Form_I-9_Business_Address
The element containing all necessary information to put/get a Form I-9 Business Address.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Form I-9 Business Address ID   
Employer_Company_Name  string  [0..1]  Form I-9 Business Address Employer Company Name   
Employer_Address  string  [0..1]  Form I-9 Business Address Employer Address   
Employer_City  string  [0..1]  Form I-9 Business Address Employer City   
Employer_State_Code  string (3)   [0..1]  Form I-9 Business Address Employer State Code   
Employer_Zip_Code  string  [0..1]  Form I-9 Business Address Employer Zip Code   
Default  boolean  [0..1]  Form I-9 Business Address Default   
Inactive  boolean  [0..1]  Inactive   
Validation Description
A default Form I-9 Business Address already exists.   
top
 

Form_I-9_Business_AddressReferenceEnumeration

part of: Form_I-9_Business_AddressObjectID
Base Type
string
top