Manage virtual receivers

Use this section to add/update/delete new virtual receivers such as DC09, TNA, FlexC V.

Introduction

GET https://talos-app.io/api/flexc-receiver/flexc-devices/search/findByDeviceId{deviceId}

Use this endpoint to list all of the FlexC devices via their relevant device ID.

Path Parameters

Name
Type
Description

deviceId

string

The evalink device ID.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
  "_embedded": {
    "ipDevices": [
      {
        "channels": [
          {
            "address": "string",
            "alive": true,
            "connected": true,
            "heartbeatMs": 0,
            "id": "string",
            "ipDevId": "string",
            "pollInterval": 0,
            "pollTimeout": 0,
            "primary": true,
            "reported": true,
            "supervisionInterval": 0,
            "type": "ETH"
          }
        ],
        "commissioned": true,
        "companyId": "string",
        "createdAt": 0,
        "deviceId": "string",
        "enabled": true,
        "entityStatus": "string",
        "firmware": "string",
        "id": "string",
        "ipDevId": "string",
        "keyStr": "string",
        "manufacturer": "string",
        "pollIntervalType": "string",
        "reported": true,
        "secToPrimPollInterval": 0,
        "secToPrimPollTimeout": 0,
        "secToPrimSupervisionInterval": 0,
        "serial": "string",
        "simultaneousSupervisionInterval": 0,
        "type": "string",
        "updatedAt": 0,
        "updatedBy": "string"
      }
    ]
  },
  "_links": {}
}

create a new FlexC device

POST https://talos-app.io/api/flexc-receiver/flexc-devices

Use this endpoint to create a new FlexC device.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

Request Body

Name
Type
Description

panelPassword

string

The panel password.

panelUser

string

The panel user.

keyNr

string

needs to be -1

channels

array

Collection

map

string

needs to be null for the request to succeed

{
    "ipDevId": "691896XX",
    "enabled": true,
    "commissioned": false,
    "reported": true,
    "pollIntervalType": "DP3",
    "secToPrimPollInterval": 60,
    "secToPrimPollTimeout": 120,
    "secToPrimSupervisionInterval": 180,
    "simultaneousSupervisionInterval": 240,
    "deviceId": "newDevice2",
    "companyId": "bc2b4013-664a-46ab-a1be-a85c31axxxxx",
    "entityStatus": "VALIDATION_PENDING",
    "serial": null,
    "manufacturer": null,
    "type": null,
    "firmware": null,
    "createdAt": 1607946180357,
    "updatedAt": 1607946180357,
    "updatedBy": "API - Playground API Token",
    "channels": [
        {
            "id": "8a81e9577652c8ae0176610f970501xx",
            "ipDevId": "69189668",
            "type": "ETH",
            "primary": true,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": 1607946180356,
            "pollInterval": 30,
            "pollTimeout": 60,
            "supervisionInterval": 180,
            "address": ""
        },
        {
            "id": "8a81e9577652c8ae0176610f970501XX",
            "ipDevId": "69189668",
            "type": "GPRS",
            "primary": false,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": 1607946180357,
            "pollInterval": 14400,
            "pollTimeout": 15000,
            "supervisionInterval": 90000,
            "address": ""
        }
    ],
    "id": "8a81e9577652c8ae0176610f97050143",
    "keyNr": 1000038380,
    "keyStr": "8b72f40ae9bed55438960043209ea43c43f1f080281ab331fa86fe51235d1e9e",
    "panelUser": "flexcUser",
    "panelPassword": "secret",
    "verificationEnabled": true,
    "deviceTimezone": "CET",
    "_links": {
        "self": {
            "href": "http://talos-app.io/api/flexc-receiver/flexc-devices/8a81e9577652c8ae0176610f97050143"
        },
        "flexcDevice": {
            "href": "http://talos-app.io/api/flexc-receiver/flexc-devices/8a81e9577652c8ae0176610f97050143"
        }
    }
}

Example:

{
                "id": null,
                "companyId": <companyId>,
                "deviceId": <deviceUUID>,
                "pollIntervalType": "DP3",
                "secToPrimPollInterval": 60,
                "secToPrimPollTimeout": 120,
                "secToPrimSupervisionInterval": 180,
                "simultaneousSupervisionInterval": 240,
                "channels": [
                    {
                        "primary": true,
                        "type": "ETH",
                        "pollInterval": 30,
                        "pollTimeout": 60,
                        "supervisionInterval": 180
                    },
                    {
                        "primary": false,
                        "type": "GPRS",
                        "pollInterval": 14400,
                        "pollTimeout": 15000,
                        "supervisionInterval": 90000
                    }
                ],
                "keyNr": -1,
                "panelUser": "flexcUser",
                "panelPassword": "secret",
                "verificationEnabled": true
}

list all of the VdS devices

GET https://talos-app.io/api/vds-receiver/vds-devices/search/findByDeviceId

Use this endpoint to list all of the VdS devices.

Query Parameters

Name
Type
Description

device Id

string

The id of the device.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
  "_embedded": {
    "vdsDevices": [
      {
        "channels": [
          {
            "address": "string",
            "alive": true,
            "connected": true,
            "heartbeatMs": 0,
            "id": "string",
            "ipDevId": "string",
            "pollInterval": 0,
            "pollTimeout": 0,
            "primary": true,
            "reported": true,
            "supervisionInterval": 0,
            "type": "ETH"
          }
        ],
        "commissioned": true,
        "companyId": "string",
        "createdAt": 0,
        "deviceId": "string",
        "enabled": true,
        "entityStatus": "string",
        "firmware": "string",
        "id": "string",
        "ipDevId": "string",
        "keyNr": 0,
        "keyStr": "string",
        "manufacturer": "string",
        "pollIntervalType": "string",
        "reported": true,
        "secToPrimPollInterval": 0,
        "secToPrimPollTimeout": 0,
        "secToPrimSupervisionInterval": 0,
        "securip": true,
        "serial": "string",
        "simultaneousSupervisionInterval": 0,
        "type": "string",
        "updatedAt": 0,
        "updatedBy": "string"
      }
    ]
  },
  "_links": {}
}

create a VdS device

POST https://talos-app.io/api/vds-receiver/vds-devices

Use this endpoint to create a single VdS device.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
    "ipDevId": "28351601",
    "enabled": true,
    "commissioned": false,
    "reported": true,
    "pollIntervalType": "DP3",
    "secToPrimPollInterval": 8,
    "secToPrimPollTimeout": 16,
    "secToPrimSupervisionInterval": 180,
    "simultaneousSupervisionInterval": 240,
    "deviceId": "8a81cd77762e321d0176495854ba168f",
    "companyId": "064646f3-18a2-4298-a28e-6e2883f27407",
    "entityStatus": "VALIDATION_PENDING",
    "serial": null,
    "manufacturer": null,
    "type": null,
    "firmware": null,
    "createdAt": 1607549153445,
    "updatedAt": 1607549153445,
    "updatedBy": "API - API-DOC",
    "channels": [
        {
            "id": "8a81ea2475f4c9620176496570a50052",
            "ipDevId": "28351601",
            "type": "ETH",
            "primary": true,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": -1,
            "pollInterval": 8,
            "pollTimeout": 16,
            "supervisionInterval": 180,
            "address": ""
        },
        {
            "id": "8a81ea2475f4c9620176496570a50053",
            "ipDevId": "28351601",
            "type": "GPRS",
            "primary": false,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": -1,
            "pollInterval": 8,
            "pollTimeout": 16,
            "supervisionInterval": 90000,
            "address": ""
        }
    ],
    "id": "8a81ea2475f4c9620176496570a50051",
    "keyNr": null,
    "keyStr": null,
    "securip": null,
    "_links": {
        "self": {
            "href": "http://talos-app.io/api/vds-receiver/vds-devices/8a81ea2475f4c9620176496570a50051"
        },
        "vdsDevice": {
            "href": "http://talos-app.io/api/vds-receiver/vds-devices/8a81ea2475f4c9620176496570a50051"
        }
    }
}

Example:

{
                "ipDevId": null,
                "enabled": true,
                "commissioned": false,
                "reported": true,
                "pollIntervalType": "DP3",
                "secToPrimPollInterval": 8,
                "secToPrimPollTimeout": 16,
                "secToPrimSupervisionInterval": 180,
                "simultaneousSupervisionInterval": 240,
                "deviceId": "8a81cd77762e321d0176495854ba168f",
                "companyId": "064646f3-18a2-4298-a28e-6e2883f27407"
                "serial": null,
                "manufacturer": null,
                "type": null,
                "firmware": null,
                "channels": [
                    {
                        "id": null,
                        "ipDevId": null,
                        "type": "ETH",
                        "primary": true,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 8,
                        "pollTimeout": 16,
                        "supervisionInterval": 180,
                        "address": ""
                    },
                    {
                        "id": null,
                        "ipDevId": null,
                        "type": "GPRS",
                        "primary": false,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 8,
                        "pollTimeout": 16,
                        "supervisionInterval": 90000,
                        "address": ""
                    }
                ],
                "id": null,
                "keyNr": null,
                "keyStr": null,
                "securip": null
            }

delete the VdS receiver

DELETE https://talos-app.io/api/vds-receiver/vds-devices/{id}

Use this endpoint to delete the VdS receiver from the receiver list.

Path Parameters

Name
Type
Description

id

string

The ID of the VdS device we would like to delete.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

update the VdS receiver

PATCH https://talos-app.io/api/vds-receiver/vds-devices/{id}

Use this endpoint to update the VdS receiver list.

Path Parameters

Name
Type
Description

id

string

The ID of the VdS device that we would like to update.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

create a new DC09 virtual receiver

POST https://talos-app.io/api/dc09-receiver/dc09-devices

Work in Progress. Use this endpoint to create a new DC09 virtual receiver.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

Request Body

Name
Type
Description

map

string

{
    "ipDevId": "28406095",
    "enabled": true,
    "commissioned": false,
    "reported": true,
    "pollIntervalType": "DP3",
    "secToPrimPollInterval": 60,
    "secToPrimPollTimeout": 120,
    "secToPrimSupervisionInterval": 180,
    "simultaneousSupervisionInterval": 240,
    "deviceId": "8a81fd00762e31a50176494a2d951652",
    "companyId": "064646f3-18a2-4298-a28e-6e2883f27407",
    "entityStatus": "VALIDATION_PENDING",
    "serial": null,
    "manufacturer": null,
    "type": null,
    "firmware": null,
    "createdAt": 1607548012335,
    "updatedAt": 1607548012335,
    "updatedBy": "API - API-DOC",
    "channels": [
        {
            "id": "8a81b85675d8dec801764954072f01bb",
            "ipDevId": "28406095",
            "type": "ETH",
            "primary": true,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": -1,
            "pollInterval": 60,
            "pollTimeout": 120,
            "supervisionInterval": 180,
            "address": ""
        },
        {
            "id": "8a81b85675d8dec801764954072f01bc",
            "ipDevId": "28406095",
            "type": "GPRS",
            "primary": false,
            "connected": false,
            "alive": false,
            "reported": true,
            "heartbeatMs": -1,
            "pollInterval": 180,
            "pollTimeout": 360,
            "supervisionInterval": 90000,
            "address": ""
        }
    ],
    "id": "8a81b85675d8dec801764954072f01ba",
    "keyStr": null,
    "permanentConnection": false,
    "disableTimestampCheck": false,
    "trustedDevice": false,
    "_links": {
        "self": {
            "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81b85675d8dec801764954072f01ba"
        },
        "dc09Device": {
            "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81b85675d8dec801764954072f01ba"
        }
    }
}
{
                "ipDevId": null,
                "enabled": true,
                "commissioned": false,
                "reported": true,
                "pollIntervalType": "DP3",
                "secToPrimPollInterval": 60,
                "secToPrimPollTimeout": 120,
                "secToPrimSupervisionInterval": 180,
                "simultaneousSupervisionInterval": 240,
                "deviceId": "8a81fd00762e31a50176494a2d951652",
                "companyId": "064646f3-18a2-4298-a28e-6e2883f27407"
                "serial": null,
                "manufacturer": null,
                "type": null,
                "firmware": null
                "channels": [
                    {
                        "id": null,
                        "ipDevId": null,
                        "type": "ETH",
                        "primary": true,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 60,
                        "pollTimeout": 120,
                        "supervisionInterval": 180,
                        "address": ""
                    },
                    {
                        "id": null,
                        "ipDevId": null,
                        "type": "GPRS",
                        "primary": false,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 180,
                        "pollTimeout": 360,
                        "supervisionInterval": 90000,
                        "address": ""
                    }
                ],
                "id": null,
                "keyStr": null,
                "permanentConnection": false,
                "disableTimestampCheck": false,
                "trustedDevice": false
            }

get a DC09 virtual receiver by device ID

GET https://talos-app.io/api/dc09-receiver/dc09-devices/search/findByDeviceId{deviceId}

Work in Progress. Use this endpoint to receive the details for a particular DC09 virtual receiver by device ID.

Path Parameters

Name
Type
Description

deviceId

string

The relevant device ID.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
    "_embedded": {
        "dc09Devices": [
            {
                "ipDevId": "28406095",
                "enabled": true,
                "commissioned": false,
                "reported": true,
                "pollIntervalType": "DP3",
                "secToPrimPollInterval": 60,
                "secToPrimPollTimeout": 120,
                "secToPrimSupervisionInterval": 180,
                "simultaneousSupervisionInterval": 240,
                "deviceId": "8a81fd00762e31a50176494a2d951652",
                "companyId": "064646f3-18a2-4298-a28e-6e2883f27407",
                "entityStatus": "VALIDATED",
                "serial": null,
                "manufacturer": null,
                "type": null,
                "firmware": null,
                "createdAt": 1607548012335,
                "updatedAt": 1607548012335,
                "updatedBy": "API - API-DOC",
                "channels": [
                    {
                        "id": "8a81b85675d8dec801764954072f01bb",
                        "ipDevId": "28406095",
                        "type": "ETH",
                        "primary": true,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 60,
                        "pollTimeout": 120,
                        "supervisionInterval": 180,
                        "address": ""
                    },
                    {
                        "id": "8a81b85675d8dec801764954072f01bc",
                        "ipDevId": "28406095",
                        "type": "GPRS",
                        "primary": false,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 180,
                        "pollTimeout": 360,
                        "supervisionInterval": 90000,
                        "address": ""
                    }
                ],
                "id": "8a81b85675d8dec801764954072f01ba",
                "keyStr": null,
                "permanentConnection": false,
                "disableTimestampCheck": false,
                "trustedDevice": false,
                "_links": {
                    "self": {
                        "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81b85675d8dec801764954072f01ba"
                    },
                    "dc09Device": {
                        "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81b85675d8dec801764954072f01ba"
                    }
                }
            },
            {
                "ipDevId": "80855684",
                "enabled": true,
                "commissioned": false,
                "reported": true,
                "pollIntervalType": "DP3",
                "secToPrimPollInterval": 60,
                "secToPrimPollTimeout": 120,
                "secToPrimSupervisionInterval": 180,
                "simultaneousSupervisionInterval": 240,
                "deviceId": "8a81fd00762e31a50176494a2d951652",
                "companyId": "064646f3-18a2-4298-a28e-6e2883f27407",
                "entityStatus": "VALIDATED",
                "serial": null,
                "manufacturer": null,
                "type": null,
                "firmware": null,
                "createdAt": 1607547393745,
                "updatedAt": 1607547393745,
                "updatedBy": "John Doe",
                "channels": [
                    {
                        "id": "8a81d6ab758941f70176494a96d15247",
                        "ipDevId": "80855684",
                        "type": "ETH",
                        "primary": true,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 60,
                        "pollTimeout": 120,
                        "supervisionInterval": 180,
                        "address": ""
                    },
                    {
                        "id": "8a81d6ab758941f70176494a96d15248",
                        "ipDevId": "80855684",
                        "type": "GPRS",
                        "primary": false,
                        "connected": false,
                        "alive": false,
                        "reported": true,
                        "heartbeatMs": -1,
                        "pollInterval": 180,
                        "pollTimeout": 360,
                        "supervisionInterval": 90000,
                        "address": ""
                    }
                ],
                "id": "8a81d6ab758941f70176494a96d15246",
                "keyStr": "97af5f1aa4f97edb0db96d5c92a9ab00",
                "permanentConnection": false,
                "disableTimestampCheck": false,
                "trustedDevice": false,
                "_links": {
                    "self": {
                        "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81d6ab758941f70176494a96d15246"
                    },
                    "dc09Device": {
                        "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/8a81d6ab758941f70176494a96d15246"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "http://talos-app.io/api/dc09-receiver/dc09-devices/search/findByDeviceId?deviceId=8a81fd00762e31a50176494a2d951652"
        }
    }
}

Last updated