User Guide¶

This guide provides instructions on how to use the Graph API Service.

Getting Started¶

Ensure the service is running.
Use the provided API endpoints to interact with the service.

API Endpoints¶

Neat Devices¶

POST /neatDevice/all/allDevices - Gets all devices
POST /neatDevice/all/totalDevices - Gets the total number of devices
POST /neatDevice/room/numDevicesConnected - Gets the number of connected devices
POST /neatDevice/all/devicesConnected - Gets a list of connected devices
POST /neatDevice/all/numOfDevicesByRoom - Gets the number of devices by room
POST /neatDevice/room/numOfRooms - Gets the number of rooms
POST /neatDevice/room/roomStatusCount - Gets the status count of rooms
POST /neatDevice/:devicesn - Gets a specific device by serial number
GET /neatDevice/all/devicesFilters - Gets device filters
POST /neatDevice/refresh/:devicesn - Refreshes a specific device by serial number

Filters¶

POST /filters/location - Gets location filters
POST /filters/region - Gets region filters
POST /filters/room - Gets room filters
GET /filters/neatdevices - Gets Neat devices filters

Intervals¶

POST /intervals/createTable - Creates the intervals table
GET /intervals - Gets all intervals
GET /intervals/:id - Gets interval by ID
POST /intervals - Creates a new interval
PUT /intervals/:id - Updates interval by ID
DELETE /intervals/:id - Deletes interval by ID

Examples¶

Neat Devices¶

Example:

Request:

POST /neatDevice/all/allDevices

Request Body:

{
  "locationName": "all",
  "regionName": "all",
  "roomName": "all"
}

Response:

[
  {
    "deviceid": "ND001",
    "devicesn": "ND123",
    "devicemodel": "ModelX",
    "status": { "connected": true, "inCallStatus": "ACTIVE" },
    "deviceconnected": true,
    "details": {
      "room": "Room A",
      "location": "HQ",
      "region": "North"
    }
  },
  {
    "deviceid": "ND002",
    "devicesn": "ND456",
    "devicemodel": "ModelY",
    "status": { "connected": false, "inCallStatus": "NONE" },
    "deviceconnected": false,
    "details": {
      "room": "Room B",
      "location": "Branch",
      "region": "South"
    }
  }
]

Filters¶

Example:

Request:

POST /filters/location

Request Body:

{
  "locationName": "all",
  "regionName": "all",
  "roomName": "all"
}

Response:

["ALCOBENDAS", "MADRID"]

Intervals¶

Example:

Request:

GET /intervals

Response:

[
  {
    "id": 1,
    "intervalFeedbackTestApi": 5000,
    "intervalDeviceStatus": 10000,
    "intervalDeviceStatusEspera": 15000,
    "intervalAllDevices": 20000
  }
]

Refer to the API documentation for detailed information on each endpoint.