Entrée

Spécifie l'action devant être réalisée. L'un des éléments suivants :

init

Initialisation. Cette action ouvre une session et renvoie un ID de session qui est requis pour effectuer toute autre action. L'action init nécessite le champ d'entrée Country.

search

Recherche les valeurs pour un élément d'adresse spécifique et renvoie une liste de valeurs alternatives parmi lesquelles vous pouvez choisir. L'action de recherche nécessite les champs d'entrée suivants :

• FieldIndex
• SearchValue
• SessionId

commit

Assigne l'une des valeurs renvoyées par l'action search dans le champ. L'action commit (assignation) nécessite les champs d'entrée suivants :

• AlternativeIndex
• AlternativeContext
• SessionId

clear

Dé-assigne le champ spécifié dans le champ FieldIndex. L'action clear nécessite les champs d'entrée suivants :

• FieldIndex
• SessionID

close

Termine une session. L'action Close (fermeture) nécessite le champ d'entrée SessionId.

Pour l'action commit (assignation), indiquez si vous choisissez une valeur à partir du champ Alternatives.InContext ou à partir du champ Alternatives.OutContext. Ce champ est ignoré pour les autres actions. L'un des éléments suivants :

in

Vous assignez une valeur à partir du champ Alternatives.InContext . Ce qui signifie que la valeur que vous indiquez dans le champ d'entrée AlternativeIndex correspond à une valeur dans le champ de sortie Alternatives.InContext .

out

Vous assignez une valeur à partir du champ Alternatives.OutContext . Ce qui signifie que la valeur que vous indiquez dans le champ d'entrée AlternativeIndex correspond à une valeur dans le champ de sortie Alternatives.OutContext .

Pour l'action commit, spécifie la valeur que vous voulez utiliser dans l'adresse que vous êtes en train de générer. Par exemple, si vous cherchez une ville et si BuildGlobalAddress renvoie une liste contenant trois villes, vous indiqueriez la ville que vous souhaitez en spécifiant la valeur d'index de votre choix. Les valeurs index correspondant aux alternatives présentées par BuildGlobalAddress sont de base zéro, c'est-à-dire que la première alternative a un index de 0, la seconde a une valeur de 1 et ainsi de suite.

Le champ d'entrée est ignoré pour toute action autre que commit.

Pour l'action init, spécifiez le pays dans lequel vous voulez générer une adresse. Spécifiez le pays à l'aide du format que vous avez choisi pour le format de pays d'entrée (nom anglais code Alpha-2 ISO 3116-1 sur deux caractères, ou code Alpha-3 ISO 3116-1 sur trois caractères). Pour obtenir la liste des codes ISO, voir Prise en charge du module et des codes ISO de pays.

Ce champ d'entrée est ignoré pour toute action autre qu'init.

Pour l'action search, spécifiez l'élément d'adresse que vous voulez chercher. Pour l'action clear, spécifiez l'élément d'adresse que vous voulez dé-assigner. L'un des éléments suivants :

all

réalise l'action « clear » sur tous les éléments d'adresse. Cette option s'applique uniquement à l'action « clear ».

<IndexNumber>

Effectue l'action sur un élément d'adresse spécifique. Pour déterminer l'index d'un élément d'adresse, regardez d'abord les champs Field.n.Name et localisez le champ que vous voulez. La valeur n indique l'index du champ. Par exemple, vous voulez rechercher des codes ZIP pour des adresses américaines. Après l'appel init, vous voyez que Field.0.Name est « Zip », indiquant que le code Zip dispose d'un index de champ de « 0 ».

Le champ d'entrée est ignoré pour toute action autre que search et clear.

Pour l'action search, spécifie la valeur que vous voulez rechercher. Cette valeur doit être appropriée pour le champ que vous spécifiez dans FieldIndex. Par exemple, si vous avez indiqué le champ ZIP Code dans FieldIndex, vous entreriez un Code Zip ou un Code Zip partiel dans ce champ. De même, si vous choisissez le champ ville dans FieldIndex, vous spécifierez un nom de ville ou un nom de ville partiel dans ce champ. Si vous laissez le champ vide, la recherche renverra toutes les valeurs qui sont en contexte. Pour plus d'informations à propos des valeurs en et hors contexte, voir Qu'est-ce que le contexte ?.

Ce champ d'entrée est ignoré pour toute action autre que search