getAllContractRoleLocationPurposes
- Description
- This inquiry transaction returns all contract role location purposes for a given contract role location, based on a filter.
- Web Services
- Operation name: getAllContractRoleLocationPurposes
- Example
- Retrieve all purposes associated with John Smith's mailing address for the Owner role on contract 123456.
- Usage information
- The input to this transaction is the contract role location ID
whose role location purposes are being queried.
The Party's Contract Role Location Purpose contains purpose for the specific Party Address or Party Contact Method that the Party uses for this particular role.
The filter controls whether all active Party Role Location Purposes only, all inactive Party Role Location Purposes only or all Party Role Location Purposes (both active and inactive) is returned.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- Not applicable
- Inquiry levels
- Not applicable
- Filter values
- ACTIVE, INACTIVE, or ALL
Filter values must be provided in upper case.
- Transaction behavior
- Party Role Location Purpose records with an end date greater than the system date are considered to be Active. Party Role Location Purpose records with an end date less than or equal to the system date are deemed to be Inactive.
- Request message
- <InquiryType> getAllContractRoleLocationPurposes
<tcrmParam name= "contractRoleLocationId">
<tcrmParam name= "filter">
- Response objects
- TCRMContractRoleLocationPurposeBObj business objects
- Special note
- Not applicable