getCampaign
- Description
- This inquiry transaction returns the recorded information for a specific campaign.
- Web Services
- Operation name: getCampaign
- Example
- Retrieve the Marketing campaign with the associated product details.
- Usage information
- The input to this transaction is the campaign ID of the campaign
being queried, an inquiry level and a campaign association filter.
There are three inquiry levels used in the getCampaign transaction. Inquiry level 2 is implemented using an external rule. The external rule is defaulted, but it can be customized.
- Preconditions
- Not applicable
- Mandatory input
- CampaignId
- CampAssoFilter
- InquiryLevel
- Inquiry levels
- InquiryLevel:
- Level 0 - returns Campaign details.
- Level 1 - returns level 0 data plus Campaign Association details.
- Level 2 - returns level 1 data plus associated object details such as product, party, or partygroup, depending on the external rule.
- Filter values
- A filter value must be supplied. Value values are:
- ACTIVE - returns only active records.
- INACTIVE - returns only inactive records.
- ALL - returns all records matching the search criteria, both active and inactive.
Note: Unlike many other InfoSphere® MDM transactions, the filter values for this transaction are mandatory and are not case-sensitive. - Transaction behavior
InfoSphere MDM has services for a Party, Product, and PartyGroup. The external rule used for inquiry level 2 works with Party, Product, and PartyGroup.
- Request message
- <InquiryType> getCampaign
<InquiryParam>
<tcrmParam name= "campaignId">
<tcrmParam name= "campAssoFilter">
<tcrmParam name= "inquiryLevel">
- Response objects
- TCRMCampaignBObj details, based on the inquiry level:
- 0 - TCRMCampaignBObj
- 1 - Level 0 data plus TCRMCampaignAssociationBObj
- 2 - Level 1 data plus associated object details
- Special note
- Not applicable