OAF-100 Location Exchange Overview

OAF-100 Location Exchange enables standardized communication of location information between network operators and Retail Service Providers (RSPs) in open access networks. Typically, where the network operator owns the resource and communicates the records to the RSP.

API Endpoints

Core Resources

Endpoint	Method	Description
/locations/{id}	GET	Retrieve a specific location
/locations/statistics	GET	Get aggregated location counts
/locations/exports	POST	Create bulk export request
/locations/exports/{id}	GET	Check export status
/address-groups/{id}	GET	Retrieve address group details
/location-groups/{id}	GET	Retrieve location group details

Webhook Endpoints (RSP-implemented)

Endpoint	Method	Description
{rsp_url}/locations/events	POST	Receive location change notifications
{rsp_url}/locations/exports/events	POST	Receive export completion notifications

Data Model

Location Object

Locations use a composable design with required core fields and optional sub-objects:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-01T10:30:00Z",
  "updatedAt": "2025-06-08T14:22:00Z",
  "locationGroupId": "UUID (optional)",
  
  "geography": {                    // REQUIRED
    "country": "US",
    "region": "TX",
    "locality": "AUSTIN",
    "postalCode": "78701"
  },
  
  "address": {                      // OPTIONAL (but at least one of address or coordinates required)
    "streetNumber": "1234",
    "streetDirection": "N",
    "streetName": "CONGRESS",
    "streetType": "AVENUE"
  },
  
  "coordinates": {                  // OPTIONAL (but at least one of address or coordinates required)
    "latitude": 30.2672,
    "longitude": -97.7431
  },
  
  "fiberAccessDetails": {           // OPTIONAL
    "circuitId": "CKT-78701-001",
    "serviceability": {             // OPTIONAL
      "status": "ACTIVE",
      "availableDate": "2025-06-01"
    }
  }
}

Group Objects

Groups are simple identifiers:

// Address Group (for MDUs)
{
  "id": "UUID",
  "name": "Riverside Apartments",
  "type": "MDU_COMPLEX"
}

// Location Group (for any business grouping)
{
  "id": "UUID",
  "name": "Downtown Service Area",
  "type": "OTHER"
}

Key Concepts

Serviceability Status

• PLANNED - Future build location
• CONSTRUCTION - Active build in progress
• ACTIVE - Ready for service
• INACTIVE - Temporarily unavailable
• CANCELLED - Build cancelled (terminal)
• RETIRED - Permanently removed (terminal)

Event Types

• LOCATION_CREATED - New location added
• LOCATION_UPDATED - Existing location modified

Data Synchronization

1. Real-time: Webhook events for immediate updates
2. Bulk: Export endpoints for full dataset synchronization
3. Verification: Statistics endpoint to validate data integrity

Next Steps

• Resources - Detailed endpoint documentation
• Implementation Guide - Integration best practices