Introduction
Weimarnetz Registrator is a RESTful microservice for managing node number in our network. See https://wireless.subsignal.org/index.php?title=IP-System for more details.
Overview
HTTP verbs
Weimarnetz Registrator tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs. To also support simple solutions like wget we wrap some verbs in GET requests.
| Verb | Usage |
|---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
HTTP status codes
Weimarnetz Registrator tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
| Status code | Usage |
|---|---|
|
Standard response for successful HTTP requests. |
The actual response will depend on the request method used. |
In a GET request, the response will contain an entity corresponding to the requested resource. |
In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
|
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
|
Resources
Time
Just returns the current server time.
Curl request
Snippet curl-request not found for operation::time
HTTP request
Snippet http-request not found for operation::time
HTTP response
Snippet http-response not found for operation::time
Response body
Snippet response-body not found for operation::time
Response fields
Snippet response-fields not found for operation::time
Node
The Node resource is used to get a Node.
Curl request
Snippet curl-request not found for operation::queryNodes
HTTP request
Snippet http-request not found for operation::queryNodes
HTTP response
Snippet http-response not found for operation::queryNodes
Response body
Snippet response-body not found for operation::queryNodes
Response fields
Snippet response-fields not found for operation::queryNodes
Nodes
The Nodes resource is used to get a list of Nodes.
Curl request
Snippet curl-request not found for operation::queryAllNodes
HTTP request
Snippet http-request not found for operation::queryAllNodes
HTTP response
Snippet http-response not found for operation::queryAllNodes
Response body
Snippet response-body not found for operation::queryAllNodes
Response fields
Snippet response-fields not found for operation::queryAllNodes
Node by mac address
This resource is used to get a Node identified by a mac address.
Curl request
Snippet curl-request not found for operation::queryNodeByMac
HTTP request
Snippet http-request not found for operation::queryNodeByMac
HTTP response
Snippet http-response not found for operation::queryNodeByMac
Response body
Snippet response-body not found for operation::queryNodeByMac
Response fields
Snippet response-fields not found for operation::queryNodeByMac
Add node
Adding a node returns the full node object
Curl request
Snippet curl-request not found for operation::addNode
HTTP request
Snippet http-request not found for operation::addNode
HTTP response
Snippet http-response not found for operation::addNode
Response body
Snippet response-body not found for operation::addNode
Response fields
Snippet response-fields not found for operation::addNode
Add node via GET
Adding a node returns the full node object
Curl request
Snippet curl-request not found for operation::addNodeViaGet
HTTP request
Snippet http-request not found for operation::addNodeViaGet
HTTP response
Snippet http-response not found for operation::addNodeViaGet
Response body
Snippet response-body not found for operation::addNodeViaGet
Response fields
Snippet response-fields not found for operation::addNodeViaGet
Add node with given node number
Adding a node returns the full node object
Curl request
Snippet curl-request not found for operation::addGivenNodeNumber
HTTP request
Snippet http-request not found for operation::addGivenNodeNumber
HTTP response
Snippet http-response not found for operation::addGivenNodeNumber
Response body
Snippet response-body not found for operation::addGivenNodeNumber
Response fields
Snippet response-fields not found for operation::addGivenNodeNumber
Update node
Updating a node returns the full node object
Curl request
Snippet curl-request not found for operation::updateNode
HTTP request
Snippet http-request not found for operation::updateNode
HTTP response
Snippet http-response not found for operation::updateNode
Response body
Snippet response-body not found for operation::updateNode
Response fields
Snippet response-fields not found for operation::updateNode
Update node via GET
Updating a node returns the full node object
Curl request
Snippet curl-request not found for operation::updateNodeViaGet
HTTP request
Snippet http-request not found for operation::updateNodeViaGet
HTTP response
Snippet http-response not found for operation::updateNodeViaGet
Response body
Snippet response-body not found for operation::updateNodeViaGet
Response fields
Snippet response-fields not found for operation::updateNodeViaGet
Delete a node
Delete a node from the database, needs authentication
Curl request
Snippet curl-request not found for operation::deleteNode
HTTP request
Snippet http-request not found for operation::deleteNode
HTTP response
Snippet http-response not found for operation::deleteNode
Response body
Snippet response-body not found for operation::deleteNode
Dump complete database
Dumps the complete database, needs authentication
Curl request
Snippet curl-request not found for operation::dumpDatabase
HTTP request
Snippet http-request not found for operation::dumpDatabase
HTTP response
Snippet http-response not found for operation::dumpDatabase
Response fields
Snippet response-fields not found for operation::dumpDatabase
Import database
Imports the complete database, needs authentication. Existing entries will be updated.
Curl request
Snippet curl-request not found for operation::importDatabase
HTTP request
Snippet http-request not found for operation::importDatabase
HTTP response
Snippet http-response not found for operation::importDatabase
Request fields
Snippet request-fields not found for operation::importDatabase