User - OLT/ONU

Base URL: https://your-domain.com

Admin endpoints for managing OLT devices and ONU information. All endpoints require admin/staff authentication.

Fetch All OLTs

Retrieve all OLT devices configured in the system.

Property	Value
Endpoint	Fetch All OLTs
Method	`GET`
URL	`/api/v1/olts`
Authentication	Bearer Token

Request Headers:

Header	Value	Required
`Accept`	`application/json`	Yes
`Authorization`	`Bearer your-auth-token`	Yes

Request Body: None

Success Response (200 OK):

json

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "OLT-Main",
            "ip_address": "192.168.1.1",
            "type": "huawei",
            "status": "online",
            "onu_count": 150,
            "last_sync": "2024-01-15 10:30:00"
        }
    ]
}

Error Response (401 Unauthorized):

json

{
    "success": false,
    "message": "Unauthenticated"
}

Get OLT By Id

Retrieve details of a specific OLT device.

Property	Value
Endpoint	Get OLT By Id
Method	`GET`
URL	`/api/v1/olts/{id}`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	OLT ID

Success Response (200 OK):

json

{
    "success": true,
    "data": {
        "id": 1,
        "name": "OLT-Main",
        "ip_address": "192.168.1.1",
        "port": 23,
        "username": "admin",
        "type": "huawei",
        "status": "online",
        "onu_count": 150,
        "created_at": "2024-01-01 00:00:00"
    }
}

Error Response (404 Not Found):

json

{
    "success": false,
    "message": "OLT not found"
}

Test OLT Connection

Test connectivity to an OLT device.

Property	Value
Endpoint	Test OLT Connection
Method	`POST`
URL	`/api/v1/olts/{id}/test-connection`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	OLT ID

Request Body: None

Success Response (200 OK):

json

{
    "success": true,
    "message": "Connection successful",
    "data": {
        "latency_ms": 25,
        "status": "online"
    }
}

Error Response (500 Server Error):

json

{
    "success": false,
    "message": "Connection failed: Timeout"
}

Discover ONUs On OLT

Discover and sync ONUs connected to an OLT.

Property	Value
Endpoint	Discover ONUs
Method	`POST`
URL	`/api/v1/olts/{id}/discover-onus`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	OLT ID

Success Response (200 OK):

json

{
    "success": true,
    "message": "Discovery completed",
    "data": {
        "total_onus": 150,
        "new_onus": 5,
        "updated_onus": 145
    }
}

Fetch All ONUs

Retrieve all ONUs with optional pagination.

Property	Value
Endpoint	Fetch All ONUs
Method	`GET`
URL	`/api/v1/onus`
Authentication	Bearer Token

Query Parameters:

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (default: 50)
`olt_id`	integer	No	Filter by OLT
`status`	string	No	Filter by status (online, offline, critical)

Success Response (200 OK):

json

{
    "success": true,
    "data": {
        "onus": [
            {
                "id": 1,
                "serial_number": "HWTC12345678",
                "olt_id": 1,
                "subscriber_id": 1,
                "subscriber_name": "John Doe",
                "rx_power": -18.5,
                "tx_power": 2.1,
                "status": "online",
                "last_seen": "2024-01-15 10:30:00"
            }
        ],
        "total": 150
    }
}

Fetch Critical ONUs

Retrieve ONUs with critical signal levels or issues.

Property	Value
Endpoint	Fetch Critical ONUs
Method	`GET`
URL	`/api/v1/onus/critical`
Authentication	Bearer Token

Success Response (200 OK):

json

{
    "success": true,
    "data": [
        {
            "id": 5,
            "serial_number": "HWTC87654321",
            "subscriber_name": "Jane Doe",
            "rx_power": -28.5,
            "issue": "Low RX Power",
            "status": "critical"
        }
    ]
}

Get ONU By Id

Retrieve details of a specific ONU.

Property	Value
Endpoint	Get ONU By Id
Method	`GET`
URL	`/api/v1/onus/{id}`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	ONU ID

Success Response (200 OK):

json

{
    "success": true,
    "data": {
        "id": 1,
        "serial_number": "HWTC12345678",
        "olt_id": 1,
        "olt_name": "OLT-Main",
        "subscriber_id": 1,
        "subscriber_name": "John Doe",
        "rx_power": -18.5,
        "tx_power": 2.1,
        "temperature": 45,
        "voltage": 3.3,
        "status": "online",
        "uptime": "15 days",
        "last_seen": "2024-01-15 10:30:00"
    }
}

Get ONU Signal History

Retrieve signal history for an ONU over a specified time period.

Property	Value
Endpoint	Get ONU Signal History
Method	`GET`
URL	`/api/v1/onus/{id}/signal-history`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	ONU ID

Query Parameters:

Parameter	Type	Required	Description
`hours`	integer	No	Hours of history (default: 24)

Success Response (200 OK):

json

{
    "success": true,
    "data": [
        {
            "timestamp": "2024-01-15 10:00:00",
            "rx_power": -18.5,
            "tx_power": 2.1
        },
        {
            "timestamp": "2024-01-15 09:00:00",
            "rx_power": -18.3,
            "tx_power": 2.0
        }
    ]
}

Refresh ONU Metrics

Refresh metrics for a single ONU.

Property	Value
Endpoint	Refresh ONU Metrics
Method	`POST`
URL	`/api/v1/onus/{id}/refresh-metrics`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	ONU ID

Success Response (200 OK):

json

{
    "success": true,
    "message": "Metrics refreshed",
    "data": {
        "rx_power": -18.5,
        "tx_power": 2.1,
        "status": "online"
    }
}

Bulk Refresh ONU Metrics

Refresh metrics for multiple ONUs at once.

Property	Value
Endpoint	Bulk Refresh ONU Metrics
Method	`POST`
URL	`/api/v1/onus/bulk-refresh`
Authentication	Bearer Token

Request Headers:

Header	Value	Required
`Content-Type`	`application/json`	Yes
`Accept`	`application/json`	Yes
`Authorization`	`Bearer your-auth-token`	Yes

Request Body:

json

{
    "onu_ids": [1, 2, 3]
}

Parameter	Type	Required	Description
`onu_ids`	array	Yes	Array of ONU IDs to refresh

Success Response (200 OK):

json

{
    "success": true,
    "message": "Bulk refresh completed",
    "data": {
        "refreshed": 3,
        "failed": 0
    }
}

OLT Management (CRUD)

The following endpoints use the /api/v1/olt/ prefix (new CRUD controller). The legacy read-only endpoints above use /api/v1/olts/ and /api/v1/onus/.

Fetch All OLTs (CRUD)

Property	Value
Method	`GET`
URL	`/api/v1/olt`
Authentication	Bearer Token

Query Parameters:

Parameter	Type	Required	Description
`isp_id`	integer	Yes	ISP ID
`branch_id`	integer	Yes	Branch ID

Fetch OLT (CRUD)

Property	Value
Method	`GET`
URL	`/api/v1/olt/{id}`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`id`	integer	Yes	OLT ID

Create OLT

Property	Value
Method	`POST`
URL	`/api/v1/olt`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "name": "OLT-01",
    "ip_address": "192.168.1.1",
    "vendor_id": 1
}

Update OLT

Property	Value
Method	`PUT`
URL	`/api/v1/olt/{id}`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "name": "OLT-01 Updated"
}

Delete OLT

Property	Value
Method	`DELETE`
URL	`/api/v1/olt/{id}`
Authentication	Bearer Token

Query Parameters:

Parameter	Type	Required	Description
`isp_id`	integer	Yes	ISP ID
`branch_id`	integer	Yes	Branch ID
`user_id`	integer	Yes	Acting user ID

Get ONUs By OLT

List all ONUs belonging to a specific OLT.

Property	Value
Method	`GET`
URL	`/api/v1/olt/{oltId}/onus`
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
`oltId`	integer	Yes	OLT ID

ONU Management (CRUD)

The following endpoints use the /api/v1/onu/ prefix (new CRUD controller).

Fetch All ONUs (CRUD)

Property	Value
Method	`GET`
URL	`/api/v1/onu`
Authentication	Bearer Token

Query Parameters:

Parameter	Type	Required	Description
`isp_id`	integer	Yes	ISP ID
`branch_id`	integer	Yes	Branch ID

Fetch ONU (CRUD)

Property	Value
Method	`GET`
URL	`/api/v1/onu/{id}`
Authentication	Bearer Token

Create ONU

Property	Value
Method	`POST`
URL	`/api/v1/onu`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "olt_id": 1,
    "mac_address": "AA:BB:CC:DD:EE:FF",
    "serial_number": "SN001"
}

Update ONU

Property	Value
Method	`PUT`
URL	`/api/v1/onu/{id}`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "serial_number": "SN001-updated"
}

Delete ONU

Property	Value
Method	`DELETE`
URL	`/api/v1/onu/{id}`
Authentication	Bearer Token

Assign Subscriber to ONU

Map a subscriber to an ONU device.

Property	Value
Method	`POST`
URL	`/api/v1/onu/{id}/assign-subscriber`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "subscriber_id": 1
}

Unassign Subscriber from ONU

Remove the subscriber mapping from an ONU device.

Property	Value
Method	`POST`
URL	`/api/v1/onu/{id}/unassign-subscriber`
Authentication	Bearer Token

Request Body:

json

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1
}

User - OLT/ONU ​

Fetch All OLTs ​

Get OLT By Id ​

Test OLT Connection ​

Discover ONUs On OLT ​

Fetch All ONUs ​

Fetch Critical ONUs ​

Get ONU By Id ​

Get ONU Signal History ​

Refresh ONU Metrics ​

Bulk Refresh ONU Metrics ​

OLT Management (CRUD) ​

Fetch All OLTs (CRUD) ​

Fetch OLT (CRUD) ​

Create OLT ​

Update OLT ​

Delete OLT ​

Get ONUs By OLT ​

ONU Management (CRUD) ​

Fetch All ONUs (CRUD) ​

Fetch ONU (CRUD) ​

Create ONU ​

Update ONU ​

Delete ONU ​

Assign Subscriber to ONU ​

Unassign Subscriber from ONU ​

User - OLT/ONU

Fetch All OLTs

Get OLT By Id

Test OLT Connection

Discover ONUs On OLT

Fetch All ONUs

Fetch Critical ONUs

Get ONU By Id

Get ONU Signal History

Refresh ONU Metrics

Bulk Refresh ONU Metrics

OLT Management (CRUD)

Fetch All OLTs (CRUD)

Fetch OLT (CRUD)

Create OLT

Update OLT

Delete OLT

Get ONUs By OLT

ONU Management (CRUD)

Fetch All ONUs (CRUD)

Fetch ONU (CRUD)

Create ONU

Update ONU

Delete ONU

Assign Subscriber to ONU

Unassign Subscriber from ONU