LogoLogo
WebsiteGitHubSlack
Integrated Beneficiary Registry v1.0.0
Integrated Beneficiary Registry v1.0.0
  • Integrated Beneficiary Registry and SP-MIS Interface
    • Introduction
    • Assumptions
    • Exception Handling
    • IBR with SP-MIS Standards
      • Process
        • PRS.IBR.01: SP-MIS queries the IBR to verify if a beneficiary is enrolled in a specific scheme
          • Example 1: Disability Cash Transfer Scheme
          • Example 2: Education Cash Transfer Scheme
        • PRS.IBR.02: SP-MIS publishes data on beneficiaries and the benefits that they have received
          • Example 1: Disability Cash Transfer Scheme
        • PRS.IBR.03: SP-MIS updates the IBR when the enrolment status of a beneficiary or household changes
          • Example 1: Disability Cash Transfer Scheme
        • PRS.IBR.04: IBR queries the social registry to request information needed for analysis
          • Example 1: Analysis of Disability Coverage of Social Protection Schemes
      • Data
        • Data Objects
          • DO.IBR.01 Beneficiary
          • DO.IBR.02 Programme
          • DO.IBR.03 Benefit
          • DO.IBR.O4 Benefit Frequency
          • DO.COM.02 Group
          • DO.COM.09 Member
        • Code Directory
          • CD.IBR.01 assistance_unit
          • CD.IBR.02 enrolment_status
          • CD.IBR.03 benefit_type
          • CD.IBR.04 institution_type
          • CD.IBR.05 legal_status
          • CD.IBR.06 social_protection_functions
          • CD.IBR.07 contribution_type
          • CD.IBR.08 programme_type
        • Data Types and Formats
          • DF.COM.STRING.01 date_time (Optional)
          • DF.COM.STRING.02 phone_number (Optional)
          • DT.COM.02 string
          • DT.COM.03 integer
          • DF.COM.STRING.08 currency
          • DT.COM.04 decimal
          • DT.COM.05 array
      • API
        • Design Principles
        • Versioning
        • Methods
          • API.COM.01 ASY Search (Async approach)
          • API.COM.01 SYN Search (Sync approach)
          • API.COM.02 Event Subscription
          • API.COM.03 Event Notification
          • API.COM.04 ASY Status (Async approach)
          • API.COM.04 SYN Status (Sync approach)
          • API.IBR.01 SYN Enrolment/updates
          • API.IBR.02 SYN Enrolled
    • Previous Versions
  • RESOURCES
    • Interoperability in Action #7
    • Standards Committee & Acknowledgments
Powered by GitBook
On this page
  • Description
  • Technical Definition
  • Applicability to this Interface and Examples

Was this helpful?

  1. Integrated Beneficiary Registry and SP-MIS Interface
  2. IBR with SP-MIS Standards
  3. API
  4. Methods

API.COM.03 Event Notification

Last updated 1 month ago

Was this helpful?

Description

The notify endpoint is to be implemented at the social protection system end to receive event data.

Technical Definition

The specification is the same as defined in the common space here:

.

Applicability to this Interface and Examples

It is also applicable to this interface, as outlined in the sample APIs at the bottom of each of the Process pages.

The examples are also consolidated technically here:

API.COM.03 Event Notification
DCI API's home page
Technical examples of the APIs based on the process use cases defined for this interface