Inbound Service BusinessPartnerDataManagementQueryBusinessPartnerIn
Overview
| Description | Query Business Partners |
| Name | BusinessPartnerDataManagementQueryBusinessPartnerIn |
| Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Process Component Description | Business Partner Data Management |
| Process Component Name | BusinessPartnerDataManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component |
Operations | Find business partners using phone number
Find business partners using e-mail uri
|
Public Solution Model
Documentation
Definition
An interface to retrieve business partner master data.
Business Context and Use
The web service interface Query Business Partner In enables you to connect external applications to your solution and to query and read business partners in your system. The web service interface Query Business Partner In is relevant if your company wants to access and manage business partner data from external applications.
The web service interface Query Business Partner In offers the operations Find FindBusinessPartnerByEmailURI_Sync and FindCallingBusinessPartnerByPhoneNumber_Sync.
Example Request: Query business partners by normalised phone number "+49622*"
<n0:CallingBusinessPartnerByPhoneNumberQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<CallingBusinessPartnerSelectionByPhoneNumber>
<NormalisedNumberDescription>+49622*</NormalisedNumberDescription>
</CallingBusinessPartnerSelectionByPhoneNumber>
</n0:CallingBusinessPartnerByPhoneNumberQuery_sync>
Here is an excerpt of the response of the request above including one of several businesspartner records returned by the query:
<n0:CallingBusinessPartnerByPhoneNumberResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS5E8D7998593639256065:804">
<CallingBusinessPartner>
<UUID>00163e04-dc33-1ed2-bc8b-6f74205a6b5a</UUID>
<InternalID>HXCIIJP002</InternalID>
<CategoryCode>1</CategoryCode>
<LifeCycleStatusCode>1</LifeCycleStatusCode>
<CurrentBusinessCharacters>
<ContactPersonIndicator>true</ContactPersonIndicator>
</CurrentBusinessCharacters>
<Common>
<BusinessPartnerFormattedName>GivenNameTestPers-HXCIIJP002 FamilyNameTestPers-HXCIIJP002</BusinessPartnerFormattedName>
<Person>
<GivenName>GivenNameTestPers-HXCIIJP002</GivenName>
<FamilyName>FamilyNameTestPers-HXCIIJP002</FamilyName>
</Person>
</Common>
<UniformAddress>
<DefaultFacsimile>
<Number>
<AreaID>06227</AreaID>
<SubscriberID>RFHXCIIJP002</SubscriberID>
<ExtensionID>RFE</ExtensionID>
<CountryCode>DE</CountryCode>
<CountryDiallingCode>+49</CountryDiallingCode>
</Number>
<FormattedNumberDescription>+49 (6227) RFHXCIIJP002-RFE</FormattedNumberDescription>
<NormalisedNumberDescription>+496227734924457002733</NormalisedNumberDescription>
<ValidityPeriod>
<StartDate>0000-00-00</StartDate>
<EndDate>0000-00-00</EndDate>
</ValidityPeriod>
</DefaultFacsimile>
<DefaultTelephone>
<Number>
<AreaID>06227</AreaID>
<SubscriberID>RTHXCIIJP002</SubscriberID>
<ExtensionID>RTE</ExtensionID>
<CountryCode>DE</CountryCode>
<CountryDiallingCode>+49</CountryDiallingCode>
</Number>
<FormattedNumberDescription>+49 (6227) RTHXCIIJP002-RTE</FormattedNumberDescription>
<NormalisedNumberDescription>+496227784924457002783</NormalisedNumberDescription>
<ValidityPeriod>
<StartDate>0000-00-00</StartDate>
<EndDate>0000-00-00</EndDate>
</ValidityPeriod>
<MobilePhoneNumberIndicator>false</MobilePhoneNumberIndicator>
<SMSEnabledIndicator>false</SMSEnabledIndicator>
</DefaultTelephone>
<DefaultMobilePhone>
<Number>
<AreaID>0170</AreaID>
<SubscriberID>RMHXCIIJP002</SubscriberID>
<CountryCode>DE</CountryCode>
<CountryDiallingCode>+49</CountryDiallingCode>
</Number>
<FormattedNumberDescription>+49 (170) RMHXCIIJP002</FormattedNumberDescription>
<NormalisedNumberDescription>+49170764924457002</NormalisedNumberDescription>
<ValidityPeriod>
<StartDate>0000-00-00</StartDate>
<EndDate>0000-00-00</EndDate>
</ValidityPeriod>
<MobilePhoneNumberIndicator>true</MobilePhoneNumberIndicator>
<SMSEnabledIndicator>true</SMSEnabledIndicator>
</DefaultMobilePhone>
<AddressHostTypeCode>3</AddressHostTypeCode>
<DefaultEMail>
<URI>wpaddr@relc.org</URI>
</DefaultEMail>
</UniformAddress>
<IsContactPersonForRelationship>
<RelationshipBusinessPartnerInternalID>HXCNFHO002</RelationshipBusinessPartnerInternalID>
<RelationshipBusinessPartnerCommonFormattedName>FirstLineNameTestOrg-HXCNFHO002 SecondLineNameTestOrg-HXCNFHO002</RelationshipBusinessPartnerCommonFormattedName>
</IsContactPersonForRelationship>
</CallingBusinessPartner></n0:CallingBusinessPartnerByPhoneNumberResponse_sync>
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Operation Query Business Partner In Find Calling Business Partner By Phone Number _Sync
Overview
| Description | Find business partners using phone number |
| Name | FindCallingBusinessPartnerByPhoneNumber_Sync |
| Synchronous | yes |
Public Solution Model
Documentation
Definition
To retrieve a business partner master data for a given phone number.
Business Context and Use
The request message of the operation FindCallingBusinessPartnerByPhoneNumber contains the QueryByElements that groups all possible selection parameters.
Structure
Request
| Query Parameter |
Comment |
|---|
| UUID |
Business partner UUID |
| InternalId |
Business partner internal ID |
| BusinessPartnerAdditionalName |
Business Partner additional Name |
| BusinessPartnerName |
Business Partner Name |
| NormalisedNumberDescription |
Normalised Phone Number |
| SearchText |
Search Text |
*Example (1): Query business partners by normalised phone number "+4962277-1"
Request:
<n0:CallingBusinessPartnerByPhoneNumberQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<CallingBusinessPartnerSelectionByPhoneNumber>
<NormalisedNumberDescription>+4962277-1</NormalisedNumberDescription>
</CallingBusinessPartnerSelectionByPhoneNumber>
</n0:CallingBusinessPartnerByPhoneNumberQuery_sync>
Example (2): Query business partners by normalised phone number "+49622" and business partner name "Mueller"
Request:
<n0:CallingBusinessPartnerByPhoneNumberQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<CallingBusinessPartnerSelectionByPhoneNumber>
<BusinessPartnerName>Mueller</BusinessPartnerName>
<NormalisedNumberDescription>+49622*</NormalisedNumberDescription>
</CallingBusinessPartnerSelectionByPhoneNumber>
</n0:CallingBusinessPartnerByPhoneNumberQuery_sync>
Operation Query Business Partner In Find Business Partner By Email URI _Sync
Overview
| Description | Find business partners using e-mail uri |
| Name | FindBusinessPartnerByEmailURI_Sync |
| Synchronous | yes |
Public Solution Model
Documentation
Definition
To query business partner data by the email URI.
Business Context and Use
The request message of the operation FindBusinessPartnerByEmailURI contains the QueryByElements that groups all possible selection parameters.
Structure
Request
| Query Parameter |
Comment |
|---|
| EmailURI |
Email URI of a business partner address |
| InternalId |
Business partner internal ID |
| BusinessCharacterCode |
Business Character |
| BusinessPartnerAdditionalName |
Business Partner additional Name |
| BusinessPartnerName |
Business Partner Name |
| LifeCycleStatusCode |
Status |
| SearchText |
Search Text |
Example (1): Query business partners by email URI domain "@test.com"
Request:
<n0:BusinessPartnerByEmailURIQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessPartnerSelectionByEmailURI>
<EmailURI>*@test.com</EmailURI>
</BusinessPartnerSelectionByEmailURI>
</n0:BusinessPartnerByEmailURIQuery_sync>
Example (2): Query blocked business partners by email URI "xyz@test.com"
Request:
<?xml version="1.0" encoding="UTF-8"?>
<n0:BusinessPartnerByEmailURIQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessPartnerSelectionByEmailURI>
<EmailURI>xyz@test.com</EmailURI>
<LifeCycleStatusCode>3</LifeCycleStatusCode>
</BusinessPartnerSelectionByEmailURI>
</n0:BusinessPartnerByEmailURIQuery_sync>
Show full documentation
Show full documentation