searchByAddress

The following methods searches for business-partners with the referred address criterias. The return can obtain none, one or more business-partners.

Object: /net/dsb/avs3/BpSearch
Method: searchByAddress
Version: 2.0.0
Fuba: /DSB/ISM_E_QUICKFIND_SUCHE/

Parameter

Name	Type / max. length	mandatory?	Description
company	AN / 30	K	company name (min. length 3 )
first-name	AN / 30	K	Vorname (min. length 3)
last-name	AN / 30	K	lastname(min. length 3)
street	AN / 50	K	street (min. length 4)
zipcode	AN / 11	K	zipcode (min. length 3)
city	AN / 50	K	city(min. length 3)
country-code	AN / 2	K	Int. ISO country code.
communication	n.a.	K	T = Telephone ; WW = E-Mail Address
search-contact-persons	B	K	Search also contact-person?. Default is „false“.Attention: This parameter is actually not supported in AVS/3. It is intended for future developments
max-hit-count	N / 4	K	count of max returned results. Default is 20.(max. limit is 500)
fallback-search	AN / 1	K	If the element is not specified then it is equal to an empty element or loaded with N. This is the standard case. If the element is explicitly filled with Y then it has the effect that there will be made an internally extended search with for example Wildcards. Therefore it can be lead to extended sample space. This search extension will only be executed if no result could be determined on he first search stage.

Response Element

List of business-partner-address-extract fragments

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="avs/3" >
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <company></company>
    <first-name></first-name>
    <last-name></last-name>
    <street></street>
    <zipcode></zipcode>
    <city></city>
    <country-code></country-code>
    <search-contact-persons></search-contact-persons>
    <max-hit-count></max-hit-count>
    <fallback-search></fallback-search>
  </body>
</message>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="avs/3">
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <!—-up to 20 bp-addresses -->
    <business-partner-address-extract>
    ...      
    </business-partner-address-extract>
  </body>
</message>

Response Structure

Structure <business-partner-address-extract>

<business-partner-address-extract>
    <client></client>
    <bp-number></bp-number>
    <salutation-code></salutation-code>
    <first-name></first-name>
    <last-name1></last-name1>
    <company1></company1>
    <company2></company2>
    <company3></company3>
    <default-zipcode></default-zipcode>
    <default-city></default-city>
    <default-street-or-pobox></default-street-or-pobox>
    <default-street-nr></default-street-nr>
    <default-street-suffix></default-street-suffix>
    <default-street-number-suffix></default-street-number-suffix>
    <default-country-code></default-country-code>
    <default-district></default-district>
    <!-- 0 ... n -->
    <communication>
        <communication-type> </communication-type>
        <communication-value></communication-value>
        <communication-default></communication-default>
    </communication>
    <valid-from></valid-from>
    <valid-to><valid-to>
</business-partner-address-extract>

Element Definitions

Field Name	Type	Text	Remark, field supply or encoding
client	4	AN	Mandant
bp-number	10	N	business partner number
salutation-code	2	AN	salutation code (see codetable)
last-name1	30	AN	lasname
first-name	30	AN	firstname
company1	30	AN	firm line 1
company2	30	AN	firm line 2
company3	30	AN	firm line 3
default-zipcode	11	AN	default zipcode
default-city	50	AN	default city
default-street-or-pobox	50	AN	default street or po-box
default-street-nr	20	AN	default house number
default-street-suffix	35	AN	default street suffix
default-street-number-suffix	8	AN	default street number suffix
default-country-code	2	AN	ISO country code
default-district	35	AN	default city extension
communication 0 … n
* communication-type	2	AN	Values
* communication-value	50	AN	Value
* communication-default	1	AN	Y/N: Is this the default address of this type
valid-from	10	D	Address valid from (YYYY-MM-DD)
valid-to	10	D	Address valid to (YYYY-MM-DD)