getByBpAttribute

This method sends all business-partner to the referred AVS/3 business-partner attribute back. The return can obtain none, one or more business-partners.

Object: /net/dsb/avs3/Bp
Method: getByBpAttribute
Version: 2.0.0
Fuba: /DSB/ISM_E_GET_GP_BY_ATTRIBUT

Parameter

Name	Type / max. length	mandatory?	Description
attribute-type	AN / 6	m	bp attribute type
attribute-value	AN / 50	m	bp attribute value

Response Element

Ein XML-Fragment ‚business-partner see below

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>
    <attribute>
        <attribute-type></attribute-type>
        <attribute-value></attribute-value>
    </attribute>
  </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>
    <!-- 0...1 ->
    <business-partner>
    ...
    </business-partner >
  </body>
</message>

Response Structure

Structure <business-partner>

Hint: This return structure is at the moment reserved for business partner requests using the methods getByBpNumber, getByBpAttribute and getByTimestamp .

<business-partner>
    <salutation-code></salutation-code>
    <titel-code-academic></titel-code-academic>
    <titel-academic></titel-academic>
    <titel-code-royal></titel-code-royal>
    <titel-royal></titel-royal>
    <job-titel></job-titel>
    <last-name1></last-name1>
    <last-name2></last-name2>
    <first-name></first-name>
    <street></street>
    <street-suffix></street-suffix>
    <street-number></street-number>
    <street-number-suffix></street-number-suffix>
    <address-line-1></address-line-1>
    <address-line-2></address-line-2>
    <address-line-3></address-line-3>
    <zipcode></zipcode>
    <country-code></country-code>
    <city></city>
    <district></district>
    <region-code></region-code>
    <region-text></region-text>
    <company1></company1>
    <company2></company2>
    <company3></company3>
    <department></department>
    <po-box></po-box>
    <po-box-zipcode></po-box-zipcode>
    <po-box-city></po-box-city>
    <po-box-country-code></po-box-country-code>
    <major-customer-zipcode></major-customer-zipcode>
    <address-source></address-source>
    <advertisement></advertisement>
    <category></category>
    <bp-number></bp-number>
    <bp-number-external></bp-number-external>
    <bp-group></bp-group>
    <eu-sales-tax-number></eu-sales-tax-number>
    <date-of-birth></date-of-birth>
    <bic-master-number></bic-master-number>
    <sector></sector>
    <!-- Communication Types 0...n -->
    <communication>
        <communication-type></communication-type>
        <communication-value></communication-value>
    </communication>
    <!-- business partner attributes 0...n -->
    <attribute>
        <attribute-type></attribute-type>
        <attribute-value></attribute-value>
    </attribute>
</business-partner>

Element Definitions

Field	Length	Type	Remark, field supply or encoding
salutation-code	2	C	salutation
titel-code-academic	4	C	Title-academic
titel-academic	15	C	Academic title in clear text (for example Dr.)
titel-code-royal	4	C	Title of nobility
titel-royal	15	C	Title of nobility in clear text
Job-titel	35	C	Title of job in clear text
last-name1	40	C	lastname 1
last-name2	40	C	lastname 2
first-name	40	C	First name(s)
street	50	C	street
street-suffix	40	C	street suffix
street-number	10	C	house number
street-number-suffix	10	C	house number suffix
address-line-1	35	C	address line 1 (UK addresses)
address-line-2	35	C	address line 2 (UK addresses)
address-line-3	35	C	address line 3 (UK addresses)
zipcode	10	C	zipcode
country-code	3	C	country (ISO)
city	40	C	city
district	25	C	Additon to city (for example district, area….)
region-code	3	C	Regions-Code (federal state, province, county)
region-text	25	C	Regions-as clear text (federal state, province, county)
company1	35	C	firm line 1
company2	35	C	firm line 2
company3	40	C	firm line 3
department	30	C	department
po-box	10	C	Po box
po-box-zipcode	10	C	Po-box zipcode
po-box-city	40	C	Po-box-city
po-box-country-code	3	C	Po-box-country
major-customer-zipcode	10	C	Major-customer-zipcode
address-source	10	C	Address-source Code table, contents states faculty
advertisement	1	C	Mark if advertisement should be send
category	2	C	Type of address
bp-number	10	C	Optional, with bp customer number
bp-number-external	20	C	Business partner-No. of an external system
bp-group	4	C	Customer group Code table, contents states faculty
eu-sales-tax-number	14	C	EG-UST ID number
date-of-birth	10	D	Date of birth format: JJJJ-MM-TT
bic-master-number	10	C	Partner-ID of master (for example firm of contact person)
sector	10	C	sector
communication 0…n
* communication-type	2	C	type of communication Values
* communcation-value	50	C	value of communication
attribute 0…n
* attribute-type	6	C	Function of business partner attributes For example type of address
* attribute-value	50	C	Attribute value of business partner