Parámetros d

Tabla 1. Datos de entrada de BuildGlobalAddress

columnName

Parámetro

Formato

Descripción

Action

Cadena

Especifica la acción a realizar. Una de las siguientes:

init
Inicialización. Esta acción abre una sesión y arroja una ID de sesión que se requiere para otras acciones. La acción init (inicialización) requiere el campo de entrada Country (País).
search
Busca los valores de un elemento de dirección específico y arroja una lista de valores alternativos para que usted elija los que corresponden. La acción search (búsqueda) requiere los siguientes campos de entrada:
  • FieldIndex
  • SearchValue
  • SessionId
commit
Asigna uno de los valores devueltos por la acción de búsqueda para el campo. La acción commit (confirmar) requiere los siguientes campos de entrada:
  • AlternativeIndex
  • AlternativeContext
  • SessionId
clear
Desvincula el campo especificado en el campo FieldIndex. La acción clear (borrar) requiere los siguientes campos de entrada:
  • FieldIndex
  • SessionID
close
Finaliza una sesión. La acción close (cerrar) requiere el campo de entrada SessionId.

AlternativeContext

Cadena

Para la acción de confirmar, indica si se está eligiendo un valor del campo Alternatives.InContext o del campo Alternatives.OutContext. Este campo se omite para otras acciones. Una de las siguientes:

in
Se confirma un valor del campo Alternatives.InContext . Esto significa que el valor especificado en el campo de entrada AlternativeIndex corresponde a un valor del campo de salida Alternatives.InContext .
out
Se confirma un valor del campo Alternatives.OutContext . Esto significa que el valor especificado en el campo de entrada AlternativeIndex corresponde a un valor del campo de salida Alternatives.OutContext.

AlternativeIndex

Cadena de caracteres [79]

Para la acción de confirmar, especifica el valor que se desea utilizar en la dirección a crear. Por ejemplo, si usted buscó una ciudad y BuildGlobalAddress arroja una lista de tres ciudades, puede indicar la ciudad deseada especificando el valor de índice de su opción. Los valores de índice para las alternativas presentadas por BuildGlobalAddress toman el cero como base, lo que significa que la primera alternativa tiene el valor 0, la segunda tiene el valor 1, y así sucesivamente.

El campo de entrada solo se toma en cuenta para la acción de confirmar.

Country

Cadena de caracteres [79]

Para la acción de inicialización, especifica el país en el que se desea construir una dirección. Para especificar el país, utilice el formato que eligió para el formato de entrada de país (nombre en inglés, código de dos caracteres ISO 3116-1 Alpha-2 o código de tres caracteres ISO 3116-1 Alpha-3). Para acceder a una lista de códigos ISO, consulte Códigos de país ISO y compatibilidad de módulos.

Este campo de entrada solo se toma en cuenta para la acción de inicialización.

FieldIndex

Cadena de caracteres [79]

Para la acción de búsqueda, especifica el elemento de dirección respecto del cual se desea buscar. Para la acción de borrar, especifica el elemento de dirección que se desea desvincular. Una de las siguientes:

all
Ejecuta la acción "clear" (borrar) en todos los elementos de dirección. Esta opción se aplica solo para la acción "clear" (borrar).
<IndexNumber>
Ejecuta la acción en un elemento de dirección específico. Para determinar el índice de un elemento de dirección, en primer lugar observe los campos Field.n.Name y localice el campo deseado. El valor n indica el índice del campo. Por ejemplo, supongamos que usted desea buscar códigos postales (ZIP) para direcciones de Estados Unidos Después de la llamada de inicialización, observará que Field.0.Name muestra el valor "Zip", lo que indica que el código postal (ZIP) tiene el índice de campo "0".

Este campo de entrada solo se toma en cuenta para las acciones de búsqueda y borrado.

SearchValue

Cadena de caracteres [79]

Para la acción de búsqueda, especifica el valor que se desea buscar. Este valor debe ser adecuado para el campo especificado en FieldIndex. Por ejemplo, si especificó el campo de código postal (ZIP) en FieldIndex, debe ingresar un código postal (ZIP) o un código postal (ZIP) parcial en este campo. Del mismo modo, si selecciona el campo de la ciudad en FieldIndex habría que especificar en este campo el nombre de una ciudad o una parte del nombre de una ciudad. Si deja el campo en blanco, la búsqueda devolverá todos los valores que están en contexto. Para obtener más información acerca de los valores en contexto o fuera de contexto, consulte ¿Qué es el contexto?.

Este campo de entrada solo se toma en cuenta para la acción de búsqueda.

SessionId

Cadena de caracteres [79]

Especifica la ID de sesión que se desea utilizar para esta llamada. Para obtener una ID de sesión, utilice la acción de inicialización. Si una sesión permanece inactiva durante 5 minutos, finalizará. En ese caso, deberá realizar una nueva llamada de inicialización para iniciar una nueva sesión.

Este campo es obligatorio para todas las acciones excepto la de inicialización.