updatePartyAddress
- Description
- This transaction updates an address for a given party. This transaction is used when a party actually changes from one address to another, or for modifying attributes in the Address object, such as the country or postal code.
- Web Services
- Operation name: updatePartyAddress
- Example
- Update John Smith's address when he moves from 123 Main Street, apartment 101 to apartment 111 and correct the Residence Type from low-rise condominium to high-rise.
- Usage information
- Seasonal start date must be less than seasonal end date, if applicable.
Start date must be less than or equal to the end date.
Essentially, all of the information that can be added as part of the addPartyAddress transaction (including the address type and details such as the residence number, street name, city, province/state, country, and others) can be changed through this transaction.
To make an address inactive, use this transaction to set an end date prior or equal to the current date. To reactivate an expired party address, provide a blank end date or set an end date greater than the current date.
This transaction can also be used to add a party as a household resident for an address.
Use the correctPartyAddress transaction when the intent is to modify attributes in the PartyAddress business object without changing any attributes in the Address object.
- Preconditions
- Party address must exist.
- Mandatory input
- PartyAddressIdPK
- AddressLastUpdateDate
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- Any change to the Address object other than Residence Type, Standard
Formatting, Longitude, and Latitude automatically ends the existing
Party address association.
If the new address does not already exist, this transaction adds it with a new AddressIdPK and associates it with the given Party using the given PartyAddressIdPK.
If the new address already exists, this transaction returns the existing AddressIdPK. The previous PartyAddress record remains in the operational table under a new PartyAddressIdPK, and is retrievable through a getAllPartyAddresses transaction for the specific party, with a filter value of ALL.
For the new party address, if the start date is provided in the request and it is different from the existing party address, it will be used to set the start date of the new party address. On the other hand, if the start date is not provided, or if the provided start date is exactly the same as the existing party address, then the default start date set by the system depends on the start date of the existing party address:- the start date will be set to current system date if the start date of the existing party address is less than or equal to the current date, or
- the start date will be set to the same start date as the existing party address if it is greater than the current date
The existing party address will be inactivated with end date set to the start date of the new party address less 1 millisecond.
- Request message
- <TCRMTxType> updatePartyAddress
<TCRMTxObject> TCRMPartyAddressBObj
<TCRMObject> TCRMPartyAddressBObj with associated TCRMAddressBObj
- Response objects
- TCRMPartyAddressBObj
with associated TCRMAddressBObj
- Special note
- Use the correctPartyAddress transaction if you do not need to keep track of the previous Party address association in the operational table after modifying the Party address.