Get Closed Principals (optional)
An endpoint to communicate principals which have ceased eligibility.
info
Please note that this endpoint is optional but if implemented allows for automated disconnection of CDR arrangements for Principals which have become ineligible.
Purposeβ
The purpose of this endpoint is to provide a schedule based list of principalId entries which represent users who are no longer eligible for data sharing.
Assumptionsβ
- GetClosedPrincipals is dependent on being defined in the GetEndpointMeta API response. Once returned in this response, Biza will perform that call at 10pm AEST daily.
- The request parameter will always occur 1 day prior. This field may be blank on the first run, and it is expected that all closed principals will be returned in that case.
- The
is-get-endpoint-meta-implementedflag must be switched on.
Data Adapter APIβ
Get Closed Principals (Optional)β
Loading...
Endpoint specific guidanceβ
- This endpoint is optional but if implemented allows for automated disconnection of CDR arrangements for Principals which have become ineligible.