Search Capabilities
The Consent Management Microservice provides a set of APIs that allows the customers to approve a consent, to retrieve or search account information details based on certain predefined criteria(s). Following are the two categories of APIs.
Retrieve API
The Retrieve APIs narrow down to a unique consent type or very small set of consents.
Search API
The search APIs potentially narrow down to a larger set of consents, depending on the criteria and the distribution of the various consent data (Consent Id, Master Consent Id, App id, TermConditions codes, and so on.)
The response details and the response time for these APIs will vary from one category to another. Following are the Retrieve API and Search API.
getMasterConsent
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Consent master Id | consentMasterId | Equals |
Query Option Rules
consentMasterId:
Optional Query Param: When appropriate consentMasterId, It displays particular data specific to master id. Otherwise displays all master consents id.
Refer to Swagger documentation for the Payload details of the API.
getConsentType
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Consent types Id | consentMasterId |
Equals |
| consentTypeId | Equals |
Query Option Rules
consentMasterId:
Mandatory Query Param: To be included to find the consent types id in that particular consentmasterId.
consentTypeId:
- Mandatory Query Param: To be included to find the consent types id in that particular consentmasterId.
- Optional Query Param: Retrieves a set of consent types of same type, if specified and all types it not specified.
Refer to Swagger documentation for the Payload details of the API.
getApps
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| App List | appId |
Equals |
Query Option Rules
appId:
Optional Query Param: Retrieves the particular app record if specified, all app records if not specified in query param.
Refer to Swagger documentation for the Payload details of the API.
getTermNConditionsCodes
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Condition Codes | termNConditionsCode |
Equals |
Query Option Rules
termNConditionsCode:
Optional Query Param: Retrieves a particular condition code id record for a consent type, if specified. All records of terms condition code, if not specified.
Refer to Swagger documentation for the Payload details of the API.
getTermNConditionsApps
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| App Id | termNConditionAppsId |
Equals |
| appId | Equals | |
| termConditionCodeId | Equals |
Query Option Rules
termNConditionAppsId, appId, termConditionCodeId:
Optional Query Param: If specified, retrieves record of particular app id. All records of app ids, if not specified.
Refer to Swagger documentation for the Payload details of the API.
getTermNConditionContent
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Condition Content id | termsNConditionContentId |
Equals |
Query Option Rules
termsNConditionContentId:
Optional Query Param: Retrieves all the records from TermsNConditionContent , if not specified. If specified, retrieves only particular condition content id’s record.
Refer to Swagger documentation for the Payload details of the API.
getActiveTermNConditionContent
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Active condition content id | termConditionAppsId |
Equals |
Query Option Rules
termConditionAppsId:
Mandatory Query Param: Retrieves all the active records from TermsNConditionContent table for a given condition app id.
Refer to Swagger documentation for the Payload details of the API.
getPartyConsentDetailsByPartyConsentId
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Consent Details | partyId |
Equals |
| partyConsentId | Equals |
Query Option Rules
partyid:
Mandatory Query Param : Retrieves all the records of party consent details.
partyConsentId:
Optional Query Param: Retrieves all consent id records of specified part id.
Refer to Swagger documentation for the Payload details of the API.
getPartyConsentDetailsByCriteria
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Consent Details | applicationId |
Equals |
| backendIdentifier | Equals | |
| externalUserId | Equals | |
| partyConsentId | Equals | |
| partyId | Equals |
Query Option Rules
applicationId, backendIdentifier, externalUserId, partyConsentId, partyId:
Optional Query params: Retrieves the information of party’s consent details.
Refer to Swagger documentation for the Payload details of the API.
getConsentTypeDetails
Query Options
| Retrieve Criteria | Query By | Operator |
|---|---|---|
| Consent Type details | consentDetailsId |
Equals |
| partyConsentId | Equals |
Query Option Rules
partyConsentId:
Mandatory Query Param: All the records from ConsentTypeDetails are displayed .
consentDetailsId:
Optional Query Param: Retrieves particular consent type details based on this value.
Refer to Swagger documentation for the Payload details of the API.
In this topic