Skip to content

Update alarm_api_v1.md #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stefblsms wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update alarm_api_v1.md #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions alarm_api_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- V1.3: List Alarm end point added
- V1.4: Change of Alarm Data Element: extension of recipients, deprecation of participants, Geolocation added (2017-01-19)
- V1.5: extended the API by indexNumber
- V1.6: added hideAfter and keyword parameters

## General

Expand Down Expand Up @@ -36,6 +37,8 @@ To trigger an alarm, send an HTTP POST REQUEST with header `Content-Type: applic
- alarmText: string - optional - content of alarm
- indexNumber: integer- optional - The index number serves to distinguish different alarms. A second alarm with the same index number will update the alarm text.
- needsAcknowledgement: boolean - mandatory - reply function
- hideAfter: integer - optional - the alarm is anonymized after the integer's value in days - values <=0 mean no anonymization
- keyword: string - optional - keyword of the alarm, e.g. "B1"
- startDate: string - optional - The date of an alarm in case it is to be triggered in the future. The format shall be UTC e.g. :`"2017-01-27T14:49:52.000Z"`
- duration: integer - conditional - duration for which the reply function is enabled
- recipientConfirmation: boolean - optional - turn on/off confirmation that SMS was received (charges apply)
Expand Down