Retrieve Business Partner Relationship

An operation that retrieves a list of business partner relationships based on identifying elements.

This operation reads the data from one or more business partner relationships. The specification of the response view can be used to determine the size of the response message.

For more information about the business context, see the Business Partner Relationship business object.

To use this operation the following information is needed:

• The coded representation of the category (CategoryCode element)

• One of the following identifiers for the first business partner

  • Unique identifier (UUID element)

  • Internal identifier (InternalID element)

  • A valid unique alternative identifier for the business partner required for the identification node (PartyIdentifierTypeCode and BusinessPartnerID elements) such as a passport number or ID card

• One of the following three identifiers for the second business partner:

  • Unique identifier (UUID element)

  • Internal identifier (InternalID element)

  • A valid unique alternative identifier for the business partner required for the identification node (PartyIdentifierTypeCode and BusinessPartnerID elements)

For each successfully retrieved business partner relationship, the operation returns a list of the identifying elements of the first and second business partner as well as details for the relationship. If a business partner relationship cannot be found, an error message is sent to the log. The data that is returned depends on the category code of the relationship.

• If the relationship category is Contact Person, the response returns details that are specific to the Contact Person category code, such as the workplace address, together with a validity period.

• If the relationship category is Shareholder the response returns shareholder-specific details, such as the participation amount and percentage, together with a validity period.

• If the relationship category is Other relationships such as Is married to, only the validity period is returned.

The response message also includes the ChangeStateID element for each relationship, which is needed for the Update Business Partner Relationship as Bundle operation.

In addition, the specification of the response view (ResponseViewSpecification node) may also be provided in the request for performance reasons.

This determines the nodes that are included in the response message. If the requested indicator (RequestedIndicator element) is set to true for one or more of the following nodes, then the data from the corresponding node(s) is included:

• FirstBusinessPartnerCommon

• FirstBusinessPartnerIdentification

• SecondBusinessPartnerCommon

• SecondBusinessPartnerIdentification

• BusinessProcessChainAssignment

• ContactPerson

• Shareholder

• OtherRelationshipCategory

If the requested indicator (RequestedIndicator element) is set to false (default value), then no data is returned for the corresponding node.

For the contact person category code (ContactPerson element) the FormattedAddress element specified in the request controls the format used for addresses in the response.

For more information, see Error Handling in Financial Services .

The following main error messages are recorded in the log of the response message:

• DCE.VME (Value Mapping Error):

  • FSBP_MAIN_ERROR_MSG 013 (Error occurred during mapping (inbound))

  • FSBP_MAIN_ERROR_MSG 014 (Error occurred during mapping (outbound))

• FOE.SVE (Scheme Violation Error): FSBP_MAIN_ERROR_MSG 011 (Error during validation (inbound))

• PRE (Processing Error): FSBP_MAIN_ERROR_MSG 001 (Cannot execute the operation; error while processing the data)

• PRE.IDE (Identification Error): FSBP_MAIN_ERROR_MSG 003 (Business partner relationship does not exist)

For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.

• BusinessPartnerRelationshipFSRetrievalByIdentifyingElementsQuery

• BusinessPartnerRelationshipFSRetrievalByIdentifyingElementsResponse