Input

Specifies the action to take. One of the following:

init

Initialization. This action opens a session and returns a session ID which is required for all other actions. The init action requires the Country input field.

search

Searches for values for a specific address element and returns a list of alternative values for you to choose. The search action requires the following input fields:

• FieldIndex
• SearchValue
• SessionId

commit

Assigns one of the values returned by the search action to the field. The commit action requires the following input fields:

• AlternativeIndex
• AlternativeContext
• SessionId

clear

Un-commits the field specified in the FieldIndex field. The clear action requires the following input fields:

• FieldIndex
• SessionID

close

Ends a session. The close action requires the SessionId input field.

For the commit action, indicates whether you are choosing a value from the Alternatives.InContext field or the Alternatives.OutContext field. This field is ignored for other actions. One of the following:

in

You are committing a value from the Alternatives.InContext field. This means that the value you specify in the AlternativeIndex input field corresponds to a value in the Alternatives.InContext output field.

out

You are committing a value from the Alternatives.OutContext field. This means that the value you specify in the AlternativeIndex input field corresponds to a value in the Alternatives.OutContext output field.

For the commit action, specifies the value you want to use in the address you are building. For example, if you searched for a city and Build Global Address returns a list of three cities, you would indicate the city you want by specifying the index value for your choice. Index values for the alternatives presented by Build Global Address are zero-based, meaning that the first alternative has an index of 0, the second alternative has a value of 1, and so on.

The input field is ignored for actions other than commit.

For the init action, specifies the country in which you want to build an address. Specify the country using the format you chose for input country format (English name two-character ISO 3116-1 Alpha-2 code, or three-character ISO 3116-1 Alpha-3 code). For a list of ISO codes, see ISO Country Codes and Module Support.

This input field is ignored for actions other than init.

For the search action, specifies the address element that you want to search on. For the clear action, specifies the address element you want to un-commit. One of the following:

all

performs the "clear" action on all address elements. This option applies to the "clear" action only.

<IndexNumber>

Performs the action on a specific address element. To determine the index of an address element, first look at the Field.n.Name fields and locate the field you want. The value n indicates the field's index. For example, you want to look up ZIP Codes for U.S. addresses. After the init call you see that Field.0.Name is "Zip" indicating that the ZIP Code has a field index of "0".

This input field is ignored for actions other than search and clear.

For the search action, specifies the value you want to search for. This value must be appropriate for the field you specified in FieldIndex. For example, if you specified the ZIP Code field in FieldIndex, then you would enter a ZIP Code or partial ZIP Code in this field. Likewise if you chose the city field in FieldIndex you would specify a city name or partial city name in this field. if you leave the field blank the search will return all values that are in context. For more information about in context and out of context values, see What Is Context?.

This input field is ignored for actions other than search.