Enterprise APIs
Following are the list of APIs supported by the Consent Management Microservice.
Version 1.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| ConsentManager | createConsent | /holdings/parties/{partyid}/consentypes/{type}/consents | Creates a new Consent. |
| getConsents | /holdings/parties/{partyid}/consentypes/{type}/consents | Retrieves the Consent details. | |
| updateConsent | /holdings/parties/{partyid}/consentypes/{type}/revokeconsent: | Updates the existing Consent details. |
To view the complete APIs specification, refer to the Service Spec (Swagger) and the Swagger JSON file.
Version 2.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| MasterConsent | createMasterConsentV2 | /reference/masterConsent/{masterConsentId} | Creates a new record in MasterConsent table. |
| getMasterConsentV2 | reference/masterConsents | Get all the records from MasterConsent table. | |
| /reference/masterConsents?consentMasterId={masterConsentId} | Get the record with specified ID from the MasterConsent. | ||
| updateMasterConsentV2 | /reference/masterConsent/{masterConsentId} | Updates an existing record in MasterConsent table. | |
| ConsentType | createConsentTypeV2 | /reference/consentTypes/{consentTypeId} | Creates a new record in ConsentType table. |
| getConsentTypeV2 | /reference/masterConsent/{consentMasterId}/consentTypes | Get all the records from ConsentType table, for a particular masterConsentId. | |
| updateConsentTypeV2 | /reference/consentTypes/{consentTypeId} | Updates an existing record in ConsentType table. | |
| TermConditionCode | createTermNConditionsCodeV2 | /reference/termNConditionsCode | Creates a new record in TermConditionCode table. |
| getTermNConditionsCodesV2 | /reference/termsNConditionsCodes | Get all the records from TermConditionCode table. | |
| /reference/termsNConditionsCodes?termNConditionCode={termConditionCode} | Get the records by specified termCondCodeId or termConditionCode. In the URL parameter can be sent multiple ids/codes separated by space. | ||
| updateTermNConditionsCodeV2 | /reference/termNConditionsCode/{termNConditionsCodeId} | Update an existing record in TermConditionCode table. The URL parameter can be termCondCodeId or termConditionCode. | |
| TermNConditionApps | createTermNConditionsPerAppV2 | /reference/termsConditionsApps/{termCondCodeOrAppId} | Creates a new record in TermNCondtionApps table. |
| getTermNConditionsAppsV2 | /reference/termsConditionsApps | Get all the records from TermNCondtionApps table. | |
| updateTermNConditionsAppInactiveV2 | /reference/termsConditionsApps/{termCondCodeOrAppId} | Updates an existing record in TermNCondtionApps table. | |
| ConsentTypeDetails | createConsentTypeDetailsV2 | /holdings/partyConsents/{partyConsentId}/consentTypeDetails | Creates a new record in ConsentTypeDetails table. |
| getConsentTypeDetailsV2 | /holdings/partyConsents/{partyConsentId}/consentTypeDetails | Get all the records from ConsentTypeDetails table. | |
| updateConsentTypeDetailsV2 | /holdings/partyConsents/{partyConsentId}/consentTypeDetails/{consentDetailsId} | Updates an existing record in ConsentTypeDetails table. | |
| PartyConsentDetails | createPartyConsentDetailsV2 | /reference/masterConsent/{consentMasterId} | Creates a new record in PartyConsentDetails table. |
| getPartyConsentDetailsByCriteria | /holdings/parties/partyConsentDetails |
Get PartyConsentDetails by passing either of the following as a parameter:
|
|
| getPartyConsentDetailsByPartyConsentIdV2 | /reference/masterConsents | Get all the records from PartyConsentDetails table. | |
| updatePartyConsentDetailsV2 | /reference/masterConsent/{consentMasterId} | Updates an existing record in PartyConsentDetails table. | |
| InfinityApps | createInfinityAppV2 | /reference/app/{appId} | Creates a new record in InfinityApps table. |
| getAppsV2 | /reference/appsLists | Get all the records from InfinityApps table. | |
| updateInfinityAppV2 | /reference/app/{appId} | Updates an existing record in InfinityApps table. | |
| TermsNConditionContent | createTermNConditionContentV2 | /reference/termsConditionsContents/{termConditionAppsId} | Creates a new record in TermsNConditionContent table |
| getTermNConditionContentV2 | /holdings/termsConditionsContents | Get all the records from TermsNConditionContent table. | |
| getActiveTermNConditionContentV2 | /holdings/termsConditionsContents/active/{termConditionAppsId} | Get the list of active records from TermsNConditionContent table. | |
| deleteTermNConditionContentV2 | /reference/deleteTermsConditionsContents/{termsNConditionContentId} | Delete a record in TermsNConditionContent table. |
To view the complete APIs specification, refer to the Service Spec (Swagger) and the Swagger JSON file.
Field Name
|
Application/Table name
In this topic