getAllPersonNames
- Description
- This inquiry transaction returns all the recorded names associated with a specific Person party based on a filter value.
- Web Services
- Operation name: getAllPersonNames
- Example
- Retrieve all names associated with Sally Chu, such as her Legal name, Nickname, and Maiden name.
- Usage information
- The filter controls the type of name information that is returned:
only active names, only inactive names, or all names, both active
and inactive.
Name types are user-definable through a code table.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- Inquiry levels
- Not applicable
- Filter values
- A filter value may be supplied. Valid values are:
- ACTIVE - returns all active records.
- INACTIVE - returns all inactive records.
- ALL - returns all records that match the search criteria, both active and inactive.
If an invalid filter value, or no filter value, is supplied, then all records matching the search criteria are returned.
Filter values are case-sensitive, and must be provided in upper case.
- Transaction behavior
- Names with an end date greater than the current system date are
considered to be active.
Names with an end date less than or equal to the current system date are considered to be inactive.
The retrieval of the AccessDateValue business object as part of this transaction is dependent on the properties value for the global flag "attrib_access_date_value". If this flag is set to ON, then this transaction always returns AccessDateValue business objects at the attribute level.
- Request message
- <InquiryType> getAllPersonNames
<InquiryParam>
<tcrmParam name= "PartyId">
<tcrmParam name= "Filter">
- Response objects
- List of TCRMPersonNameBObj with optional DWLAccessDateValueBObj
- Special note
- Not applicable