Scribd
Upload
4 views

API Documentation Without Table

Uploaded by

Jonas Nijs
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
4 views

API Documentation Without Table

Uploaded by

Jonas Nijs
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

API Documentation with JSON Examples

Endpoint: /api/GetClientStatus

Method: GET
Description: Get the status of all clients
JSON Example:
No JSON example available

Endpoint: /api/GetRights

Method: GET
Description: Get the rights of the current user
JSON Example:
No JSON example available

Endpoint: /api/Heartbeats

Method: GET
Description: Get all heartbeats
JSON Example:
No JSON example available

Endpoint: /api/add/Installation

Method: POST
Description: Add a new installation
JSON Example:
{"Name": "New Installation"}

Endpoint: /api/add/Client

Method: POST
Description: Add a new client
JSON Example:
{"Name": "New Client"}

Endpoint: /api/add/Plugin

Method: POST
Description: Add a new plugin
JSON Example:
{"Version": "1.0.0"}

Endpoint: /api/add/Users

Method: POST
Description: Add a new user
JSON Example:
{"Username": "newuser", "Password": "password"}

Endpoint: /api/add/Devices

Method: POST
Description: Add a new device
JSON Example:
{"Unique_ID": "12345"}

Endpoint: /api/change/Client

Method: POST
Description: Change client details
JSON Example:
{"ID": "1", "Name": "Updated Client"}

Endpoint: /api/change/Installation

Method: POST
Description: Change installation details
JSON Example:
{"ID": "1", "Name": "Updated Installation"}

Endpoint: /api/change/Devices

Method: POST
Description: Change device details
JSON Example:
{"ID": "1", "Unique_ID": "67890"}

Endpoint: /api/change/Users

Method: POST
Description: Change user details
JSON Example:
{"ID": "1", "Username": "updateduser"}

Endpoint: /api/delete/Devices

Method: POST
Description: Delete a device
JSON Example:
{"ID": "1"}

Endpoint: /api/delete/Plugin

Method: POST
Description: Delete a plugin
JSON Example:
{"ID": "1"}

Endpoint: /api/delete/Users

Method: POST
Description: Delete a user
JSON Example:
{"ID": "1"}

Endpoint: /api/delete/Installation

Method: POST
Description: Delete an installation
JSON Example:
{"ID": "1"}

Endpoint: /api/delete/Client

Method: POST
Description: Delete a client
JSON Example:
{"ID": "1"}

Endpoint: /api/get/Plugin

Method: GET
Description: Get plugin details
JSON Example:
No JSON example available

Endpoint: /api/get/Users

Method: GET
Description: Get user details
JSON Example:
No JSON example available

Endpoint: /api/login

Method: POST
Description: Login user
JSON Example:
{"Username": "user", "Password": "password"}

Endpoint: /api/refresh

Method: POST
Description: Refresh user token
JSON Example:
No JSON example available

Endpoint: /api/GetDevices

Method: POST
Description: Get devices for a client or installation
JSON Example:
{"Client": "client_id", "Installation": "installation_id"}

Endpoint: /api/GetInstallations

Method: POST
Description: Get installations for a client
JSON Example:
{"Client": "client_id"}

Endpoint: /api/GetInstallationStatus

Method: POST
Description: Get status of installations for a client
JSON Example:
{"Client": "client_name"}

Endpoint: /api/GetDevicesStatus

Method: POST
Description: Get status of devices for an installation
JSON Example:
{"Client": "client_name", "Installation": "installation_name"}

Endpoint: /api/V2/Heartbeat

Method: POST
Description: Post heartbeat data
JSON Example:
{"Device_ID": "device_id", "Device_Status": "status"}

Endpoint: /api/Logout

Method: POST
Description: Logout user
JSON Example:
No JSON example available

You might also like