Service Directory > v31.2 > Financial_Management > Get_Company_Ownership_Details
 

Operation: Get_Company_Ownership_Details

This web service returns company ownership details.


@ - 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_Company_Ownership_Details_Request

Request element for Get Company Ownership Details WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Company_Ownership_Detail_Response_References  [0..1]  Parameters for request   
Request_Criteria [Choice]   Company_Ownership_Detail_Request_Criteria  [0..1]  Request criteria for this web service.   
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  Company_Ownership_Detail_Response_Group  [0..1]  Response group for this web service.   
top
 

Response Element: Get_Company_Ownership_Details_Response

Response element for Get Company Ownership WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Ownership_Detail_Response_References  [0..1]  Reference to an existing Ownership Detail   
Request_Criteria  Company_Ownership_Detail_Request_Criteria  [0..1]  Request criteria for Get Company Ownership Details   
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  Company_Ownership_Detail_Response_Group  [0..1]  Response Group for Get Company Ownership Details   
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  Company_Ownership_Detail_Response_Data  [0..1]  Web Service Response Data   
top
 

Company_Ownership_Detail_Response_References

part of: Get_Company_Ownership_Details_Request, Get_Company_Ownership_Details_Response
Reference to an existing Ownership Detail
 
Parameter name Type/Value Cardinality Description Validations
Ownership_Detail_Reference  Ownership_DetailObject  [1..*]  Reference to an existing ownership detail   
top
 

Ownership_DetailObject

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

Ownership_DetailObjectID

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

Company_Ownership_Detail_Request_Criteria

part of: Get_Company_Ownership_Details_Request, Get_Company_Ownership_Details_Response
Request criteria for Get Company Ownership Details
 
Parameter name Type/Value Cardinality Description Validations
Companies_Reference  CompanyObject  [1..*]  Reference to existing Companies   
top
 

CompanyObject

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

CompanyObjectID

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

Company_Ownership_Detail_Response_Group

part of: Get_Company_Ownership_Details_Request, Get_Company_Ownership_Details_Response
Response Group for Get Company Ownership Details
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference flag   
top
 

Response_Results

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

Company_Ownership_Detail_Response_Data

part of: Get_Company_Ownership_Details_Response
Response data returned for Get Company Ownership Details
 
Parameter name Type/Value Cardinality Description Validations
Ownership_Detail  Ownership_Detail  [0..*]  Data relating to Ownership Detail for Company   
top
 

Ownership_Detail

part of: Company_Ownership_Detail_Response_Data
Data relating to Ownership Detail for Company
 
Parameter name Type/Value Cardinality Description Validations
Ownership_Detail_Reference  Ownership_DetailObject  [0..1]  Reference to an existing Ownership Detail   
Ownership_Detail_Data  Ownership_Detail_Data  [1..*]  Data relating to Ownership Detail for Company 
Validation Description
Total Ownership % must equal 100.  Total Ownership % must equal 100. 
Owner Company can occur only once: [owner companies]  Owner Company can occur only once. 
Company cannot own itself: [company]  Company cannot own itself. 
Remove all Owner Company entries if there are no Owner Companies.  Remove all Owner Company entries if there are no Owner Companies. 
Total Income Attribution % must equal 0 or 100.  Total Income Attribution % must equal 0 or 100. 
 
top
 

Ownership_Detail_Data

part of: Ownership_Detail
Data relating to Ownership Detail for Company
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  Date that the change will be effective   
Ownership_Detail_ID  string  [0..1]  Reference ID for Ownership Detail   
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company   
No_Owner_Companies  boolean  [0..1]  Whether or not the given Company has any owners   
Ownership_Entry_Data  Ownership_Entry_Data  [0..*]  Data related to creating an ownership entry   
Validation Description
Total Ownership % must equal 100.  Total Ownership % must equal 100. 
Owner Company can occur only once: [owner companies]  Owner Company can occur only once. 
Company cannot own itself: [company]  Company cannot own itself. 
Remove all Owner Company entries if there are no Owner Companies.  Remove all Owner Company entries if there are no Owner Companies. 
Total Income Attribution % must equal 0 or 100.  Total Income Attribution % must equal 0 or 100. 
top
 

Ownership_Entry_Data

part of: Ownership_Detail_Data
Data related to creating an ownership entry
 
Parameter name Type/Value Cardinality Description Validations
Owner_Company_Reference  Owner_CompanyObject  [1..1]  Reference to an Owner Company   
Ownership_Percentage  decimal (12, 6) >0   [0..1]  Percentage owned by Owner Company 
Validation Description
Enter a whole or decimal number for Ownership % from 0 through 100.  Enter a whole or decimal number for Ownership % from 0 through 100. 
 
Income_Percentage  decimal (12, 6) >0   [0..1]  Percentage of Income Attribution 
Validation Description
Enter a whole or decimal number for Income Attribution % from 0 through 100.  Enter a whole or decimal number for Income Attribution % from 0 through 100. 
 
top
 

Owner_CompanyObject

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

Owner_CompanyObjectID

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

Ownership_DetailReferenceEnumeration

part of: Ownership_DetailObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Owner_CompanyReferenceEnumeration

part of: Owner_CompanyObjectID
Base Type
string
top