getPersonName
- Description
- This inquiry transaction returns a specific recorded name for a given Person party.
- Web Services
- Operation name: getPersonName
- Example
- Retrieve the legal name for Jane Black.
- Usage information
- The input to this transaction is the person PartyId and NameUsageType
(for example, Legal, Nickname, Maiden, and others) being queried.
NameUsageTypes are user-definable through a code table (CDNAMEUSAGETP).
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- NameUsageType
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- The response from the transaction returns the name information
for the party and name type being queried such as first name, middle
name, last name, and others.
If multiple active name types exist, they are all returned.
The retrieval of the AccessDateValue business object as part of this transaction is dependent on the properties value for global flag for "attrib_access_date_value". If this flag is set to ON, then this transaction always returns the AccessDateValue business object at the attribute level.
- Request message
- <InquiryType> getPersonName
<InquiryParam>
<tcrmParam name= "PartyId">
<tcrmParam name= "NameUsageType">
- Response objects
- TCRMPersonNameBObj
with optional business object:
- Special note
- Not applicable