getImagesByParty
- Description
- The purpose of this transaction is to provide the user with a view of specific data changes that have been made to a given party over a specified period of time.
- Web Services
- Operation name: getImagesByParty
- Example
- View any changes that were made to a given party's name and PartyAddress during the period January 1 to March 31. This could be required to determine why a customer's name and address change were not processed when a change of name and address form was mailed by the customer several months previously.
- Usage information
- Users must specify a ViewInstance which is a list of business
objects that the user wants to see changes for, and the date range
for those changes.
- The inquireFromDate and inquireToDate are used to specify a date range; only images of the party as it existed between those two dates are returned. For example, if Susanna's name change was processed on March 28 and her address change was processed on March 30, performing a query using inquireFromDate = January 1 and inquireToDate = March 31, 3 images are returned: image1showing before the name change; image2 showing after the name change but before the address change; image3 showing after both the name and address change. Only InquireFromDate is mandatory. If InquireToDate is not provided, that end date is defaulted to the end-of-day for InquireToDate. If InquireFromDate with or without InquireToDate is provided, InquireAsOfDate cannot be provided.
- TransactionLogInd indicator is a 'Y' or 'N' indicator used to specify whether transaction log details should be returned in the response transaction or not. If the indicator is set to 'Y', transaction audit information log objects are returned.
- ImageInstanceType or ImageInstanceValue define the ViewImageInstance. In order to run a getImagesByParty transaction, an ViewImageInstance must have already been defined. Any number of ViewImageInstances can be created, each with a unique type and value.
- PartyId is the PartyIdPK of the party being queried.
The specific business objects that are available for selection are: party, person, organization, person name, organization name, party address, party contact method, identification, party relationships, and income source.
Each ImageInstance defines a set of party objects; these are the objects that are used to determine whether a given party's data has been changed over the specified period of time. For example, if imageInstanceType = 1 contains the set of objects Person or Organization Name, and PartyIdentification, then a getImagesByParty transaction returns one party view each time any data associated with these three objects changes, however an additional party view is not returned when the PartyAddress alone changes.
- Preconditions
- The getImagesByParty function requires the presence of historical records in the history database in order to retrieve party images. If database triggers are altered, the getImagesByParty function is affected.
- Mandatory input
- InquireFromDate
- ImageInstanceType, ImageInstanceValue, or both
- InquiryRequestType as PartyId
- InquiryRequestValue as PartyIdPK
- PartyInquiryLevel
- Inquiry levels
- Note: User-customizable inquiry levels are available for this transaction.PartyInquiryLevel:
- Level 0 - returns Party data including names, identifications, party privacy preferences, line of business relationships, and either personal data, if a Person, or organizational data, if an Organization.
- Level 1 - returns level 0 data plus all party addresses and contact methods.
- Level 2 - returns level 1 data plus all party relationship data.
- Level 3 - returns level 2 data plus all party bank account, party charge card, and income source data.
- Level 4 - returns level 3 data plus all party value data.
- Filter values
- Not applicable
- Transaction behavior
- Using the date range, the history tables associated with the objects
specified in the view instance are queried to determine what changes
occurred during the time specified.
A point in time party image, using a getParty transaction, is returned for each business object changed Images are in a transactional context so if three of the specified business objects were changed in one transaction, only one party image is returned.
- Request message
- <TCRMTxType> getImagesByParty
<TCRMTxObject> TCRMImageRequestBObj
<TCRMObject> TCRMImageRequestBObj
<TransactionLogInd> "Y" or "N"
<Image Instance Type> <user-defined>
<Image Instance Value> <user-defined>
<TCRMObject> TCRMImageRequestParamBObj
<InquiryRequestType> "PartyId"
<InquiryRequestValue> <PartyId>
<InquiryLevel> 0 - 4
- Response objects
- TCRMImageListBObj
- Special note
- Not applicable