Implementation Guide

Integration Overview

OAF-100 facilitates data synchronization between parties through:

• Real-time event delivery via webhooks
• Bulk data export for initial synchronization and reconciliation
• Count verification endpoints for data integrity monitoring

Key Concepts

Location Identifiers

All locations use UUID identifiers generated by the network operator. These identifiers are permanent and never reused.

Location Groups

Related locations (e.g., units in an apartment building) share a common locationGroup.id. All locations in a group should maintain consistent group metadata.

Event Processing

Events follow an at-least-once delivery model. Recipients must handle potential duplicate deliveries using the event ID for deduplication.

Data Synchronization

The typical synchronization flow involves:

1. Initial bulk export to establish baseline
2. Ongoing webhook events for real-time updates
3. Periodic count verification to detect drift
4. Reconciliation via bulk export when needed

Complete Data Synchronization Workflow

Status Transitions

Locations follow a defined lifecycle:

Terminal states (CANCELLED, RETIRED) cannot transition to other states.