Introduction
As at 1.12.8 we have introduced the Connections endpoint.
How Does it Work?
Creating a Connection
To make another network go to menu -> Admin -> Connections -> Create Connection.
View Connection Details
Go to menu -> Admin -> Connections -> List Connections.
You will see a list of connections. You can view a connection by clicking on the it's ID (in green). You can also edit or delete the network.
Connections are stored in the database in the "oa_connection" table. A typical entry will look as below.
id: 5
org_id: 0
name: Marks Home Connection
provider: Telstra 23
service_type: Cable
product_name: Bigpond Cable Ultimate
service_identifier:
speed: 100.000
location_id_a: 2
location_id_b: 2
system_id_a: 0
system_id_b: 0
line_number_a:
line_number_b:
ip_address_external_a:
ip_address_external_b:
ip_address_internal_a:
ip_address_internal_b:
API / Web Access?
You can access the /connections collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
API Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
|---|---|---|---|---|---|
| GET | n | collection | /connections | Returns a list of connections. | |
| GET | y | read | /connections/{id} | Returns a connection's details. | |
| PATCH | y | update | /connections/{id} | Update an attribute of a connections entry. | |
| POST | n | create | /connections | Insert a new connections entry. | |
| DELETE | y | delete | /connections/{id} | Delete a connections entry. |
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
|---|---|---|---|---|---|
| GET | n | create | create_form | /connections/create | Displays a standard web form for submission to POST /connections. |
| GET | y | update | update_form | /connections/{id}/update | Show the connection's details with the option to update attributes using PATCH to /connections/{id} |