LogoLogo
WebsiteGitHubSlack
Farmers Registry v1.0.0
Farmers Registry v1.0.0
  • Farmers Registry and SP-System Interface
    • Introduction
    • Assumptions
    • Exception Handling
    • FR with SP-Systems Standards
      • Process
        • PRS.FR.01: SP-System queries the FR to request farmer details for potential programme enrolment
          • Example 1: Farmer Shock Relief Programme
          • Example 2: Farmer Voucher Issuance Programme
        • PRS.FR.02: SP system connects to farmer registry to confirm eligibility
          • Example 1: Farmer Child Scholarship Programme
      • Data
        • Data Objects
          • DO.FR.01 Farmer
          • DO.FR.02 FarmInfo
          • DO.FR.03 FarmingActivities
          • DO.FR.04 CropDetails
          • DO.FR.05 LivestockDetails
          • DO.FR.06 Machinery
          • DO.SR.03 Member
          • DO.SR.02 Group
        • Code Directory
          • CD.FR.01 CropTypeEnum
          • CD.FR.02 CropsEndUse
          • CD.FR.03 LandTenureEnum
          • CD.FR.04 MeasurementUnitEnum
          • CD.FR.05 FarmTypeEnum
          • CD.FR.06 MachineriesEnum
          • CD.FR.07 AnimalsEnum
          • CD.FR.08 Aquaculture
          • CD.FR.09 AgriSupportActivities
          • CD.FR.10 AquaSupportActivities
          • CD.FR.11 FertiliserType
          • CD.FR.12 LivestockSystem
          • CD.FR.13 EquipmentSource
          • CD.FR.14 IrrigationWater
          • CD.FR.15 CropActivities
          • CD.FR.16 ForestActivities
        • 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.FR.01 ASY Search (Async approach)
          • API.FR.01 SYN Search (Sync approach)
          • API.FR.02 Event Subscription
          • API.FR.03 Event Notification
    • Previous Versions
  • RESOURCES
    • Interoperability in Action #4
    • Standards Committee & Acknowledgments
Powered by GitBook
On this page
  • Description
  • Applicability to this Interface and Examples

Was this helpful?

  1. Farmers Registry and SP-System Interface
  2. FR with SP-Systems Standards
  3. API
  4. Methods

API.FR.02 Event Subscription

Last updated 1 month ago

Was this helpful?

Description

The subscriber APIs help to define endpoints that facilitate the receipt of subscribe/unsubscribing events from the registry. The notify endpoint is to be implemented at the SP system end to receive event data.

API definition link:

Please refer to GitHub for object definitions:

Note: For any changes kindly raise pull request on .

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:

/subscribe
https://github.com/spdci/schemas/tree/main/extensions/fr/v1
github
DCI APIs - FR process flow examples