Input
columnName Parameter |
Format |
Description |
---|---|---|
Action |
String |
Specifies the action to take. One of the following:
|
AlternativeContext |
String |
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:
|
AlternativeIndex |
String [79] |
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 BuildGlobalAddress 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 BuildGlobalAddress 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. |
Country |
String [79] |
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. |
FieldIndex |
String [79] |
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:
This input field is ignored for actions other than search and clear. |
SearchValue |
String [79] |
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. |
SessionId |
String [79] |
Specifies the session ID you want to use for this call. To obtain a session ID use the init action. If a session is inactive for 5 minutes it will expire and you will need to perform a new init call to start a new session. This field is required for all actions except init. |