Service Directory > v32.1 > Revenue_Management > Get_Business_Connections
 

Operation: Get_Business_Connections

This service operation will get Business Connections based on request criteria, or all Business Connections if no request criteria is provided. Business Connection Data includes Business Connection Reference ID, the Business Connection owner, customer, address, tax code, and inactive and default flags.


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

This element is the top-level request element for all Business Connection "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Business_Connection_Request_References  [0..1]  This element content contains the Business Connection reference element used to return Business Connection by reference id.   
Request_Criteria [Choice]   Business_Connection_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Business Connection.   
Response_Filter  Response_Filter  [0..1]  Element content containing Business Connection Response Filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Business_Connection_Response_Group  [0..1]  Element content containing Business Connection Response Group element   
top
 

Response Element: Get_Business_Connections_Response

Element containing Business Connection response elements including echoed request data and request result
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Business_Connection_Request_References  [0..1]  Business Connection Reference element contains the set of requested Business Connections for which to return data.   
Request_Criteria  Business_Connection_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Business Connection-specific 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  Business_Connection_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Business Connection response.   
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  Business_Connection_Response_Data  [0..1]  Wrapper element containing Business Connection Response Data for requested references or criteria   
top
 

Business_Connection_Request_References

part of: Get_Business_Connections_Request, Get_Business_Connections_Response
Business Connection Reference element contains the set of requested Business Connections for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Business_Connection_Reference  Customer_Business_ConnectionObject  [0..*]  Reference Business Connection for which data will be returned   
top
 

Customer_Business_ConnectionObject

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

Customer_Business_ConnectionObjectID

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

part of: Get_Business_Connections_Request, Get_Business_Connections_Response
This element is the wrapper around a list of elements representing the Business Connection-specific criteria.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..1]  Reference to existing Customers that own Business Connections.   
top
 

CustomerObject

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

CustomerObjectID

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

Business_Connection_Response_Group

part of: Get_Business_Connections_Request, Get_Business_Connections_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Business Connection response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Business Connection Reference data is to be included in the response   
top
 

Response_Results

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

Business_Connection_Response_Data

part of: Get_Business_Connections_Response
Wrapper element containing Business Connection Response Data for requested references or criteria
 
Parameter name Type/Value Cardinality Description Validations
Business_Connection  Business_Connection  [0..*]  The response for a request for Business Connection data.   
top
 

Business_Connection

part of: Business_Connection_Response_Data
Wrapper Element containing a Business Connection Reference and all data for the single Business Connection.
 
Parameter name Type/Value Cardinality Description Validations
Business_Connection_Reference  Customer_Business_ConnectionObject  [0..1]  The Business Connection for which data is returned.   
Business_Connection_Data  Business_Connection_Data  [0..*]  Contains all References and Attributes to represent a complete Business Connection. 
Validation Description
The business connection owner can not be updated.   
The address you specify for the business connection must be defined as a shipping or primary address for that customer.   
Add a customer only once to the Connection Map.   
One business connection must be designated as the default connection.   
You can’t delete the default business connection.   
 
top
 

Business_Connection_Data

part of: Business_Connection
Contains all References and Attributes to represent a complete Business Connection.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true to delete the Business Connection.   
Business_Connection_ID  string  [0..1]  Business Connection Reference ID. This is the Business Connection Unique Identifier.   
Customer_Reference  CustomerObject  [1..1]  The customer that owns the Business Connection   
Ship-To_Customer_Reference  CustomerObject  [1..1]  The Business Connection customer   
Default_Ship-To_Customer  boolean  [0..1]  The flag that indicates whether this is the default Business Connection.   
Default_Ship-To_Address  string  [0..1]  Ship-To Address   
Address_Reference_ID  string  [0..1]  The External Address ID is a text string generated in and used by an external system to identify this address.   
Validation Description
The business connection owner can not be updated.   
The address you specify for the business connection must be defined as a shipping or primary address for that customer.   
Add a customer only once to the Connection Map.   
One business connection must be designated as the default connection.   
You can’t delete the default business connection.   
top
 

Customer_Business_ConnectionReferenceEnumeration

part of: Customer_Business_ConnectionObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top