fetchBranches

Navigation:  WebService Calls > Options for Growth >

fetchBranches

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Filialdaten

Beispiel Request

Code

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

  <filter>

    <mandator_id filter_method="=" filter_value="1" />

    <branch_id filter_method="=" filter_value="88383" />

    <branch_code filter_method="=" filter_value="ALLDATA" />

  </filter>

</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:

„fetchBranches“

version

Attribut von request. Legt die Version der Anfrage fest.

1

string

Fester Wert:

„1.0.0“

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element

mandator_id

Schränkt die Ergebnismenge der Abfrage auf Filialen eines bestimmten Mandanten ein.

1

Element

filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer

branch_id

Schränkt die Ergebnismenge der Abfrage auf die Filiale mit der angegebenen Filial-Id ein.

0..1

Element

filter_method

Attribut von branch_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von branch_id. Legt den Filterwert fest.

1

integer

branch_code

Schränkt die Ergebnismenge der Abfrage auf die Filiale mit dem angegebenen Code ein.

0..1

Element

filter_method

Attribut von branch_code. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von branch_code. Legt den Filterwert fest.

1

string

 

Beispiel Response

Code

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

   <report return-code="0" />

   <branch>

      <branch_id>36907</branch_id>

      <mandator_id>1</mandator_id>

      <branch_code>Branchcode</branch_code>

      <active>true</active>

      <company_name>Speed4Trade GmbH</company_name>

      <street>An den Gärten</street>

      <house_number>8</house_number>

      <postal_code>92665</postal_code>

      <city>Altenstadt</city>

      <country_code_iso>DE</country_code_iso>

      <salutation>

         <salutation_id>2</salutation_id>

      </salutation>

      <first_name>Vorname</first_name>

      <last_name>Nachname</last_name>

      <phone_number>0960294440</phone_number>

      <phone_number2>0960294440</phone_number2>

      <fax_number>096029444100</fax_number>

      <email_address>info@speed4trade.com</email_address>

      <bank_name>Bankname</bank_name>

      <bank_code />

      <bank_account_number />

      <swift_code />

      <iban_code />

      <order_time>2022-06-06T15:00:56.640+02:00</order_time>

      <tax_id_number>00000002</tax_id_number>

      <warehouse_id>133</warehouse_id>

      <region>Bayern</region>

      <latitude>45.0</latitude>

      <longitude>34.0</longitude>

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

      <pickup_instructions>Abholbar ab 12:00 Uhr des Folgetages</pickup_instructions>

      <opening_hours>

         <opening_hour>

            <day_of_week>1</day_of_week>

            <open>07:00</open>

            <close>20:00</close>

         </opening_hour>

      </opening_hours>

      <special_opening_hours>

         <special_opening_hour>

            <day_of_week>0</day_of_week>

            <open>2022-05-20T00:00:00.000+02:00</open>

            <close>2022-05-20T00:00:00.000+02:00</close>

         </special_opening_hour>

      </special_opening_hours>

      <contacts>

         <branch_contact>

            <contact_id>36874</contact_id>

            <contact_salutation_id>2</contact_salutation_id>

            <contact_first_name>Vorname</contact_first_name>

            <contact_last_name>Nachname</contact_last_name>

            <contact_position>Jobtitel</contact_position>

            <phone_number>0960294440</phone_number>

            <mobile_phone_number>0960294440</mobile_phone_number>

            <fax_number>096029444100</fax_number>

            <contact_email>info@speed4trade.com</contact_email>

            <contact_picture_as_base64>base64Content</contact_picture_as_base64>

            <contact_sort>1</contact_sort>

            <contact_picture_name>contact.png</contact_picture_name>

         </branch_contact>

      </contacts>

   </branch>

</response>

Feldliste Response

Name

Beschreibung

Anz.

Typ

sonstiges

response

Root-Element der Anfrage

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchBranches“

version

Attribut von response. Legt die Version der Anfrage fest.

1

string

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation.

1

Element

return_code

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

1

integer

0 = OK.

< 0 = Fehler

reference_id

0..1

string

action

Ausführende Aktion

0..1

string

delete | insert | update

error_description

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

0..1

string

total_number_of_pages

Gesamtanzahl an verfügbaren Seiten mit Filialdaten.

0..1

integer

total_number_of_entries

Gesamtanzahl an verfügbaren Filialdaten für den im Request angegebenen Filter.

0..1

integer

branch

Wrapper-Element, das die Daten der Filialen beinhaltet.

0..N

Element

mandator_id

ID des Mandanten

1

integer

branch_id

ID der Filiale

1

integer

branch_code

Filialcode

0..1

string

active

Aktivflag

1

boolean

company_name

Firmenname

1

string

street

Straße

1

string

house_number

Hausnummer

1

string

postal_code

Postleitzahl

1

string

city

Ort

1

string

country_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B. „de“

salutation

Wrapper-Element, das die Daten der Anrede enthält.

1

Element

salutation_id

ID der Anrede

1

integer

first_name

Vorname

1

string

last_name

Nachname

1

string

phone_number

Telefonnummer

0..1

string

phone_number2

zusätzliche Telefonnummer

0..1

string

fax_number

Faxnummer

0..1

string

email_address

Emailadresse

1

string

bank_name

Name der Bank

0..1

string

bank_code

BLZ-Nummer

0..1

string

bank_account_number

Kontonummer

0..1

string

swift_code

SWIFT- bzw. BIC-Code

0..1

string

iban_code

IBAN

0..1

string

order_time

Bestellzeitpunkt

0..1

dateTime

tax_id_number

Umsatzsteuer-ID

0..1

string

warehouse_id

ID des Lagers

0..1

integer

region

Region

0..1

string

latitude

geographische Breitenangabe

0..1

decimal

longitude

geographische Längenangabe

0..1

decimal

shop_url

Shop-URL

0..1

string

pickup_instructions

Abholhinweise

0..1

string

opening_hours

Wrapper, der die einzelnen Öffnungszeiten-Elemente beinhaltet.

0..1

Element

opening_hour

Wrapper-Element, das die Daten der Öffnungszeiten beinhaltet

0..N

Element

day_of_week

Wochentag

1

integer

open

Geöffnet ab

0..1

string

close

Geschlossen ab

0..1

string

special_opening_hours

Wrapper, der die einzelnen besonderen Öffnungszeiten-Elemente beinhaltet.

0..1

Element

special_opening_hour

Wrapper-Element, das die Daten der besonderen Öffnungszeiten beinhaltet

0..N

Element

day_of_week

Wochentag

1

integer

open

Geöffnet ab

1

string

close

Geschlossen ab

1

string

contacts

Wrapper-Element, das die Daten des Ansprechpartner  darstellt.

0..1

Element

branch_contact

Wrapper-Element, das die Daten eines Ansprechpartners bündelt

0..N

Element

contact_id

ID des Ansprechpartners

1

integer

contact_salutation_id

ID der Anrede

0..1

integer

contact_first_name

Vorname des Ansprechpartners

1

string

contact_last_name

Nachname des Ansprechpartners

1

string

contact_position

Position des Ansprechpartners

0..1

string

phone_number

Telefonnummer

0..1

string

mobile_phone_number

Mobilnummer

0..1

string

fax_number

Faxnummer

0..1

string

contact_email

Mailadresse des Anpsrechpartners

1

string

contact_picture_as_base64

BASE64 codiertes Bild des Ansprechpartners

0..1

sting

contact_sort

Sortierung

0..1

integer

contact_picture_name

Name des Bildes des Ansprechpartners

0..1

string

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.4.35.1

Initiale Erstellung