Download OpenAPI specification:Download
The pager service implements all pager functions for GroupAlarm
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 |
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 |
Returns all pagers for current user or given organization
owner_id | int64 requested user |
organization_id | int64 requested organization |
pager configurations for passed user or organization
no organizationID / ownerID in request
Unexpected database error
[- {
- "active": true,
- "id": 0,
- "name": "string",
- "serialNumber": "string",
- "status": {
- "battery": {
- "level": 0,
- "status": 0,
- "voltage": 0
}, - "configID": "string",
- "group": "string",
- "gsm": "string",
- "lastAlarmID": "string",
- "pagerSerialNumber": "string",
- "signalStrength": 0,
- "time": "2021-03-03T10:35:37Z",
- "username": "string",
- "version": {
- "hardware": "string",
- "software": "string"
}
}, - "userId": 0
}
]
Create a pager configuration in the given organization
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) |
created pager configuration
pager configuration payload is missing or in wrong format
Unexpected database error
{- "active": true,
- "name": "string",
- "organizationId": 0,
- "serialNumber": "string",
- "userId": 0
}
{- "active": true,
- "id": 0,
- "name": "string",
- "serialNumber": "string",
- "status": {
- "battery": {
- "level": 0,
- "status": 0,
- "voltage": 0
}, - "configID": "string",
- "group": "string",
- "gsm": "string",
- "lastAlarmID": "string",
- "pagerSerialNumber": "string",
- "signalStrength": 0,
- "time": "2021-03-03T10:35:37Z",
- "username": "string",
- "version": {
- "hardware": "string",
- "software": "string"
}
}, - "userId": 0
}
Returns all information about the pager and the current status data
pagerID required | int64 ID of an existing pager |
organization_id required | int64 requesting organization |
pager information and status data
no or invalid pagerID / organizationID request
Unexpected error
[- {
- "active": true,
- "id": 0,
- "name": "string",
- "serialNumber": "string",
- "status": {
- "battery": {
- "level": 0,
- "status": 0,
- "voltage": 0
}, - "configID": "string",
- "group": "string",
- "gsm": "string",
- "lastAlarmID": "string",
- "pagerSerialNumber": "string",
- "signalStrength": 0,
- "time": "2021-03-03T10:35:37Z",
- "username": "string",
- "version": {
- "hardware": "string",
- "software": "string"
}
}, - "userId": 0
}
]
Updates an existing pager configuration
pagerID required | int64 ID of an existing pager configuration |
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 |
status | object (PagerStatusResponse) PublicPagerStatusResponse is used to remove critical information from a PagerStatusResponse |
userId | integer <int64> assigned user |
update pager configuration
pager configuration payload is missing or in wrong format
Unexpected database error
{- "active": true,
- "id": 0,
- "name": "string",
- "serialNumber": "string",
- "status": {
- "battery": {
- "level": 0,
- "status": 0,
- "voltage": 0
}, - "configID": "string",
- "group": "string",
- "gsm": "string",
- "lastAlarmID": "string",
- "pagerSerialNumber": "string",
- "signalStrength": 0,
- "time": "2021-03-03T10:35:37Z",
- "username": "string",
- "version": {
- "hardware": "string",
- "software": "string"
}
}, - "userId": 0
}
{- "active": true,
- "id": 0,
- "name": "string",
- "serialNumber": "string",
- "status": {
- "battery": {
- "level": 0,
- "status": 0,
- "voltage": 0
}, - "configID": "string",
- "group": "string",
- "gsm": "string",
- "lastAlarmID": "string",
- "pagerSerialNumber": "string",
- "signalStrength": 0,
- "time": "2021-03-03T10:35:37Z",
- "username": "string",
- "version": {
- "hardware": "string",
- "software": "string"
}
}, - "userId": 0
}
Remove a pager from the given organization
pagerID required | int64 ID of an existing pager configuration |
organization_id required | int64 requested organization |
removed pager from organization
passed pagerID / organization_id missing or in wrong format
Unexpected database error
{- "status": "deleted"
}
Set a pager as personal device of the given user
pagerID required | int64 ID of an existing pager configuration |
userID required | int64 ID of an existing user |
organization_id | int64 requesting organization; zero if user |
update successful
passed pagerID / userID missing or in wrong format
organization is not allowed to assign this pager
Unexpected database error
Returns pager statistics for given organization
organization_id required | int64 requested organization |
pager statistics for passed organization
no organizationID in request
Unexpected database error
[- {
- "online": 0,
- "registered": 0
}
]
Returns whether the given organization has disabled this way of alarming or not
organization_id required | int64 requesting organization |
whether this way of alarming is disabled or not
organization_id is missing or in wrong format
Unexpected database error
[- {
- "isDisabled": true
}
]
Sets whether the given organization has this way of alarming disabled or not
organization_id required | int64 requesting organization |
isDisabled payload
isDisabled | boolean |
request successful
organization_id is missing or in wrong format
Unexpected database error
{- "isDisabled": true
}
Force a pager to init itself again
pager request payload
organizationId | integer <int64> organization, which is managing this pager |
pagerIds | Array of integers <int64> list of receiving pager-ids |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "organizationId": 0,
- "pagerIds": [
- 0
]
}
Lock the pager and prevent any further use
pager request payload
organizationId | integer <int64> organization, which is managing this pager |
pagerIds | Array of integers <int64> list of receiving pager-ids |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "organizationId": 0,
- "pagerIds": [
- 0
]
}
Force a pager to reset (to default settings)
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> list of receiving pager-ids |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "factoryReset": true,
- "organizationId": 0,
- "pagerIds": [
- 0
]
}
Request a status update from the pager
pager request payload
organizationId | integer <int64> organization, which is managing this pager |
pagerIds | Array of integers <int64> list of receiving pager-ids |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "organizationId": 0,
- "pagerIds": [
- 0
]
}
Send the given text like an alarm onto the pager's display
pager request text alarm payload
message | string message to display |
organizationId | integer <int64> organization, which is managing this pager |
pagerIds | Array of integers <int64> list of receiving pager-ids |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "message": "string",
- "organizationId": 0,
- "pagerIds": [
- 0
]
}
Display the given text on the pager's display
pager request text display payload
organizationId | integer <int64> organization, which is managing this pager |
pagerIds | Array of integers <int64> list of receiving pager-ids |
text | string text to display |
operation successful
data in payload is invalid
user or organization are not allowed to manage pager
unexpected error
{- "organizationId":