logo
Documentation Powered by Redocly

Pager API specification (167bcec4f2ca85a6e22fddbc3c4080bdb541d1e5)

Download OpenAPI specification:Download

The pager service implements all pager functions for GroupAlarm

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

pager

Returns all pagers for current user or given organization.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new pager for the assigned organization.

Request Body schema: application/json
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,
  • "id": 0,
  • "name": "string",
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

Returns the requested pager and its latest status.

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,
  • "id": 0,
  • "name": "string",
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

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

path Parameters
pagerID
required
integer

ID of an existing pager

Request Body schema: application/json
active
boolean
id
integer <int64>
name
string
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,
  • "id": 0,
  • "name": "string",
  • "serialNumber": "string",
  • "status": {
    },
  • "userID": 0
}

Response samples

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

RemovePagerFromOrganization

Removes a pager from the given organization

path Parameters
pagerID
required
integer

ID of an existing pager

query Parameters
organization_id
required
integer

requesting organization

Responses

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

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

Assigns an organization's pager to a user.

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.

query Parameters
organization_id
required
integer

requested organization

Responses

Response samples

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

organizations

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

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.

query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
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.

Request Body schema: application/json
organizationID
integer <int64>
pagerIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples