You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
- V1.4:Änderung des Alarm Data Element:Erweiterung der recipients,Deprecation der participants, Geolocationhinzugefügt (2017-01-19)
9
-
- V1.5:Erweiterung der APIum die indexNumber
6
+
- V1.2: recipientConfirmationparameter added
7
+
- V1.3: List Alarmend point added
8
+
- V1.4:Change of Alarm Data Element:extension of recipients,deprecation of participants, Geolocationadded (2017-01-19)
9
+
- V1.5:extended the APIby indexNumber
10
10
11
-
##Allgemein
11
+
##General
12
12
13
13
###Encoding
14
-
Encodingist immer UTF-8.
14
+
Encodingshall be UTF-8.
15
15
16
-
###TestBasis URL
16
+
###TestBase URL
17
17
https://api-staging.blaulichtsms.net/blaulicht
18
18
19
-
###LiveBasis URL
19
+
###LiveBase URL
20
20
https://api.blaulichtsms.net/blaulicht
21
21
22
22
##Alarm API
23
23
24
-
Für die Verwendung dieser API muss man als "Automatisierter Alarmgeber" im System hinterlegt sein und erhält einen Benutzernamen und Passwort.
24
+
In order to be able to use this API, an "automatic alarm trigger" with username and password must be configured for the relevant customerId(s).
25
25
26
26
###Trigger Alarm
27
27
_**/api/alarm/v1/trigger**_
28
28
29
-
Um einen Alarm zu triggern muss man einenHTTP POSTRequest mit dem Header:`Content-Type: application/json`auf die oben angebeneURL absenden.
30
-
31
-
- username: string -verpflichtend -Benutzername
32
-
- password: string -verpflichtend -Passwort
33
-
- customerId: string -verpflichtend -Kundennummer
34
-
- type: alarm | info -verpflichtend -Der Alarmtyp
35
-
- hideTriggerDetails: boolean - optional -Alarmgeberdetails nicht mitsenden
36
-
- alarmText: string - optional -Der Alarmtext
37
-
- indexNumber: integer- optional -Die Index Nummer dient zur Identifikation von zwei identen Alarmen. Achtung: Falls zwei oder mehr Alarme mit der selben Index Nummer ausgelöst werden, werden die späteren ignoriert.
- startDate: string - optional -Das Startdatum für den Alarm, falls der Alarm in der Zukunft starten soll. Der Timestamp muss im UTCFormat übertragen werden z.B. :`"2017-01-27T14:49:52.000Z"`
40
-
- duration: integer - conditional -Dauer der Antwortfunktion in Minuten
- groupCodes: list of strings - optional -Alarmgruppen z.b.`["G1"]`
45
-
- additionalMsisdns: list of strings - optional -Nummern die zusätzlich alarmiert werden sollen z.B.:`["+4366412345678", "+4367612345678"]`
46
-
- coordinates: object of Type Coordinate - optional -Alarmkoordinaten
47
-
- geolocation: object of Type Geolocation - optional -Alternativ kann man statt den Koordinaten auch ein Geolocation Objekt mit einer Adresse übergeben. Diese wird anschließend in Koordinaten umgewandelt z.B.:`{"address": "Getreidemartk 11, 1060 Wien"}`
48
-
49
-
Ein Beispiel:
29
+
To trigger an alarm, send anHTTP POSTREQUEST with header`Content-Type: application/json`to the aboveURL.
30
+
31
+
- username: string -mandatory -username
32
+
- password: string -mandatory -password
33
+
- customerId: string -mandatory -customer ID
34
+
- type: alarm | info -mandatory -event type
35
+
- hideTriggerDetails: boolean - optional -do not send details of alarm trigger
36
+
- alarmText: string - optional -content of alarm
37
+
- indexNumber: integer- optional -The index number serves to distinguish different alarms. A second alarm with the same index number will be ignored.
38
+
- needsAcknowledgement: boolean -mandatory -reply function
39
+
- startDate: string - optional -The date of an alarm in case it is to be triggered in the future. The format shall be UTCe.g. :`"2017-01-27T14:49:52.000Z"`
40
+
- duration: integer - conditional -duration for which the reply function is enabled
41
+
- recipientConfirmation: boolean - optional -turn on/off confirmation that SMS was received (charges apply)
42
+
- recipientConfirmationTarget: string - optional -msisdn of recipient of SMS confirmation
43
+
- template: string - optional -Alarm text code e.g.`"A1"`
44
+
- groupCodes: list of strings - optional -Alarm group(s) e.g.`["G1"]`
45
+
- additionalMsisdns: list of strings - optional -additional msidns to be alerted e.g.:`["+4366412345678", "+4367612345678"]`
46
+
- coordinates: object of Type Coordinate - optional -coordinated of location of alarm
47
+
- geolocation: object of Type Geolocation - optional -instead of coordinates, a Geolocation object containing an address may also be provided. This address will then be converted to coordinates e.g.:`{"address": "Getreidemartk 11, 1060 Wien"}`
48
+
49
+
An example:
50
50
51
51
{
52
52
"username" : "myUser",
53
53
"password" : "mySuperSecretPwd",
54
54
"customerId" : "100027",
55
55
"hideTriggerDetails" : false,
56
-
"alarmText" : "Das ist ein Testalarm",
56
+
"alarmText" : "This is a test",
57
57
"type" : "alarm",
58
58
"needsAcknowledgement" : true,
59
59
"duration" : 60,
@@ -67,28 +67,29 @@ Ein Beispiel:
67
67
}
68
68
}
69
69
70
-
Im Erfolgsfall erhält man z.B. folgendes Resultat. Die möglichen Werte für**result** sind weiter unten angegeben. Im Fehlerfall ist dem Feld**description** eine Beschreibung des Fehlers zu entnehmen.
70
+
The following is an exapmple of a successful API call.
71
+
A list of all possible values of**result** is provided further down. In case of an error the field**description** contains a description of the error.
Um einen Alarm zu suchen muss man einenHTTP POST Requestmit dem Header:`Content-Type: application/json`auf die oben angebeneURLabsenden.
85
+
To search for an alarm, send anHTTP POST Requestwith header`Content-Type: application/json`to theURLmentioned above.
85
86
86
-
- username: string -verpflichtend -Benutzername
87
-
- password: string -verpflichtend -Passwort
88
-
- customerId: string -verpflichtend -Kundennummer
89
-
- alarmid: string -verpflichtend -DieAlarmId (wird beim Auslösen eines Alarms zurückgegeben)
87
+
- username: string -mandatory -username
88
+
- password: string -mandatory -password
89
+
- customerId: string -mandatory -customer ID
90
+
- alarmid: string -mandatory - AlarmId (is returned upon triggering an alarm)
90
91
91
-
Ein Beispiel:
92
+
An example:
92
93
93
94
{
94
95
"username" : "myUser",
@@ -97,27 +98,28 @@ Ein Beispiel:
97
98
"alarmId" : "dakldjsfal-2343232-afsdaddfa-234"
98
99
}
99
100
100
-
Im Erfolgsfall erhält man z.B. folgendes Resultat. Die möglichen Werte für**result** sind weiter unten angegeben. Im Fehlerfall ist dem Feld**description** eine Beschreibung des Fehlers zu entnehmen.
101
+
The following is an exapmple of a successful API call.
102
+
A list of all possible values of**result** is provided further down. In case of an error the field**description** contains a description of the error.
Um eine Liste von Alarmen zu erhalten muss man einenHTTP POST Requestmit dem Header:`Content-Type: application/json`auf die oben angebeneURLabsenden. Man erhält eine Liste vonAlarmDataObjekten. Es werden maximal 100 Alarme geliefert - sortiert nach Enddatum des Alarms.
116
+
To get a list of alarms, send anHTTP POST Requestwith header`Content-Type: application/json`to theURLmentioned above. You will receive a list ofAlarmDataobjects. Only 100 alarms will be returned, sorted by the end date of the alarm.
115
117
116
-
- username: string -verpflichtend -Benutzername
117
-
- password: string -verpflichtend -Passwort
118
-
- customerIds: list of string -verpflichtend -Liste von Kundennummern
119
-
- startDate: date in iso format - optional -Startdatum der Suche (alle Alarme mit End-Datum danach werden geliefert)
120
-
- endDate: date in iso format - optional -Enddatum der Suche (alle Alarme mit Start-Datum davor werden geliefert)
118
+
- username: string -mandatory -username
119
+
- password: string -mandatory -password
120
+
- customerIds: list of string -mandatory -list of customer IDs
121
+
- startDate: date in iso format - optional -start date for search (all alarms with later end date will be returned)
122
+
- endDate: date in iso format - optional -end date for search (all alarms with prior start date will be returned)
121
123
122
124
Ein Beispiel:
123
125
@@ -129,44 +131,45 @@ Ein Beispiel:
129
131
"endDate" : "2016-01-01T17:30:00.000Z"
130
132
}
131
133
132
-
Im Erfolgsfall erhält man z.B. folgendes Resultat. Die möglichen Werte für**result** sind weiter unten angegeben. Im Fehlerfall ist dem Feld**description** eine Beschreibung des Fehlers zu entnehmen.
134
+
The following is an exapmple of a successful API call.
135
+
A list of all possible values of**result** is provided further down. In case of an error the field**description** contains a description of the error.