getAddress
- Description
- This inquiry transaction returns the recorded information for a specific address.
- Web Services
- Operation name: getAddress
- Example
- Usage 1
- The transaction retrieves an existing address in the database.
- Usage 2
- For the address record 310 Main Street, Anytown, Ontario, Canada, L6T 4E2, the transaction retrieves the address values for a DSL line and a satellite television receiver.
- Usage 3
- For the address record 310 Main Street, Anytown, Ontario, Canada, L6T 4E2, the transaction retrieves the address values for a DSL line and a satellite television receiver. The transaction also retrieves an address note for August 23, 2013: A service repairman from the cable company came to the house to repair the satellite but was unable to complete the service call due the owner's vicious dog.
- Usage information
- 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 used, the transaction returns the address record.
- Preconditions
- Not applicable
- Mandatory input
- AddressId
- InquiryLevel
- Inquiry levels
- Level 0 - returns the Address business 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 response from the transaction returns the address information for the address being queried, such as address line one, address line two, city, province/state, postal/zip code, and other information depending on the inquiry level.
- Request message
- <InquiryType> getAddress
<InquiryParam>
<tcrmParam name= "addressId">
<tcrmParam name= "inquiryLevel">
- Response objects
- Address details based on inquiry level:
Level 0 - TCRMAddressBObj
Level 1 - Level 0 plus TCRMAddressValueBObj
Level 2 - Level 1 plus TCRMAddressNoteBObj
If no inquiry level:
- Special note
- Not applicable