logo
API docs by Redocly

Pager API specification (b0401ea8fae9f778010413ae0c3e385372508deb)

Download OpenAPI specification:Download

The pager service is used to configure and manage pagers.

pager

ListPagers

Returns all pagers for current user or given organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
owner_id
integer

requested user

organization_id
integer

requested organization

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list; only applicable if querying by organization_id

offset
integer
Default: 0

amount of entries to skip; only applicable if querying by organization_id

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters; only applicable if querying by organization_id

search
string

only return entries which contains the search value in the pager name, pager serialnumber or participant name (last and first name)

orderby
string
Default: "name"
Enum: "name" "serialnumber" "firstname" "surname" "email"

sorts the entries returned by the given column

orderdir
string
Default: "asc"
Enum: "asc" "desc"

direction of the so

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0
}

CreatePager

Creates a new pager for the assigned organization

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
active
boolean
name
string
organizationId
integer <int64>

assigned organization (required)

serialNumber
string
userID
integer <int64>

assigned user (optional)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "string",
  • "organizationId": 0,
  • "serialNumber": "string",
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "fredSettings": {
    },
  • "id": 0,
  • "name": "string",
  • "onlineStatus": {
    },
  • "organizationID": 0,
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

GetPager

Returns the requested pager and its latest status

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

ID of an existing pager

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "fredSettings": {
    },
  • "id": 0,
  • "name": "string",
  • "onlineStatus": {
    },
  • "organizationID": 0,
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

UpdatePager

Updates an existing pager for organization-admins or for the assigned user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

ID of an existing pager

Request Body schema: application/json
required
active
boolean
object (FredSettings contains all settings for a pager, defined by the organization or specific to the pager.)
id
integer <int64>
name
string
object (PagerOnlineStatus contains information about the pager's online status.)
organizationID
integer <int64>
serialNumber
string
object (PagerStatus contains all publicly available information we have about a pager's current status.)

As ERIC and FRED pager statuses have slightly different data, we combine them into this one. Some details are not published, because they might be irrelevant for the user.

userID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "fredSettings": {
    },
  • "id": 0,
  • "name": "string",
  • "onlineStatus": {
    },
  • "organizationID": 0,
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "fredSettings": {
    },
  • "id": 0,
  • "name": "string",
  • "onlineStatus": {
    },
  • "organizationID": 0,
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

RemovePager

Removes a pager from the given organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

ID of an existing pager

query Parameters
organization_id
required
integer

requesting organization

Responses

UnassignPager

Unassigns an organization's pager from a user or removes the assignment for the currently assigned user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

ID of an existing pager

query Parameters
organization_id
integer

requesting organization; required if requesting user is not unassigning himself

Responses

AssignPagerToUser

Assigns an organization's pager to a user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

ID of an existing pager

userID
required
integer

ID of an existing user

query Parameters
organization_id
integer

requesting organization

Responses

Returns pager statistics for the given organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requested organization

Responses

Response samples

Content type
application/json
{
  • "online": 0,
  • "registered": 0
}

fred-settings

GetPagerSettings

Returns the fred pagers's settings (either their own, their organization's or our default)

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

Responses

Response samples

Content type
application/json
{
  • "alarm2USBMode": "string",
  • "deadManMode": "string",
  • "deviceID": "string",
  • "emergencyCallMode": "string",
  • "gpsMode": "string",
  • "organizationID": 0,
  • "statusInterval": 15
}

SetPagerSettings

Updates the fred pager's settings

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer
Request Body schema: application/json
required
alarm2USBMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

deadManMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

deviceID
required
string

either deviceID (settings for this specific pager) or organizationID must be set

emergencyCallMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

gpsMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

organizationID
required
integer <int64>

either organizationID (settings for all pagers in this organization) or deviceID must be set

statusInterval
required
integer <int64> [ 15 .. 10080 ]

how often the pager sends its status in minutes

Responses

Request samples

Content type
application/json
{
  • "alarm2USBMode": "string",
  • "deadManMode": "string",
  • "deviceID": "string",
  • "emergencyCallMode": "string",
  • "gpsMode": "string",
  • "organizationID": 0,
  • "statusInterval": 15
}

ResetPagerSettings

Resets the fred pager's settings to our default

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
pagerID
required
integer

Responses

GetOrganizationSettings

Returns the organization's fred pager settings (either their own or our default)

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "alarm2USBMode": "string",
  • "deadManMode": "string",
  • "deviceID": "string",
  • "emergencyCallMode": "string",
  • "gpsMode": "string",
  • "organizationID": 0,
  • "statusInterval": 15
}

SetOrganizationSettings

Updates the organization's fred pager settings

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
alarm2USBMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

deadManMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

deviceID
required
string

either deviceID (settings for this specific pager) or organizationID must be set

emergencyCallMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

gpsMode
required
string (fredChangeSettingsMode)

fredChangeSettingsMode is used to define the state of various pager settings enum: [OFF, ON, OFF_USER, ON_USER]

organizationID
required
integer <int64>

either organizationID (settings for all pagers in this organization) or deviceID must be set

statusInterval
required
integer <int64> [ 15 .. 10080 ]

how often the pager sends its status in minutes

Responses

Request samples

Content type
application/json
{
  • "alarm2USBMode": "string",
  • "deadManMode": "string",
  • "deviceID": "string",
  • "emergencyCallMode": "string",
  • "gpsMode": "string",
  • "organizationID": 0,
  • "statusInterval": 15
}

ResetOrganizationSettings

Resets the organization's fred pager settings to our default

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

organizations

Returns whether the given organization has disabled pager-alarming or not.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
{
  • "isDisabled": true
}

Sets whether the given organization has disabled pager-alarming or not.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json
required
isDisabled
boolean

Responses

Request samples

Content type
application/json
{
  • "isDisabled": true
}

management

Forces pagers to initialize themselves again, losing all user-data.

This is currently unsupported on FRED pagers.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ]
}

Locks the pagers and prevents any further use.

When locking a FRED pager, you can also specify a message to display on the pager.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]
text
string

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ],
  • "text": "string"
}

Forces pagers to reset to their user-default or factory-default settings.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
factoryReset
boolean
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "factoryReset": true,
  • "organizationID": 0,
  • "pagerIDs": [
    ]
}

Requests a status update from the pagers.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ]
}

Sends your text to the pagers playing a notification sound.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
message
string
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]
pagerSerialNumbers
Array of strings

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "organizationID": 0,
  • "pagerIDs": [
    ],
  • "pagerSerialNumbers": [
    ]
}

Sends your text to the pagers without playing a notification sound.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]
text
string

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ],
  • "text": "string"
}

Unlocks the previously locked pagers.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ]
}

Forces pagers to check and install the most recent firmware.

This is currently unsupported on FRED pagers.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "pagerIDs": [
    ]
}

pagers

AnyActive

Check if any pager is active for the passed owner id in the passed organization id and check if the organization granted permission to use pagers

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
user_id
required
integer

id of the user

organization_id
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "activeCount": 0,
  • "anyActive": true,
  • "organizationPermission": true
}

priority

Returns the current alarm priority mode of the given organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

requested organization's alarm priority mode

Responses

Response samples

Content type
application/json
{
  • "organizationID": 0,
  • "priority": 0
}

Updates an organization's alarm priority mode.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requested organization

priority
required
integer

alarm priority mode (1 = High / 4 = Normal)

Responses