updateEpaBoms

Navigation:  WebService Calls > Options for Growth >

updateEpaBoms

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Aktualisierung von Parts Stücklisten. Damit können Artikel der Baugruppe zugeordnet werden.

Die Zuordnung erfolgt über die Elemente <item> und <assembly> und den bei diesen Elementen hinterlegten significant_key-Werten. Der significant_key beim Element <bom> muss fest angegeben sein.

Beispiel Request

Code

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

   <delete>true</delete>

   <bom significant_key="bom_id" reference_id="BomInsert-123" >

      <mandator_id>1</mandator_id>

      <active>true</active>

      <provider_id>0</provider_id>

      <item significant_key="item_id">

         <item_id>76036</item_id>

         <internal_item_number>InternalItemNumber123</internal_item_number>

         <ean_code>EANNumber123</ean_code>

      </item>

      <assembly significant_key="external_identifier"> 

         <assembly_id>4</assembly_id>

         <external_identifier>Maximal Data Test</external_identifier>

      </assembly>

      <additional_items>

         <item significant_key="item_id"> 

            <item_id>76036</item_id>

            <internal_item_number>InternalItemNumber123</internal_item_number>

            <ean_code>EANNumber123</ean_code>

            <quantity>2</quantity>

            <additional_item_type>MANDATORY</additional_item_type>

         </item>

      </additional_items>

      <media>

         <medium significant_key="medium_id">

            <medium_id>37566</medium_id>

            <medium_identifier>Datei1</medium_identifier>

         </medium>

      </media>

      <bom_texts>

         <bom_text>

            <free_text>true</free_text>

            <text_identifier>SelectMeAPI</text_identifier>

            <multi_language_data>

               <language_data>

                  <language_code_iso>de</language_code_iso>

                  <text>TestText</text>

               </language_data>

            </multi_language_data>

         </bom_text>

      </bom_texts>

      <bom_attributes>

         <bom_attribute>

            <attribute_identifier>Attribute API Call 1</attribute_identifier>

            <bom_attribute_values>

               <bom_attribute_value>

                  <value>Value Val</value>

                  <multi_language_data>

                     <language_data>

                        <language_code_iso>de</language_code_iso>

                        <identifier>VAL DE</identifier>

                     </language_data>

                  </multi_language_data>

               </bom_attribute_value>

            </bom_attribute_values>

         </bom_attribute>

      </bom_attributes>

   </bom>

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

„updateEpaBoms“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

delete

Löschkennzeichen. Im Standard, wenn der Wert nicht extra angegeben wird, wird "false" angenommen.

true: Löscht alle Baugruppen, welche nicht in dem Request übergeben wurden.

false: Löscht keine Baugruppen. Es werden nur Baugruppen hinzugefügt.

0..1

boolean

bom

Wrapper-Element der Stücklisten

1..N

Element

significant_key

Fester Wert, der in diesem Call keinen direkten Bezug zu einem Element hat. Gesteuert wird die Zuordnung über die Elemente <item> und <assembly>, die ein eigenes Attribut "significant_key" haben.

1

string

Fester Wert: „bom_id“

reference_id

Referenz-ID.

1

string

mandator_id

Mandanten-ID

1

integer

active

Aktivstatus

1

boolean

provider_id

Anbieter-ID

1

string

item

Wrapper-Element der Daten für den Artikel

1

Element

significant_key

Gibt an welches Feld zur Identifikation beim Update genutzt wird.

1

string

Feste Werte:  „item_id“ | „ean_code“ | „internal_item_number“

item_id

Artikel-ID

0..1

integer

internal_item_number

Interne Artikelnummer

0..1

string

ean_code

EAN-Code

0..1

string

assembly

Wrapper-Element der Daten für die Baugruppe

1

Element

significant_key

Gibt an welches Feld zur Identifikation beim Update genutzt wird.

1

string

Feste Werte: „assembly_id“ | „external_identifier“

assembly_id

Baugruppen-ID

0..1

integer

external_identifier

Externer Bezeichner der Baugruppe

0..1

string

additional_items

Wrapper-Element für Zusatzartikel

0..1

Element

significant_key

Gibt an welches Feld zur Identifikation beim Update genutzt wird.

1

string

item_id

Artikel-ID

0..1

integer

internal_item_number

Interne Artikelnummer

0..1

string

ean_code

EAN-Code

0..1

string

quantity

Artikelmenge

1

integer

additional_item_type

Typ des Zusatzartikels

1

string

media

Wrapper-Element für Medien

0..1

Element

medium

Wrapper-Element für die Daten eines Mediums

1..N

Element

significant_key

Gibt an welches Feld zur Identifikation beim Update genutzt wird.

1

string

medium_id

Medien-ID

0..1

integer

medium_identifier

Bezeichnung des Mediums

0..1

string

bom_texts

Wrapper-Element für die Stücklistentexte

0..1

Element

bom_text

Wrapper-Element für die Daten eines Stücklistentextes

1..N

Element

free_text

Kennzeichen ob Freitextfeld

1

boolean

text_identifier

Bezeichung des Textes

0..1

string

multi_language_data

Wrapper-Element, das mehrsprachig vorhandene Daten der Texte zusammenfasst.

0..1

Element

language_data

Wrapper-Element, das die Daten einer Sprache des Textes zusammenfasst.

1..N

Element

language_code_iso

ISO-Code der die Sprache darstellt.

1

string

z.B.  „de“

text

Der Text an sich.

1

string

bom_attributes

Wrapper-Element der Stücklistenattribute.

0..1

Element

bom_attribute

Wrapper-Element für Daten eines Stücklistenattributes.

1..N

Element

attribute_identifier

Bezeichnung des Stücklistenattributes

1

string

bom_attribute_values

Wrapper-Element der Stücklistenattributswerte

1

Element

bom_attribute_value

Wrapper-Element für Daten eines Stücklistenattributswertes

1..N

Element

value

Wert des Stücklistenattributswertes.

1

string

multi_language_data

Wrapper-Element, das mehrsprachig vorhandene Daten der Stücklistenattributswerte zusammenfasst.

0..1

Element

language_data

Wrapper-Element, das die Daten einer Sprache der Stücklistenattributswerte zusammenfasst.

1..N

Element

language_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B.  „de“

identifier

Bezeichnung der Sprache

1

string

Beispiel Response

Code

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

   <report action="update" return_code="0" reference_id="BomInsert-123">

      <error_description>Error</error_description>

      <total_number_of_pages>0</total_number_of_pages>

      <total_number_of_entries>0</total_number_of_entries>

      <bom>

         <bom_id>46</bom_id>

         <assembly_id>4</assembly_id>

         <item_id>76036</item_id>

         <active>true</active>

         <provider_id>0</provider_id>

      </bom>

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

„updateEpaBoms“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation.

0..N

Element

action

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

1

string

Feste Werte:

delete | insert | update

return_code

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

1

integer

0 = OK.

< 0 = Fehler

reference_id

Referenz-ID

0..1

string

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

Gibt an, wie viele Seiten es insgesamt gibt.

0..1

integer

total_number_of_entries

Gibt an, wie viele Einträge es insgesamt zurückgegeben werden.

0..1

integer

bom

Wrapper-Element für die Stücklisten

0..1

Element

bom_id

Stücklisten-ID

1

byte

assembly_id

Baugruppen-ID

1

byte

item_id

Artikel-ID

1

integer

active

Aktivstatus

1

boolean

provider_id

Anbieter-ID

1

byte

Hinweise

•Baugruppen die durch einen TecDoc-Datenabgleich im Artikel angelegt werden, haben fest den Wert "TecDoc" als provider_id hinterlegt.

Änderungsübersicht

Version

Änderungsbeschreibung

3.5.27

Initiale Version

4.10.6

Request um delete-Flag erweitert