logo
Documentation Powered by ReDoc

Pager API specification (2.0.1)

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
int64

requested user

organization_id
int64

requested organization

Responses

200

pager configurations for passed user or organization

400

no organizationID / ownerID in request

500

Unexpected database error

get /devices
https://app.groupalarm.com/api/v1/pager/devices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

CreatePager

Create a pager configuration in the given organization

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

200

created pager configuration

400

pager configuration payload is missing or in wrong format

500

Unexpected database error

post /devices
https://app.groupalarm.com/api/v1/pager/devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "name": "string",
  • "organizationId": 0,
  • "serialNumber": "string",
  • "userId": 0
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "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
int64

ID of an existing pager

query Parameters
organization_id
required
int64

requesting organization

Responses

200

pager information and status data

400

no or invalid pagerID / organizationID request

500

Unexpected error

get /devices/{pagerID}
https://app.groupalarm.com/api/v1/pager/devices/{pagerID}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

UpdatePager

Updates an existing pager configuration

path Parameters
pagerID
required
int64

ID of an existing pager configuration

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

status
object (PagerStatusResponse)

PublicPagerStatusResponse is used to remove critical information from a PagerStatusResponse

userId
integer <int64>

assigned user

Responses

200

update pager configuration

400

pager configuration payload is missing or in wrong format

500

Unexpected database error

put /devices/{pagerID}
https://app.groupalarm.com/api/v1/pager/devices/{pagerID}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "serialNumber": "string",
  • "status":
    {
    },
  • "userId": 0
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "serialNumber": "string",
  • "status":
    {
    },
  • "userId": 0
}

RemovePagerFromOrganization

Remove a pager from the given organization

path Parameters
pagerID
required
int64

ID of an existing pager configuration

query Parameters
organization_id
required
int64

requested organization

Responses

200

removed pager from organization

400

passed pagerID / organization_id missing or in wrong format

500

Unexpected database error

delete /devices/{pagerID}
https://app.groupalarm.com/api/v1/pager/devices/{pagerID}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "deleted"
}

AssignPagerToUser

Set a pager as personal device of the given user

path Parameters
pagerID
required
int64

ID of an existing pager configuration

userID
required
int64

ID of an existing user

query Parameters
organization_id
int64

requesting organization; zero if user

Responses

200

update successful

400

passed pagerID / userID missing or in wrong format

403

organization is not allowed to assign this pager

500

Unexpected database error

post /devices/{pagerID}/user/{userID}
https://app.groupalarm.com/api/v1/pager/devices/{pagerID}/user/{userID}

Statistics

Returns pager statistics for given organization

query Parameters
organization_id
required
int64

requested organization

Responses

200

pager statistics for passed organization

400

no organizationID in request

500

Unexpected database error

get /statistics
https://app.groupalarm.com/api/v1/pager/statistics

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

organizations

GetDisabledOrganization

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

query Parameters
organization_id
required
int64

requesting organization

Responses

200

whether this way of alarming is disabled or not

400

organization_id is missing or in wrong format

500

Unexpected database error

get /disabled
https://app.groupalarm.com/api/v1/pager/disabled

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

SetDisabledOrganization

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

query Parameters
organization_id
required
int64

requesting organization

Request Body schema: application/json
isDisabled
boolean

Responses

200

request successful

400

organization_id is missing or in wrong format

500

Unexpected database error

put /disabled
https://app.groupalarm.com/api/v1/pager/disabled

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "isDisabled": true
}

management

Init

Force a pager to init itself again

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/init
https://app.groupalarm.com/api/v1/pager/management/init

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Lock

Lock the pager and prevent any further use

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/lock
https://app.groupalarm.com/api/v1/pager/management/lock

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Reset

Force a pager to reset (to default settings)

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

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/reset
https://app.groupalarm.com/api/v1/pager/management/reset

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "factoryReset": true,
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Status

Request a status update from the pager

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/status
https://app.groupalarm.com/api/v1/pager/management/status

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Alarm

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

Request Body schema: application/json
message
string

message to display

organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/text/alarm
https://app.groupalarm.com/api/v1/pager/management/text/alarm

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Display

Display the given text on the pager's display

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

text
string

text to display

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/text/display
https://app.groupalarm.com/api/v1/pager/management/text/display

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ],
  • "text": "string"
}

Unlock

Unlock the pager and allow usage

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/unlock
https://app.groupalarm.com/api/v1/pager/management/unlock

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}

Update

Force a pager to run an update

Request Body schema: application/json
organizationId
integer <int64>

organization, which is managing this pager

pagerIds
Array of integer <int64>

list of receiving pager-ids

Responses

200

operation successful

400

data in payload is invalid

403

user or organization are not allowed to manage pager

500

unexpected error

post /management/update
https://app.groupalarm.com/api/v1/pager/management/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "organizationId": 0,
  • "pagerIds":
    [
    ]
}