Eingabe

Tabelle 1. Eingaben für BuildGlobalAddress

Spaltenname

Parameter

Format

Beschreibung

Action

Zeichenfolge

Gibt die auszuführende Aktion an. Zur Auswahl stehen:

init
Initialisierung. Durch diese Aktion wird eine Sitzung geöffnet und eine Sitzungs-ID zurückgegeben, die für alle anderen Aktionen erforderlich ist. Für die INIT-Aktion ist das Eingabefeld „Land“ erforderlich.
search
Sucht nach Werten für ein bestimmtes Adresselement und gibt eine Liste alternativer Werte zurück, aus der Sie wählen können. Für die SEARCH-Aktion sind die folgenden Eingabefelder erforderlich.
  • FieldIndex
  • SearchValue
  • SessionId
commit
Weist dem Feld einen der Werte zu, die von der SEARCH-Aktion zurückgegeben werden. Für die COMMIT-Aktion sind die folgenden Eingabefelder erforderlich.
  • AlternativeIndex
  • AlternativeContext
  • SessionId
clear
Hebt die Übermittlung des im Feld „FieldIndex“ angegebenen Feldes auf. Für die CLEAR-Aktion sind die folgenden Eingabefelder erforderlich.
  • FieldIndex
  • SessionID
close
Beendet eine Sitzung. Für die CLOSE-Aktion ist das Eingabefeld „SessionId“ erforderlich.

AlternativeContext

Zeichenfolge

Gibt bei der COMMIT-Aktion an, ob Sie einen Wert aus dem Feld Alternatives.InContext oder Alternatives.OutContext auswählen. Dieses Feld wird für andere Aktionen ignoriert. Zur Auswahl stehen:

in
Sie übermitteln einen Wert aus dem Feld Alternatives.InContext. Das bedeutet, dass der im Eingabefeld AlternativeIndex angegebene Wert einem Wert im Ausgabefeld Alternatives.InContext entspricht.
out
Sie übermitteln einen Wert aus dem Feld Alternatives.OutContext. Das bedeutet, dass der im Eingabefeld AlternativeIndex angegebene Wert einem Wert im Ausgabefeld Alternatives.OutContext entspricht.

AlternativeIndex

Zeichenfolge [79]

Gibt bei der COMMIT-Aktion den Wert an, den Sie in der Adresse, die Sie erstellen, verwenden möchten. Wenn Sie beispielsweise nach einem Ort gesucht haben und BuildGlobalAddress eine Liste von drei Orten zurückgibt, würden Sie den gewünschten Ort angeben, indem Sie den Indexwert für Ihre Auswahl angeben. Indexwerte für die von BuildGlobalAddress vorgelegten Alternativen sind nullbasiert, was bedeutet, dass die erste Alternative einen Index von 0 aufweist, die zweite Alternative einen Wert von 1 usw.

Mit Ausnahme der COMMIT-Aktion wird dieses Eingabefeld für Aktionen ignoriert.

Country

Zeichenfolge [79]

Gibt für die INIT-Aktion das Land an, in dem Sie eine Adresse erstellen möchten. Geben Sie das Land im Format an, das Sie als Eingabelandesformat ausgewählt haben (englischer Name, zweistelliger ISO 3116-1 ALPHA-2-Code oder dreistelliger ISO 3116-1 ALPHA-3-Code). Eine Liste der ISO-Codes finden Sie unter ISO-Ländercodes und Modulunterstützung.

Mit Ausnahme der INIT-Aktion wird dieses Eingabefeld für Aktionen ignoriert.

FieldIndex

Zeichenfolge [79]

Gibt bei der SEARCH-Aktion das Adresselement an, in dem Sie suchen möchten. Gibt bei der CLEAR-Aktion das Adresselement an, bei dem Sie die Übermittlung aufheben möchten. Zur Auswahl stehen:

all
Führt die CLEAR-Aktion auf allen Adresselementen aus. Diese Option gilt nur für die CLEAR-Aktion.
<IndexNumber>
Führt die Aktion in einem bestimmten Adresselement aus. Um den Index eines Adresselements zu bestimmen, prüfen Sie zunächst die Felder „Field.n.Name“ und suchen Sie das gewünschte Feld. Der Wert n gibt den Index des Feldes an. Sie möchten beispielsweise ZIP-Codes für US-amerikanische Adressen. Nach dem INIT-Aufruf sehen Sie, dass Field.0.Name „Zip“ lautet, was bedeutet, dass der ZIP-Code einen Feldindex von „0“ hat.

Mit Ausnahme der SEARCH- und CLEAR-Aktionen wird dieses Eingabefeld für Aktionen ignoriert.

SearchValue

Zeichenfolge [79]

Gibt bei der SEARCH-Aktion den Wert an, den Sie suchen möchten. Dieser Wert muss entsprechend dem Feld gewählt sein, das Sie in FieldIndex angegeben haben. Wenn Sie beispielsweise das Feld „ZIP-Code“ in FieldIndex angegeben haben, würden Sie einen ZIP-Code oder einen partiellen ZIP-Code in dieses Feld eingeben. Ebenso würden Sie einen Ortsnamen oder einen partiellen Ortsnamen in dieses Feld eingeben, wenn Sie in FieldIndex das Feld „Ort“ ausgewählt hätten. Wenn Sie das Feld leer lassen, gibt die Suche alle Werte innerhalb des Kontexts zurück. Weitere Informationen zu Werten innerhalb und außerhalb des Kontexts finden Sie unter Was ist Kontext?.

Mit Ausnahme der SEARCH-Aktion wird dieses Eingabefeld für Aktionen ignoriert.

SessionId

Zeichenfolge [79]

Gibt die Sitzungs-ID an, die Sie für diesen Aufruf verwenden möchten. Rufen Sie Sitzungs-IDs über die INIT-Aktion ab. Wenn eine Sitzung 5 Minuten lang inaktiv ist, wird sie ablaufen und Sie müssen einen neuen INIT-Aufruf ausführen, um eine neue Sitzung zu starten.

Dieses Feld ist mit Ausnahme von INIT für alle Felder erforderlich.