ORAH API Documentation
Authentication
POST
/api/auth/token
Obtain OAuth token from OpenReach
GET
/api/auth/status
Check authentication status
NOI Management
POST
/api/noi
Create a new NOI
GET
/api/noi/:id
Get NOI by reference (e.g., PIANOI000000000001)
DELETE
/api/noi/:id
Cancel an NOI
Inventory
GET
/api/inventory/postcode/:type/:postcode?offset=500
Query inventory by postcode. Type: duct or structure
GET
/api/inventory/coordinate/:type?lat=X&lon=Y&gridType=BNG&offset=500
Query inventory by coordinates. gridType: BNG, IG, or LONGLAT
Whereabouts
POST
/api/whereabouts
Create whereabouts record
GET
/api/whereabouts/:id
Get whereabouts by ID
PATCH
/api/whereabouts/:id
Update whereabouts
DELETE
/api/whereabouts/:id
Cancel whereabouts
Lead-In
POST
/api/leadin
Create lead-in
GET
/api/leadin/:id
Get lead-in by ID
DELETE
/api/leadin/:id
Cancel lead-in
Orders
POST
/api/order
Create PIA order
GET
/api/order/:id
Get order by ID
GET
/api/bom/:noiReference
Request Bill of Materials for NOI
Webhooks
POST
/webhook/callback
Webhook receiver endpoint (configure in OpenReach)
GET
/webhook/api/list
List received webhooks
GET
/webhook/api/stats
Get webhook statistics