Enumerations

This page defines all enumerated values used in OAF-100.

Address Enumerations

Street Direction

Valid values for address.streetDirection:

• N - North
• S - South
• E - East
• W - West
• NE - Northeast
• NW - Northwest
• SE - Southeast
• SW - Southwest

Street Type

The address.streetType field accepts common street type designations. This is an open string field that accommodates various formats and abbreviations (e.g., "Street", "St", "ST", "Avenue", "Ave", "AV").

Street Suffix

The address.streetSuffix field accepts street suffix designations such as extensions, spurs, loops, and service roads. This is an open string field that accommodates various formats.

Subunit Type

The address.subunitType field accepts common subunit designations. This is an open string field that accommodates various formats and abbreviations (e.g., "Apartment", "Apt", "APT", "Suite", "Ste", "STE", "Unit", "Building", "Bldg").

Serviceability Status

Valid values for fiberAccessDetails.serviceability.status:

• PLANNED - Future build location
• CONSTRUCTION - Active construction
• ACTIVE - Service available
• INACTIVE - Temporarily unavailable
• CANCELLED - Build cancelled (terminal state)
• RETIRED - Permanently removed (terminal state)

Group Types

Address Group Types

Valid values for address group type:

• MDU_COMPLEX - Multi-dwelling unit complex

Location Group Types

Valid values for location group type:

• OTHER - General purpose grouping

Event Types

Valid values for event.type:

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

Fiber Access Details

Layer 2 Access Protocol

Valid values for fiberAccessDetails.layer2AccessProtocol:

• GPON - Gigabit-capable Passive Optical Network
• EPON - Ethernet Passive Optical Network
• XGS-PON - 10-Gigabit-capable Symmetric Passive Optical Network
• XGPON - 10-Gigabit-capable Passive Optical Network
• NGPON2 - Next Generation Passive Optical Network 2
• ETHERNET - Direct Ethernet connection
• OTHER - Other protocol type

Drop Status

Valid values for fiberAccessDetails.dropStatus:

• NO_DROP - No drop installed
• AERIAL_COMPLETE - Aerial drop installation completed
• UNDERGROUND_COMPLETE - Underground drop installation completed
• TEMP_DROP - Temporary drop installed

Export Formats

Valid values for export format:

• json - JSON format (default)
• csv - Comma-separated values format