getAllContractRoleLocations
- Description
- This inquiry transaction returns all contract role locations for a given contract role, based on a filter.
- Web Services
- Operation name: getAllContractRoleLocationPurposes
- Example
- Retrieve all locations (party addresses) associated with John Smith's role of Owner on contract 123456.
- Usage information
- The input to this transaction is the contract role ID whose role
locations are being queried.
The Party's Contract Role Location contains the specific Party Address or Party Contact Method that the Party uses for this particular role.
The filter controls whether all active Party Role Locations information only, all inactive Party Role Location information only or all Party Role information (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 records with an end date greater than the system date are considered to be Active. Party Role Location records with an end date less than or equal to the system date are deemed to be Inactive.
- Request message
- <InquiryType> getAllContractRoleLocations
<tcrmParam name= "contractRoleId">
<tcrmParam name= "filter">
- Response objects
- TCRMContractRoleLocationBObj business objects with associated TCRMPartyContactMethodBObj and TCRMPartyAddressBObj
- Special note
- Not applicable