getOrganizationNames
- Description
- This inquiry transaction returns the recorded names for a given Organization party and Organization name type.
- Web Services
- Operation name: getOrganizationNames
- Example
- Retrieve the abbreviated name types for the XYZ Company organization.
- Usage information
- The input for this transaction is the organization PartyId and NameType (such as Legal, Doing
Business As, or Abbreviated) being queried.
Organization name types are user definable through a code table.
- Preconditions
- The OrganizationName must exist for the given Organization NameUsageType and PartyId.
- Mandatory input
-
- PartyId
- NameUsageType
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- The response from the transaction returns the collection of name information for the
Organization party and the NameUsageType being queried, such as OrganizationName, EffectiveDate, and
others. The Organization NameUsageType must be active to be returned; otherwise, a 'not found' error
is returned.
The retrieval of the AccessDateValue business object as part of this transaction depends on the properties value for the global flag
attrib_access_date_value
. If this flag is set to ON, then this transaction returns the AccessDateValue business object at the attribute level. - Request message
-
<TCRMTxType>getOrganizationNames</TCRMTxType> <TCRMTxObject>TCRMOrganizationNameBObj</TCRMTxObject> <TCRMObject> <OrganizationNameRequestBObj> <PartyId></PartyId> <NameUsageType>2</NameUsageType> </OrganizationNameRequestBObj> </TCRMObject>
Note: The NameUsageType parameter is based on the values in the CDORGNAMETP table; that is, the values corresponding to Legal, Doing Business As, or Abbreviated. - Response objects
- List of TCRMOrganizationNameBObj business objects with an optional business object:
- Special note
- Not applicable