Pager API specification (2.8.0)

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

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

Content type

application/json

Copy

Expand all Collapse all


[
{"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": "2020-04-02T13:56:32Z",
"username": "string",
"version": 
{"hardware": "string",
"software": "string"
}
},
"userId": 0
}
]

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

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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"active": true,
"name": "string",
"organizationId": 0,
"serialNumber": "string",
"userId": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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": "2020-04-02T13:56:32Z",
"username": "string",
"version": 
{"hardware": "string",
"software": "string"
}
},
"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

Content type

application/json

Copy

Expand all Collapse all


[
{"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": "2020-04-02T13:56:32Z",
"username": "string",
"version": 
{"hardware": "string",
"software": "string"
}
},
"userId": 0
}
]

UpdatePager

Updates an existing pager configuration

path Parameters

pagerID

required

int64

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
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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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": "2020-04-02T13:56:32Z",
"username": "string",
"version": 
{"hardware": "string",
"software": "string"
}
},
"userId": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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": "2020-04-02T13:56:32Z",
"username": "string",
"version": 
{"hardware": "string",
"software": "string"
}
},
"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

Content type

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

Content type

application/json

Copy

Expand all Collapse all


[
{"online": 0,
"registered": 0
}
]

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

Content type

application/json

Copy

Expand all Collapse all


[
{"isDisabled": true
}
]

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 payload

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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"organizationId": 0,
"pagerIds": 
[0
]
}

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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"organizationId": 0,
"pagerIds": 
[0
]
}

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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"factoryReset": true,
"organizationId": 0,
"pagerIds": 
[0
]
}

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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"organizationId": 0,
"pagerIds": 
[0
]
}

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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"message": "string",
"organizationId": 0,
"pagerIds": 
[0
]
}

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> 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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"organizationId": 0,
"pagerIds": 
[0
],
"text": "string"
}