updateCustomers

Navigation:  WebService Calls > Options for Growth >

updateCustomers

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Anlegen und Aktualisieren von Kundendaten aus Speed4Trade CONNECT.

Beispiel Request

Code

<request method="updateCustomers" version="1.0.0">

   <customer significant_key="customer_id">

      <!-- <customer_id>[ID]</customer_id> -->

      <mandator_id>1</mandator_id>

      <customer_type_id>1</customer_type_id><!--Alternative 1-->

      <!--<customer_type_identifier>private</customer_type_identifier>--><!--Alternative 2-->

      <customer_number>6</customer_number>

      <external_customer_id_1>123456</external_customer_id_1>

      <external_customer_id_2>654321</external_customer_id_2>

      <salutation_id>1</salutation_id><!--Alternative 1-->

      <!--<salutation_identifier>mr</salutation_identifier>--> <!--Alternative 2-->

      <firm>Test GmbH</firm>

      <title>Dr.</title>

      <first_name>Max</first_name>

      <last_name>Mustermann</last_name>

      <street>Musterstrasse</street>

      <house_number>1 a</house_number>

      <street_addition>2. Stock</street_addition>

      <postal_code>92637</postal_code>

      <city>Weiden</city>

      <region>Bayern</region>

      <country_code_iso>DE</country_code_iso>

      <phone>09641/45490</phone>

      <mobile_phone>0123/456789</mobile_phone>

      <fax>09641/454910</fax>

      <email>contact@spee4trade.com</email>

      <depositor>Max Mustermann</depositor>

      <bank_account_number>232435355</bank_account_number>

      <bank_code>7322615</bank_code>

      <bank_name>Raiffeisenbank Weiden e. G. </bank_name>

      <swift_code>666666</swift_code>

      <iban_code>777777</iban_code>

      <homepage>https://www.speed4trade.com</homepage>

      <skype>skypeName</skype>

      <msn>msnName</msn>

      <icq>icqNumber</icq>

      <note>Der Kunde ist sehr anspruchsvoll.</note>

      <birthday>1988-07-11</birthday>

      <password></password>

      <tax_identification_number>987654321</tax_identification_number>

      <tax_number>123456789</tax_number>

      <shipping_addresses>

         <address significant_key="address_id">

            <address_id>4436472</address_id>

            <salutation_id>1</salutation_id><!--Alternative 1-->

            <!--<salutation_identifier>mr</salutation_identifier>--><!--Alternative 2-->

            <firm>Test GmbH</firm>

            <title>Dr.</title>

            <first_name>Max</first_name>

            <last_name>Mustermann</last_name>

            <street>Musterstrasse</street>

            <house_number>1 a</house_number>

            <street_addition>2. Stock</street_addition>

            <postal_code>92637</postal_code>

            <city>Weiden</city>

            <country_code_iso>DE</country_code_iso>

            <phone_number>09641/45490</phone_number>

         </address>

      </shipping_addresses>

   </customer>

</request>

Feldliste Request

Name

Beschreibung        

Anz.

Typ

sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„updateCustomers“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

customer

Wrapper-Element, das die Daten des Kunden zusammenfasst

0..N

Element

significant_key

Gibt an welches Feld zur Identifikation des Kunden beim Update genutzt wird.

1

string

Feste Werte:

„customer_id“ |

„external_customer_id_1“|

„external_customer_id_2“ |

„customer_number“

customer_id

ID des Kunden

1

integer

mandator_id

ID des Mandanten dem der Kunde zugeordnet ist.

1

integer

 

 

customer_type_id

Typ des Kunden

1

integer

Zulässige Werte:

1 (= Privatkunde)

2 (= Geschäftskunde)

customer_type_identifier

Bezeichner des Kundentypen

1

string

Zulässige Werte:

„private“ |

„business“

customer_number

Kundennummer

1

integer

external_customer_id_1

Externe Kundennummer

0..1

string

Länge:

0 - 50 Zeichen

external_customer_id_2

Externe Kundennummer

0..1

string

Länge:

0 – 50 Zeichen

salutation_id

ID der Anrede

0..1

integer

Zulässige Werte:

1 (= Herr)

2 (= Frau)

3 (= Firma)

salutation_identifier

Bezeichner der Anrede

0..1

string

Zulässige Werte:

„mr“ |

„ms“| „business“

firm

Firma des Kunden

0..1

string

Länge:

0 – 200 Zeichen

title

Titel des Kunden

0..1

string

Länge:

0 – 100 Zeichen

first_name

Vorname

0..1

string

Länge:

0 – 100 Zeichen

last_name

Nachname

1

string

Länge:

0 – 200 Zeichen

street

Straße

1

string

Länge:

0 – 200 Zeichen

house_number

Hausnummer

0..1

string

Länge:

0 – 50 Zeichen

street_addition

Zusatzinformation für die Adresse (z.B. bei Müller)

0..1

string

Länge:

0 – 200 Zeichen

postal_code

Postleitzahl

0..1

string

Länge:

0 – 50 Zeichen

city

Ort

1

string

Länge:

0 – 200 Zeichen

region

Region

0..1

string

Länge:

0 – 200 Zeichen

country_code_iso

Ländercode

1

string

ISO 3166 ALPHA-2 Codes (z.B. „DE“)

phone

Telefonnummer (Festnetz)

0..1

string

Länge:

0 – 50 Zeichen

mobile_phone

Telefonnummer (Mobil)

0..1

string

Länge:

0 – 50 Zeichen

fax

Faxnummer

0..1

string

Länge:

0 – 50 Zeichen

email

E-Mail-Adresse

0..1

string

Länge:

0 – 100 Zeichen

depositor

Kontoinhaber

0..1

string

Länge:

0 – 150 Zeichen

bank_account_number

Kontonummer

0..1

string

Länge:

0 – 20 Zeichen

bank_code

Bankleitzahl

0..1

string

Länge:

0 – 20 Zeichen

bank_name

Name der Bank

0..1

string

Länge:

0 – 150 Zeichen

swift_code

SWIFT-Code

0..1

string

Länge:

0 – 20 Zeichen

iban_code

IBAN-Code

0..1

string

Länge:

0 – 40 Zeichen

homepage

Homepage des Kunden

0..1

string

Länge:

0 – 150 Zeichen

skype

Skype-ID

0..1

string

Länge:

0 – 50 Zeichen

msn

MSN-ID

0..1

string

Länge:

0 – 50 Zeichen

icq

ICQ-Nummer

0..1

string

Länge:

0 – 50 Zeichen

note

Notiz

0..1

string

birthday

Geburtstag

0..1

date

password

Passwort des Kunden

0..1

string

Länge:

0 – 50 Zeichen

created_by

Benutzer der Kunden angelegt hat

0..1

string

tax_identification_number

Umsatzsteuer-Ident-Nr.

0..1

string

Länge:

0 – 50 Zeichen

tax_number

Steuer-ID

0..1

string

Länge

0 – 50 Zeichen

shipping_addresses

Wrapper-Element für Lieferadressen die dem Kunden zugeordnet sind.

1

Element

address

Wrapper-Element, das die Daten einer Adresse zusammenfasst.

0..N

Element

significant_key

Attribut von address. Gibt an welches Feld zur Identifikation der Adresse beim Update verwendet wird.

1

string

Fester Wert:

„address_id“

address_id

ID der Adresse

0..1

integer

salutation_id

ID der Anrede

0..1

integer

Zulässige Werte:

1 (= Herr)

2 (= Frau)

3 (= Firma)

salutation_identifier

Bezeichner der Anrede

0..1

string

Zulässige Werte:

„mr“ |

„ms“| „business“

firm

Firma des Kunden

0..1

string

Länge:

0 – 200 Zeichen

title

Titel des Kunden

0..1

string

Länge:

0 – 100 Zeichen

first_name

Vorname

0..1

string

Länge:

0 – 100 Zeichen

last_name

Nachname

1

string

Länge:

0 – 200 Zeichen

street

Straße

1

string

Länge:

0 – 200 Zeichen

house_number

Hausnummer

0..1

string

Länge:

0 – 50 Zeichen

street_addition

Zusatzinformation für die Adresse (z.B. bei Müller)

0..1

string

Länge:

0 – 200 Zeichen

postal_code

Postleitzahl

0..1

string

Länge:

0 – 50 Zeichen

city

Ort

1

string

Länge:

0 – 200 Zeichen

country_code_iso

Ländercode

1

string

ISO 3166 ALPHA-2 Codes (z.B. „DE“)

phone_number

Telefonnummer (Festnetz)

0..1

string

Länge:

0 – 50 Zeichen

specific_customer_data

Wrapper-Element, das plattformspezifische Kundendaten enthält

0..1

Element

Beispiel Response

Code

<response method="updateCustomers" version="1.0.0">

   <report action="insert" return_code="0">

      <customer>

         <customer_id>1680088</customer_id>

         <mandator_id>1</mandator_id>

         <customer_number>6</customer_number>

         <external_customer_id_1>123456</external_customer_id_1>

         <external_customer_id_2>654321</external_customer_id_2>

      </customer>

   </report>

</response>

Feldliste Response

Name

Beschreibung        

Anz.

Typ

sonstiges

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„updateCustomers“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation. Für jedes Customer-Element aus dem Request wird ein Report zurückgegeben.

0..N

Element

action

Attribut von report. Gibt an welche Operation mit dem Datensatz durchgeführt wurde.

1

string

Feste Werte:

insert | update

return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert

0..1

string

customer

Wrapper-Element, das die Daten des Kunden zusammenfasst

1

Element

customer_id

Kunden-ID

1

integer

mandator_id

Mandanten-ID

1

integer

customer_number

Kundennummer

1

integer

external_customer_id_1

Externe Kunden-ID 1

0..1

string

Länge:

0 – 50 Zeichen

external_customer_id_2

Externe Kunden-ID 2

0..1

string

Länge:

0 – 50 Zeichen

Hinweise

•Bei jeder Operation wird zunächst geprüft ob bereits ein passender Datensatz mit dem durch significant_key angegebenen Schlüssel zum Aktualisieren vorhanden ist. Wenn dies nicht der Fall ist wird ein neuer Datensatz angelegt. Wird bei dem neuen Datensatz keine customer_number übergeben, dann zieht Speed4Trade CONNECT die nächste Kundennummer aus dem Nummernkreis im Mandanten und gibt diese in der Response mit zurück.

•Es muss entweder das Element customer_type_id oder customer_type_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig.

•Es muss entweder das Element salutation_id oder salutation_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig.

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung