logo
Documentation Powered by Redocly

Pager API specification (9e074e34355a5facbece3910d74e59e0e26c61fd)

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

ListPager

Returns all pagers for current user or given organization

query Parameters
owner_id
integer

requested user

organization_id
integer

requested organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreatePager

Create a pager configuration in the given organization

Request Body schema: application/json

pager creation request payload

active
boolean

true, if this configuration can be used for alarm notifications

name
string

user defined name for this configuration

organizationId
integer <int64>

assigned organization

serialNumber
string

serial number for pager messages

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
}

GetPager

Returns all information about the pager and the current status data

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
[
  • {
    }
]

UpdatePager

Updates an existing pager configuration

path Parameters
pagerID
required
integer

ID of an existing pager configuration

Request Body schema: application/json

pager payload

active
boolean

true, if this configuration can be used for alarm notifications

id
integer <int64>

id for this configuration

name
string

user defined name for this configuration

serialNumber
string

serial number for pager messages

object (PagerStatusResponse)

PublicPagerStatusResponse is used to remove critical information from a PagerStatusResponse

userId
integer <int64>

assigned user

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

Remove a pager from the given organization

path Parameters
pagerID
required
integer

ID of an existing pager configuration

query Parameters
organization_id
required
integer

requested organization

Responses

Response samples

Content type
application/json
{
  • "status": "deleted"
}

AssignPagerToUser

Set a pager as personal device of the given user

path Parameters
pagerID
required
integer

ID of an existing pager configuration

userID
required
integer

ID of an existing user

query Parameters
organization_id
integer

requesting organization; zero if user

Responses

Statistics

Returns pager statistics for given organization

query Parameters
organization_id
required
integer

requested organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

organizations

GetDisabledOrganization

Returns whether the given organization has disabled this way of alarming or not

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SetDisabledOrganization

Sets whether the given organization has this way of alarming disabled or not

query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled
boolean

Responses

Request samples

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

management

Init

Force a pager to init itself again

Request Body schema: application/json

pager request payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "pagerIds": [
    ]
}

Lock

Lock the pager and prevent any further use

Request Body schema: application/json

pager request payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "pagerIds": [
    ]
}

Reset

Force a pager to reset (to default settings)

Request Body schema: application/json

pager request reset payload

factoryReset
boolean

set to true if the pager should reset to factory default settings

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

Responses

Request samples

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

Status

Request a status update from the pager

Request Body schema: application/json

pager request payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "pagerIds": [
    ]
}

Alarm

Send the given text like an alarm onto the pager's display

Request Body schema: application/json

pager request text alarm payload

message
string

message to display

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids (legacy)

pagerSerialNumbers
Array of strings

list of receiving pager-numbers

Responses

Request samples

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

Display

Display the given text on the pager's display

Request Body schema: application/json

pager request text display payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

text
string

text to display

Responses

Request samples

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

Unlock

Unlock the pager and allow usage

Request Body schema: application/json

pager request payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "pagerIds": [
    ]
}

Update

Force a pager to run an update

Request Body schema: application/json

pager request payload

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integers <int64> [ items <int64 > ]

list of receiving pager-ids

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

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
}