Address Element
The Address element provides the ability add and update client addresses via transactions. Adding this element to a transaction will cause the processed activity to use the current AddressScreen rule and write a record to the AsAddress table.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<Address>
|
|
Optional: Opening tag. |
|
COPYSOURCEADDRESSGUID |
Optional: Specifies an existing Address GUID to copy. If this attribute exists, the AddressTypes and AddressType elements are ignored. If this attribute and DEFAULTADDRESSTYPE are both specified, DEFAULTADDRESSTYPE is ignored. |
Activity field containing the Address Type GUID. Screen math variables are not supported. |
|
DEFAULTADDRESSTYPE |
Optional: Takes a literal value to define what the default address type is to display on the activity address screen. Used in lieu of the AddressTypes element or in conjunction with it. If the COPYSOURCEADDRESSGUID attribute is specified, DEFAULTADDRESSTYPE is ignored. |
Code values from AsCodeAddressRole.
If AddressTypes element is also used, the address RoleCode specified in the DEFAULTADDRESSTYPE attribute must be from the list of AddressType elements. |
|
<AddressTypes> |
|
Optional Lists the eligible address types to list on the address screen. |
|
<AddressType> |
|
Required, Repeatable: Indicates the code value from the AsCodeAddressRole table to specify the AddressType. |
|
XML Examples
<Transaction>
<Address COPYSOURCEADDRESSGUID=”SomeFieldName”/>
</Transaction>
Or
<Transaction>
<Address >
<AddressTypes>
<AddressType>01<AddressType>
<AddressType>02<AddressType>
<AddressType>03<AddressType>
</AddressTypes>
</Address>
</Transaction>
Or
<Transaction>
<Address DEFAULTADDRESSTYPE=”02”/>
</Transaction>
Or
<Transaction>
<Address DEFAULTADDRESSTYPE="04">
<AddressTypes>
<AddressType>01<AddressType>
<AddressType>02<AddressType>
<AddressType>03<AddressType>
<AddressType>04<AddressType>
</AddressTypes>
</Address>
</Transaction>