Manage devices

Search…
Manage devices
Use this section to add/update/delete new sites(devices).
Introduction
Data related to devices/sites is owned and managed by the device-service. The terms site and devices can be used interchangeably. A device can either represent a single device or a site depending on the use case. However hereafter only the term device will be used. 
Querying devices
get
https://talos-app.io
/api/device-service/devices/search/findByCompanyId
find all devices by companyId
get
https://talos-app.io
/api/device-service/devices/search/findByDeviceGroupId?:deviceGroupId
find the device by groupId
get
https://talos-app.io
/api/device-service/devices/:id
list a specific device
Create/Update/Delete Devices
post
https://talos-app.io/
api/device-service/devices
create a device
Example:
1
{
2
    "id": null,
3
    "companyId": "064646f3-18a2-4298-a28e-6e2883f27407",
4
    "evalinkDeviceId": "customId",
5
    "active": true,
6
    "testMode": false,
7
    "customerCompany": "Sitasys AG",
8
    "customerFirstName": "Lukas",
9
    "customerLastName": "Kaiser",
10
    "customerPhone": "+41315110101",
11
    "customerEmail": "[email protected]",
12
    "customerZip": "4513",
13
    "customerCity": "Langendorf",
14
    "customerStreet": "Industriestrasse 6",
15
    "installerCompany": null,
16
    "installerFirstName": null,
17
    "installerLastName": null,
18
    "installerEmail": null,
19
    "installerPhone": null
20
}
Copied!
patch
https://talos-app.io
/api/device-service/devices/:id
update a device
delete
https://talos-app.io
/api/device-servicse/devices/:id
delete a device
Site activation/deactivation
post
https://talos-app.io
/api/device-service/devices/{id}/activate
activate a device
post
https://talos-app.io
/api/device-service/devices/{id}/deactivate
deactivate a device
Site sharing
get
https://talos-app.io
/api/device-service/devices/:deviceId/shareLinks
get share links
post
https://talos-app.io
/api/device-service/devices/:deviceId/shareLinks
create a shared link
under construction
Example:
1
​
Copied!
Test mode
post
https://talos-app.io
/device-service/devices/:deviceId/test-mode
activate specific test mode
1
"matchers": [
2
    {
3
      "field": "string",
4
      "invert": true,
5
      "matcherLogic": "AND",
6
      "operator": "string",
7
      "type": "string",
8
      "value": "string"
9
    }
10
  ]
Copied!
Zones/users and partitions
get
https://talos-app.io
/api/device-service/devices/:id/zones
get zones/users
post
https://talos-app.io
/api/device-service/devices/:id/zones
write zones/users
1
{
2
        "zones": [
3
            {
4
                "zoneId": "002",
5
                "zoneName": "John Doe",
6
                "zoneType": "USER"
7
            },
8
            {
9
                "zoneId": "001",
10
                "zoneName": "Atrium",
11
                "zoneType": "ZONE"
12
            }
13
        ]
14
}
Copied!
patch
https://talos-app.io
/api/device-service/devices/:id/zones
update zones/users
1
{
2
        "zones": [
3
            {
4
                "zoneId": "002",
5
                "zoneName": "John Doe",
6
                "zoneType": "USER"
7
            },
8
            {
9
                "zoneId": "001",
10
                "zoneName": "Atrium",
11
                "zoneType": "ZONE"
12
            }
13
        ]
14
}
Copied!
get
https://talos-app.io
/api/device-service/devices/:id/partitions
get partitions
post
https://talos-app.io
/api/device-service/devices/:id/partitions
write partitions
1
{
2
        "partitions": [
3
            {
4
                "partitionId": "003",
5
                "partitionName": "Maintenance Floor"
6
            },
7
            {
8
                "partitionId": "004",
9
                "partitionName": "Department Store"
10
            }
11
        ]
12
}
Copied!
patch
https://talos-app.io
/api/device-service/devices/:id/partitions
update partitions
1
{
2
        "partitions": [
3
            {
4
                "partitionId": "003",
5
                "partitionName": "Maintenance Floor"
6
            },
7
            {
8
                "partitionId": "004",
9
                "partitionName": "Department Store"
10
            }
11
        ]
12
}
Copied!
Tags
get
https://talos-app.io
/api/device-service/devices/:deviceId/tag
list tags
post
https://talos-app.io
/api/device-service/devices/:deviceId/tag
add tag
post
https://talos-app.io
/api/device-service/devices/:deviceId/untag
remove tag
​
​
Management API - Previous
Manage users
Next - Management API
Manage groups
Last modified 1yr ago
Introduction

Querying devices

Create/Update/Delete Devices

Site activation/deactivation

Site sharing

Test mode

Zones/users and partitions

Tags

​
