getPartyAddress
- Description
- This inquiry transaction returns the first occurrence of an address for a given party, of a given usage type.
- Web Services
- Operation name: getPartyAddress
- Example
- Usage 1
- Retrieve John Weir's residence address.
- Usage 2
- John Weir's residence address of 310 Danforth Avenue, Toronto, Ontario, L6T 4E2 has address values for a DSL line and a satellite.
- Usage 3
- John Weir's residence address of 310 Danforth Avenue, Toronto Ontario L6T 4E2, has address values for a DSL line and a satellite. It also has an address note for Thursday, August 18, 2012, a service repairman from the cable company came to the house to repair the satellite but was unable to complete the service call due to the owner's vicious dog.
- Usage information
- Use this transaction to retrieve a primary residence or business
address for a given party.
Address usage types are defined in a code table.
When using this transaction, the inquiry level can be used to retrieve additional information. Depending on the inquiry level, address values, address notes, or both, are returned with the address record. This inquiry level is optional. If the inquiry level is not provided, the transaction returns the party address and address business objects.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- AddressUsageType
- InquiryLevel
- Inquiry levels
- InquiryLevel:
- Level 0 - returns the Party address business object with an associated address object.
- Level 1 - returns level 0 data plus all address values.
- Level 2 - returns level 1 data plus all address notes.
- Filter values
- Not applicable
- Transaction behavior
- The Party Address Usage Type must be active for it to be returned; otherwise, a not found error is returned.
- Request message
- <InquiryType> getPartyAddress
<InquiryParam>
<tcrmParam name= "partyId">
<tcrmParam name= "addressUsageType"> such as Primary Residence, Mailing
<tcrmParam name= "inquiryLevel">
- Response objects
- Party address details are returned, depending on the inquiry level:
- Level 0 - TCRMPartyAddressBObj with associated TCRMAddressBobj
- Level 1 - Level 0 plus TCRMAddressValueBObj
- Level 2 - Level 1 plus TCRMAddressNoteBObj
Note: If no inquiry level is provided, level 0 objects are returned. - Special note
- Not applicable