getAllAnswerSets
- Description
- This inquiry transaction returns the details of all existing AnswerSets for a given Party.
- Web Services
- Operation name: getAllAnswerSets
- Example
- Retrieve all the AnswerSets given by John Smith.
- Usage information
- This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- AnswerParty (PartyId)
- InquiryLevel
- Filter
- Inquiry levels
- InquiryLevel:
- Level 0 – returns AnswerSetBObj.
- Level 1 – returns level 0 data plus all AnswerBObj objects and EnumeratedAnswerBObj objects or Own Answers.
- Filter values
- This transaction requires a filter value. Valid values are:
- ACTIVE - returns active records only.
- INACTIVE - returns inactive records only.
- ALL - returns all records that match the search criteria, both active and inactive.
If the filter value provided is incorrect, all records that match the search criteria, both active and inactive, are returned by default.
- Transaction behavior
- AnswerSets with a StartDate on or before the current date and
an EndDate after the current date are "Active".
AnswerSets with an EndDate before the current date are "Inactive".
- Request message
- <InquiryType> getAllAnswerSets
<InquiryParam>
<tcrmParam name = "AnswerParty">
<tcrmParam name = "InquiryLevel">
<tcrmParam name = "Filter">
- Response objects
- AnswerSetBObj details, based on the InquiryLevel:
- 0 – one or more AnswerSetBObj objects
- 1 – level 0 data plus associated AnswerBObj objects
- Special note
- Not applicable