evalink talos
  • evalink talos API Documentation
  • Get started
    • 1. Create a free evalink talos account
    • 2. Create a test set-up in evalink talos
    • 3. About REST – The Basics
    • 4. Get Postman
    • 5. Create your first API Token in evalink talos
    • 6. Make your first REST API call
  • Alarm API
    • Send alarms using simple webhooks
    • Send alarms with content using webhooks and header attachments
    • Send alarms using REST
    • Query alarms
  • Management API
    • Manage users
    • Manage devices
    • Manage groups
    • Manage contacts
    • Manage schedules
    • Manage virtual receivers
    • Manage webhooks
    • Manage workflows
Powered by GitBook
On this page
  • Introduction
  • create new schedules
  • list the schedules by device ID
  • delete the schedules
  • list the special days by companyId
  • create new special days
  • delete the special days

Was this helpful?

  1. Management API

Manage schedules

Use this section to add/update/delete schedules in evalink talos.

Introduction

Schedules can be set to define a timeslot. You can define workflows based on these schedules.

Example: You can define, that in case of an alarm the call is sent to a different recipient, based on the schedule. Through opening hours it’s sent to your in-house security, through closed hours it,s sent to a private ARC.

create new schedules

POST https://talos-app.io/api/schedule-service/schedules

Use this endpoint to create a new schedule in a service.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
  "activateAlarm": "string",
  "buffer": 0,
  "companyId": "string",
  "createdAt": 0,
  "deactivateAlarm": "string",
  "deviceGroupId": "string",
  "deviceId": "string",
  "entityStatus": "string",
  "entries": [
    {
      "autoDelete": true,
      "autoDeleteAt": 0,
      "dayOfWeek": "FRIDAY",
      "endDate": "string",
      "endTime": "string",
      "entryType": "DATE",
      "id": "string",
      "specialDayId": "string",
      "startDate": "string",
      "startTime": "string"
    }
  ],
  "excludedCount": 0,
  "excludedSchedulesPreview": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "id": "string",
  "includedCount": 0,
  "includedSchedulesPreview": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "links": {
    "empty": true
  },
  "name": "string",
  "nextActivateAlarm": 0,
  "nextDeactivateAlarm": 0,
  "rolesPreview": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "timeZone": "string",
  "updatedAt": 0,
  "updatedBy": "string",
  "usageCount": 0
}

list the schedules by device ID

GET https://talos-app.io/api/schedule-service/schedules/search/findByDeviceId{deviceId}

Use this endpoint to list the schedules by their device id.

Query Parameters

Name
Type
Description

deviceId

string

The ID of the device you want to access.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

delete the schedules

DELETE https://talos-app.io/api/schedule-service/schedules/{id}

Use this endpoint to delete the schedules.

Path Parameters

Name
Type
Description

id

string

The relevant schedule ID.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

list the special days by companyId

GET https://talos-app.io/api/schedule-service/special-days/search/findByCompanyId{companyId}

Use this endpoint to list the special days.

Query Parameters

Name
Type
Description

companyId

string

The company Id of the required company.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
  "_embedded": {
    "specialDays": [
      {
        "companyId": "string",
        "date": "string",
        "dayType": "FIX",
        "id": "string",
        "name": "string",
        "rule": "string"
      }
    ]
  },
  "_links": {}
}

create new special days

POST https://talos-app.io/api/schedule-service/special-days

Use this endpoint to create new special days within the scheduled service.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

{
  "companyId": "string",
  "date": "string",
  "dayType": "FIX",
  "id": "string",
  "links": {
    "empty": true
  },
  "name": "string",
  "rule": "string"
}
{
  "companyId": "string",
  "date": "string",
  "dayType": "FIX",
  "id": "string",
  "name": "string",
  "rule": "string"
}

delete the special days

DELETE https://talos-app.io/api/schedule-service/special-days/{id}

Use this endpoint to delete the special days from the scheduled service.

Path Parameters

Name
Type
Description

id

string

The required special days ID.

Headers

Name
Type
Description

Authorization

string

Use "Bearer" followed by your API Token.

PreviousManage contactsNextManage virtual receivers

Last updated 4 years ago

Was this helpful?