> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pads4.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NDS.Services.Device

## Overview

Manages PADS4 viewer devices: registration, grouping, property assignment, and licensing. Central registry for all display hardware connected to a PADS4 deployment.

| Field           | Value                                                                   |
| --------------- | ----------------------------------------------------------------------- |
| Swagger UI      | `https://<your-server>/rdx/NDS.Services.Device/swagger/index.html`      |
| OpenAPI spec    | `https://<your-server>/rdx/NDS.Services.Device/swagger/v1/swagger.json` |
| Base URL        | `https://<your-server>/rdx/NDS.Services.Device`                         |
| Total endpoints | 29                                                                      |

***

## Authentication

All endpoints use the standard PADS4 session cookie. Obtain it once and reuse:

```bash theme={null}
# Log in and save the session cookie
curl -c cookies.txt -X POST 'https://<your-server>/api/v1/Account/Logon' \
  -H 'Content-Type: application/json' \
  -d '{"UserName": "admin", "Password": "yourpassword", "Domain": "yourdomain"}'

# Use the cookie on all subsequent requests
curl -b cookies.txt -X GET 'https://<your-server>/rdx/<ServiceName>/...'
```

> Replace `https://<your-server>` with your PADS4 server address and `<ServiceName>` with the service path shown above.

***

## Endpoint Reference

| Method   | Path                                          | Description             |
| -------- | --------------------------------------------- | ----------------------- |
| `POST`   | `/api/v1/device`                              | Get Devices             |
| `POST`   | `/api/v1/device/sendCommand`                  | Send Command            |
| `DELETE` | `/api/v1/device/removeDevices`                | Remove Device           |
| `POST`   | `/api/v1/device/updateData`                   | Update Data             |
| `POST`   | `/api/v1/device/update`                       | Update Device           |
| `POST`   | `/api/v1/device/search`                       | Search Devices          |
| `POST`   | `/api/v1/device/getState`                     | Get State               |
| `GET`    | `/api/v1/device/stats`                        | Get Device Statistics   |
| `POST`   | `/api/v1/gateway/register`                    | Register Gateway        |
| `POST`   | `/api/v1/gateway/updateConfig`                | Update Config           |
| `POST`   | `/api/v1/gateway`                             | Get Gateways            |
| `POST`   | `/api/v1/gateway/update`                      | Update                  |
| `POST`   | `/api/v1/gateway/logs`                        | Get Logs                |
| `POST`   | `/api/v1/gateway/delete`                      | Delete                  |
| `POST`   | `/api/v1/webhook/smartthings/{domain}`        | Smart Things Webhook    |
| `GET`    | `/api/v1/diagnostics/toggles`                 | Get Toggles             |
| `GET`    | `/api/v1/diagnostics/configuration`           | Get Config Section      |
| `GET`    | `/api/v1/diagnostics/configurationex`         | Get Configuration       |
| `GET`    | `/api/v1/diagnostics/circuitbreakers`         | Get Circuit Breakers    |
| `GET`    | `/api/v1/diagnostics/circuitbreakers/reset`   | Reset Circuit Breaker   |
| `GET`    | `/api/v1/diagnostics/circuitbreakers/isolate` | Isolate Circuit Breaker |
| `POST`   | `/api/v1/diagnostics/events`                  | Get Events              |
| `GET`    | `/api/v1/health`                              | Get                     |
| `GET`    | `/api/v1/health/clean`                        | Get Clean               |
| `POST`   | `/api/v1/Management/RequeueErrorMessages`     | Requeue Error Messages  |
| `POST`   | `/api/v1/Management/PurgeErrorMessages`       | Purge Error Messages    |
| `GET`    | `/migration`                                  | Get Migrations          |
| `POST`   | `/migration`                                  | Execute Migration       |
| `GET`    | `/version`                                    | Get                     |

***

## Request & Response Examples

### POST `/api/v1/device`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/device/sendCommand`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device/sendCommand' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### DELETE `/api/v1/device/removeDevices`

**Request:**

```bash theme={null}
curl -b cookies.txt -X DELETE 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device/removeDevices'
```

**Response `200 OK`:**

```json theme={null}
{"Code": "OK", "Succeeded": true, "Message": null}
```

***

### POST `/api/v1/device/updateData`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device/updateData' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/device/update`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device/update' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/device/search`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Device/api/v1/device/search' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

> Additional endpoints follow the same patterns shown above. See the Swagger UI for full parameter schemas.