resqueserve-core 4.0.0-258 → 4.0.0-260

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/main.d.ts CHANGED
@@ -72,12 +72,9 @@ export interface BuildArea {
72
72
  */
73
73
  dispatchGroups: string;
74
74
  }
75
- /**
76
- * Represents the keyword associated with an emergency, which acts as a key identifier in categorizing and managing the dispatch of units based on specific emergency conditions and requirements.
77
- *
78
- */
79
75
  export interface BuildKeyword {
80
- requiredEquipment: KeywordEquipment[] | null;
76
+ id: number;
77
+ commandcenterId: number;
81
78
  /**
82
79
  * The name of the keyword used for search and identification purposes.
83
80
  *
@@ -158,6 +155,11 @@ export interface BuildKeyword {
158
155
  *
159
156
  */
160
157
  dispatchGroups: string;
158
+ /**
159
+ * A list of equipment required for handling the emergency, linked to this keyword.
160
+ *
161
+ */
162
+ requiredEquipment: IKeywordEquipment[] | null;
161
163
  }
162
164
  /**
163
165
  * Represents a data structure for scheduling simulated emergencies based on time and category within a dispatch center's operational plans. This record allows setting specific hours and the corresponding number of emergencies to be generated.
@@ -180,12 +182,10 @@ export interface BuildMissionLoad {
180
182
  */
181
183
  amount: number;
182
184
  }
183
- /**
184
- * Represents a point of interest (POI) such as hospitals, fire stations, or other locations.
185
- *
186
- */
187
185
  export interface BuildPoi {
188
186
  addressId: number | null;
187
+ id: number;
188
+ commandcenterId: number;
189
189
  /**
190
190
  * The name of the point of interest. Is unique inside a dispatch center.
191
191
  *
@@ -334,6 +334,8 @@ export interface BuildTaskTemplate {
334
334
  *
335
335
  */
336
336
  conditions: BuildTaskCondition[] | null;
337
+ id: number;
338
+ commandcenterId: number;
337
339
  /**
338
340
  * Gets or sets the description of the task template.
339
341
  *
@@ -794,6 +796,7 @@ export interface Commandcenter {
794
796
  *
795
797
  */
796
798
  options: CommandcenterOption[] | null;
799
+ unitStatusWhenUnitIsOnStandbyLocation: UnitStatus;
797
800
  }
798
801
  /**
799
802
  * Enables the creation of custom equipment for units within a command center, which assists in the suggestion process during dispatch operations but does not influence simulation outcomes directly.
@@ -882,7 +885,7 @@ export interface PoiLookupDto {
882
885
  *
883
886
  */
884
887
  export interface ResourceLookupDto {
885
- id: string | null;
888
+ unitId: number | null;
886
889
  unitStatus: UnitStatus | null;
887
890
  category: string;
888
891
  callsign: string;
@@ -1066,7 +1069,6 @@ export interface PoiInformation {
1066
1069
  *
1067
1070
  */
1068
1071
  export interface ResourceInformation {
1069
- id: string | null;
1070
1072
  unitId: number | null;
1071
1073
  staticPosition: Coordinates | null;
1072
1074
  dynamicPosition: Coordinates | null;
@@ -1083,14 +1085,13 @@ export interface ResourceInformation {
1083
1085
  currentOperation: string;
1084
1086
  duty: string;
1085
1087
  }
1086
- /**
1087
- * Represents the keyword associated with an emergency, which acts as a key identifier in categorizing and managing the dispatch of units based on specific emergency conditions and requirements.
1088
- *
1089
- */
1090
1088
  export interface Keyword {
1091
1089
  id: number;
1092
1090
  commandcenterId: number;
1093
- requiredEquipment: KeywordEquipment[] | null;
1091
+ /**
1092
+ * The name of the keyword used for search and identification purposes.
1093
+ *
1094
+ */
1094
1095
  name: string;
1095
1096
  /**
1096
1097
  * Indicates if the emergency is urgent, which may prompt units to use sirens.
@@ -1167,14 +1168,14 @@ export interface Keyword {
1167
1168
  *
1168
1169
  */
1169
1170
  dispatchGroups: string;
1171
+ /**
1172
+ * A list of equipment required for handling the emergency, linked to this keyword.
1173
+ *
1174
+ */
1175
+ requiredEquipment: IKeywordEquipment[] | null;
1170
1176
  }
1171
- /**
1172
- * Represents a specific type of equipment associated with a keyword, detailing the quantity needed and the type of equipment. This record is used to manage equipment requirements for specific emergency scenarios as specified by keywords.
1173
- *
1174
- */
1175
1177
  export interface KeywordEquipment {
1176
1178
  id: number;
1177
- keywordId: number;
1178
1179
  /**
1179
1180
  * The amount of this equipment type required for the associated emergency scenario.
1180
1181
  *
@@ -1204,59 +1205,6 @@ export interface KeywordTask {
1204
1205
  */
1205
1206
  text: string;
1206
1207
  }
1207
- /**
1208
- * Represents a geographical location, including details such as address, point of interest, coordinates, and location accuracy. This record is used throughout the dispatch system to manage and validate the positions of units and incidents.
1209
- *
1210
- */
1211
- export interface Location {
1212
- /**
1213
- * Point of interest associated with the location, if applicable.
1214
- *
1215
- */
1216
- poi: Poi;
1217
- /**
1218
- * Specifies the names of the properties that should be used in the stable hash calculation.
1219
- *
1220
- * @returns A list of property names to be included in the hash.
1221
- */
1222
- hashProperties: string[] | null;
1223
- /**
1224
- * Gets a value indicating whether the location has been set through a point of interest (POI) or an address.
1225
- *
1226
- *
1227
- * @remarks
1228
- * Returns true if the location has been set by a point of interest or an address; otherwise, false.
1229
- */
1230
- isLocationSet: boolean;
1231
- /**
1232
- * Gets a value indicating whether the coordinates have been successfully resolved for the location.
1233
- *
1234
- *
1235
- * @remarks
1236
- * Returns true if the location has been set and coordinates are not null; otherwise, false.
1237
- */
1238
- isCoordinatesResolved: boolean;
1239
- /**
1240
- * Primary address details of the location.
1241
- *
1242
- */
1243
- address: Address;
1244
- /**
1245
- * House number at the location, if applicable.
1246
- *
1247
- */
1248
- houseNumber: string;
1249
- /**
1250
- * Geographical coordinates of the location.
1251
- *
1252
- */
1253
- coordinates: Coordinates | null;
1254
- /**
1255
- * Specifies the accuracy of the coordinates from the geocoding process.
1256
- *
1257
- */
1258
- accuracy: LocationAccuracy;
1259
- }
1260
1208
  /**
1261
1209
  * Represents a data structure for scheduling simulated emergencies based on time and category within a dispatch center's operational plans. This record allows setting specific hours and the corresponding number of emergencies to be generated.
1262
1210
  *
@@ -1280,1300 +1228,1300 @@ export interface MissionLoad {
1280
1228
  */
1281
1229
  amount: number;
1282
1230
  }
1283
- /**
1284
- * Represents a notification in a dispatch center session.
1285
- *
1286
- */
1287
- export interface Notification {
1288
- /**
1289
- * Gets the unique identifier of the session associated with this entity.
1290
- *
1291
- */
1292
- sessionId: number;
1231
+ export interface Patient {
1293
1232
  id: string;
1233
+ operationId: string;
1294
1234
  /**
1295
- * Gets the date and time when the notification was created.
1235
+ * Gets or sets the first name of the person.
1296
1236
  *
1297
1237
  */
1298
- createdOn: string;
1238
+ firstName: string;
1299
1239
  /**
1300
- * Gets or sets a value indicating whether the notification requires a resolution.
1240
+ * Gets or sets the middle name of the person.
1301
1241
  *
1302
1242
  */
1303
- isRequiredToBeSolved: boolean;
1243
+ middleName: string;
1304
1244
  /**
1305
- * Gets or sets the agent associated with the notification, may be null if not applicable.
1245
+ * Gets or sets the last name of the person.
1306
1246
  *
1307
1247
  */
1308
- agent: IUserInformation;
1248
+ lastName: string;
1309
1249
  /**
1310
- * Gets the category of the notification.
1250
+ * Gets or sets the gender of the person.
1311
1251
  *
1312
1252
  */
1313
- category: NotificationCategory;
1253
+ gender: Gender | null;
1314
1254
  /**
1315
- * Gets or sets the text of the notification.
1255
+ * Gets or sets the date of birth of the person.
1316
1256
  *
1317
1257
  */
1318
- text: string;
1258
+ dateOfBirth: string | null;
1319
1259
  /**
1320
- * Gets or sets the identifier of the operation to which the notification is applicable, may be null.
1260
+ * Gets or sets the insurance number of the patient, if available.
1321
1261
  *
1322
1262
  */
1323
- applicableOperationId: string | null;
1263
+ insuranceNumber: string;
1324
1264
  /**
1325
- * Gets or sets the identifier of the unit to which the notification is applicable, may be null.
1265
+ * Gets or sets the destination location for the patient.
1326
1266
  *
1327
1267
  */
1328
- applicableResourceId: string | null;
1268
+ destination: IGeoReferenced;
1329
1269
  }
1330
- /**
1331
- * Represents an operation with various details such as caller information, status, location, and associated resources and tasks.
1332
- *
1333
- */
1334
- export interface Operation {
1335
- id: string;
1336
- keywords: Keyword[] | null;
1337
- patients: {
1338
- [key: string]: Patient;
1339
- };
1340
- resources: {
1341
- [key: string]: OperationResource;
1342
- };
1343
- documentations: {
1344
- [key: string]: OperationDocumentation;
1345
- };
1346
- tasks: {
1347
- [key: string]: OperationTask;
1348
- };
1349
- events: {
1350
- [key: string]: OperationEvent;
1351
- };
1352
- location: Location;
1353
- /**
1354
- * Gets or sets the internal operation number.
1355
- *
1356
- */
1357
- numberInternal: string;
1270
+ export interface Poi {
1271
+ id: number;
1272
+ commandcenterId: number;
1358
1273
  /**
1359
- * Gets or sets the external operation number.
1274
+ * The name of the point of interest. Is unique inside a dispatch center.
1360
1275
  *
1361
1276
  */
1362
- numberExternal: string;
1277
+ name: string;
1363
1278
  /**
1364
- * Gets or sets the name of the caller.
1279
+ * The category of the point of interest.
1365
1280
  *
1366
1281
  */
1367
- callerName: string;
1282
+ category: PoiCategory;
1368
1283
  /**
1369
- * Gets or sets the phone number of the caller.
1284
+ * Tags associated with the point of interest for search purposes. Separate multiple tags with a comma.
1370
1285
  *
1371
1286
  */
1372
- callerNumber: PhoneNumber;
1287
+ searchTags: string;
1373
1288
  /**
1374
- * Gets or sets the date and time the operation was created.
1289
+ * The verbal name of the point of interest. May be used on radio or calls.
1375
1290
  *
1376
1291
  */
1377
- createdOn: string;
1292
+ verbalName: string;
1378
1293
  /**
1379
- * Gets or sets the date and time the operation was dispatched.
1294
+ * The German genus of the point of interest (der, die, das).
1380
1295
  *
1381
1296
  */
1382
- dispatchedOn: string | null;
1297
+ germanGenus: string;
1383
1298
  /**
1384
- * Gets or sets the date and time the operation was finished.
1299
+ * The hospital departments associated with the hospital POI if is hospital. Has no effect if is true.
1385
1300
  *
1386
1301
  */
1387
- finishedOn: string | null;
1302
+ hospitalDepartments: PoiHospitalDepartment[] | null;
1388
1303
  /**
1389
- * Gets or sets the scheduled pick-up date and time for the operation. A reminder notification will be created based on this value.
1304
+ * Indicates whether units should be dispatched together when assigned to this POI. Should be true if non-volunteer department.
1390
1305
  *
1391
1306
  */
1392
- scheduledPickUpOn: string | null;
1307
+ isUnitsMoveOutTogether: boolean;
1393
1308
  /**
1394
- * Gets or sets the user information for the creator of the operation.
1309
+ * The bonus or malus value associated with the point of interest (POI). Must be a value between -100 or +100 (%). This value affects the calculated distance if the POI is a hospital. Units will always prioritize the nearest hospital with the required hospital departments.
1395
1310
  *
1396
1311
  */
1397
- createdBy: IUserInformation;
1312
+ bonusMalus: number;
1398
1313
  /**
1399
- * Gets or sets the user information for the dispatcher of the operation.
1314
+ * Indicates whether the hospital is a maximum care hospital and has all .
1400
1315
  *
1401
1316
  */
1402
- dispatchedBy: IUserInformation;
1317
+ isMaxCareHospital: boolean;
1403
1318
  /**
1404
- * Gets or sets the user information for the person who closed the operation.
1319
+ * Indicates whether the hospital is an external hospital. External hospitals do not generate patient transports, but units may use them as destinations for patients.
1405
1320
  *
1406
1321
  */
1407
- finishedBy: IUserInformation;
1322
+ isExternalHospital: boolean;
1408
1323
  /**
1409
- * Gets or sets internal information about the operation
1324
+ * Indicates whether patient information transmission is automatic at this POI. Units will transmit patient information to the hospital non-verbally if this property is set to true.
1410
1325
  *
1411
1326
  */
1412
- informationInternal: string;
1327
+ isAutomaticPatientTransmission: boolean;
1413
1328
  /**
1414
- * Gets or sets external information about the operation.
1329
+ * Indicates whether a fire alarm system is present at this POI. The presence of a fire alarm system may generate calls.
1415
1330
  *
1416
1331
  */
1417
- informationExternal: string;
1332
+ isWithFireAlarmSystem: boolean;
1418
1333
  /**
1419
- * Gets or sets the priority of the operation.
1334
+ * Indicates whether the object name is shown as the caller number for this POI or a random number is generated. .
1420
1335
  *
1421
1336
  */
1422
- priority: OperationPriority;
1337
+ isNameCallerNumber: boolean;
1338
+ coordinates: Coordinates | null;
1339
+ houseNumber: string;
1340
+ address: Address;
1341
+ }
1342
+ export interface Preselection {
1343
+ operationId: string;
1423
1344
  /**
1424
- * Gets or sets the current status of the operation.
1345
+ * Gets or sets the estimated time required for the resource to reach the target.
1425
1346
  *
1426
1347
  */
1427
- status: OperationStatus;
1348
+ routeTimeToTarget: string | null;
1428
1349
  /**
1429
- * Gets or sets the duration of the operation.
1350
+ * Gets or sets the estimated distance in meters for the resource to reach the target.
1430
1351
  *
1431
1352
  */
1432
- duration: string;
1353
+ metersToTarget: number | null;
1354
+ resource: IUnitResource;
1433
1355
  }
1434
1356
  /**
1435
- * Represents documentation for an operation, including metadata such as the creator, creation date, and textual content.
1357
+ * Represents a radio group that can be associated with units.
1436
1358
  *
1437
1359
  */
1438
- export interface OperationDocumentation {
1360
+ export interface Radiogroup {
1361
+ id: number;
1362
+ commandcenterId: number;
1439
1363
  /**
1440
- * Gets the unique identifier for the entity.
1364
+ * The callsign of the command center associated with the radio group. Units will use this callsign to talk to the dispatch center.
1441
1365
  *
1442
1366
  */
1443
- id: string;
1367
+ commandcenterCallsign: string;
1444
1368
  /**
1445
- * Gets the unique identifier of the operation associated with this entity.
1369
+ * The name of the radio group.
1446
1370
  *
1447
1371
  */
1448
- operationId: string;
1372
+ name: string;
1449
1373
  /**
1450
- * Gets or sets the date and time when this documentation was created.
1374
+ * Indicates whether the radio group is the "first call" radio group for external units. Only one is allowed per dispatch center.
1451
1375
  *
1452
1376
  */
1453
- createdOn: string;
1377
+ isCommandcenterCallGroup: boolean;
1378
+ }
1379
+ /**
1380
+ * Represents event arguments for a notification-related session event.
1381
+ *
1382
+ */
1383
+ export interface NotificationSessionEventArgs {
1454
1384
  /**
1455
- * Gets or sets the user information of the individual who created this documentation.
1385
+ * Gets or sets the notification associated with the session event.
1456
1386
  *
1457
1387
  */
1458
- createdBy: IUserInformation;
1388
+ notification: INotification;
1389
+ }
1390
+ /**
1391
+ * Represents event arguments for an event involving operation documentation.
1392
+ *
1393
+ */
1394
+ export interface OperationDocumentationSessionEventArgs {
1459
1395
  /**
1460
- * Gets or sets the textual content of the documentation.
1396
+ * Gets or sets the operation documentation associated with the session event.
1461
1397
  *
1462
1398
  */
1463
- text: string;
1399
+ operationDocumentation: IOperationDocumentation;
1464
1400
  }
1465
1401
  /**
1466
- * Represents an event within an operation, including details such as event category, creation timestamp, and descriptive text.
1402
+ * Represents event arguments for an operation involving a resource within a session event.
1467
1403
  *
1468
1404
  */
1469
- export interface OperationEvent {
1405
+ export interface OperationResourceSessionEventArgs {
1470
1406
  /**
1471
- * Gets the unique identifier for the entity.
1407
+ * Gets or sets the operation resource associated with the session event.
1472
1408
  *
1473
1409
  */
1474
- id: string;
1410
+ operationResource: IOperationResource;
1411
+ }
1412
+ /**
1413
+ * Represents event arguments for an event involving an operation.
1414
+ *
1415
+ */
1416
+ export interface OperationSessionEventArgs {
1475
1417
  /**
1476
- * Gets the unique identifier of the operation associated with this entity.
1418
+ * Gets or sets the operation associated with the session event.
1477
1419
  *
1478
1420
  */
1479
- operationId: string;
1421
+ operation: IOperation;
1422
+ }
1423
+ /**
1424
+ * Represents event arguments for an event involving an operation task.
1425
+ *
1426
+ */
1427
+ export interface OperationTaskSessionEventArgs {
1480
1428
  /**
1481
- * Gets or sets the date and time when this event was created.
1429
+ * Gets or sets the operation task associated with the session event.
1482
1430
  *
1483
1431
  */
1484
- createdOn: string;
1432
+ operationTask: IOperationTask;
1433
+ }
1434
+ /**
1435
+ * Represents event arguments for an event involving a patient person.
1436
+ *
1437
+ */
1438
+ export interface PatientSessionEventArgs {
1485
1439
  /**
1486
- * Gets or sets the category of the event, represented by the .
1440
+ * Gets or sets the patient person associated with the session event.
1487
1441
  *
1488
1442
  */
1489
- category: OperationEventCategory;
1443
+ patient: IPatient;
1444
+ }
1445
+ /**
1446
+ * Represents event arguments for a property change within a session event.
1447
+ *
1448
+ */
1449
+ export interface PropertyChangedSessionEventArgs {
1490
1450
  /**
1491
- * Gets or sets the descriptive text associated with this event.
1451
+ * Gets or sets the name of the property that changed.
1492
1452
  *
1493
1453
  */
1494
- text: string;
1495
- }
1496
- export interface OperationTask {
1454
+ propertyName: string;
1497
1455
  /**
1498
- * Gets the unique identifier of the operation associated with this entity.
1456
+ * Gets or sets the new value of the property.
1499
1457
  *
1500
1458
  */
1501
- operationId: string;
1459
+ propertyValue: Object;
1460
+ }
1461
+ /**
1462
+ * Represents event arguments for an event involving a resource.
1463
+ *
1464
+ */
1465
+ export interface ResourceSessionEventArgs {
1502
1466
  /**
1503
- * Gets or sets the identifier associated with the task.
1467
+ * Gets or sets the resource involved in the session event.
1504
1468
  *
1505
1469
  */
1506
- id: string;
1470
+ resource: IUnitResource;
1471
+ }
1472
+ /**
1473
+ * Represents the base class for session event arguments.
1474
+ *
1475
+ */
1476
+ export interface SessionEventArgs {
1477
+ }
1478
+ /**
1479
+ * Represents event arguments for an event involving a workplace.
1480
+ *
1481
+ */
1482
+ export interface WorkplaceSessionEventArgs {
1507
1483
  /**
1508
- * Gets or sets the session identifier associated with the task.
1484
+ * Gets or sets the workplace associated with the session event.
1509
1485
  *
1510
1486
  */
1487
+ workplace: IWorkplace;
1488
+ }
1489
+ /**
1490
+ * Represents a webhook for registering HTTP callbacks to handle managed session events.
1491
+ *
1492
+ */
1493
+ export interface SessionWebhook {
1494
+ id: number;
1511
1495
  sessionId: number;
1496
+ headers: {
1497
+ [key: string]: string;
1498
+ };
1499
+ events: SessionEventType[] | null;
1512
1500
  /**
1513
- * Gets or sets the task template used to create this task.
1501
+ * Gets or sets the URL to which the webhook will send HTTP requests.
1514
1502
  *
1515
1503
  */
1516
- template: ITaskTemplate;
1504
+ url: string;
1517
1505
  /**
1518
- * Gets or sets notes related to the task.
1506
+ * Gets or sets the HTTP method used for the webhook (e.g., GET, POST).
1519
1507
  *
1520
1508
  */
1521
- notes: string;
1509
+ method: SessionWebhookMethod | null;
1510
+ }
1511
+ /**
1512
+ * Represents a status page used for displaying unit statuses.
1513
+ *
1514
+ */
1515
+ export interface Statuspage {
1516
+ id: number;
1517
+ commandcenterId: number;
1518
+ members: StatuspageMembers[] | null;
1522
1519
  /**
1523
- * Gets or sets the status of the task.
1520
+ * The name of the status page.
1524
1521
  *
1525
1522
  */
1526
- status: TaskStatus;
1523
+ name: string;
1527
1524
  /**
1528
- * Gets or sets the date and time the task was last completed.
1525
+ * The description of the status page.
1529
1526
  *
1530
1527
  */
1531
- lastCompletedOn: string | null;
1528
+ description: string;
1532
1529
  /**
1533
- * Gets or sets information about the user who last completed the task.
1530
+ * The sort number used to determine the order of status pages.
1534
1531
  *
1535
1532
  */
1536
- lastCompletedBy: IUserInformation;
1533
+ sortNumber: number;
1534
+ /**
1535
+ * The display option of the status page.
1536
+ *
1537
+ */
1538
+ displayOption: StatuspageDisplayOption;
1539
+ /**
1540
+ * If true, members in an inactive state will be hidden on the frontend.
1541
+ *
1542
+ */
1543
+ isInactiveResourcesHidden: boolean;
1537
1544
  }
1538
1545
  /**
1539
- * Represents a person with optional first, middle, and last names, gender, and date of birth.
1546
+ * Represents a unit associated with a status page. Will be grouped within other units by the value in .
1540
1547
  *
1541
1548
  */
1542
- export interface Patient {
1549
+ export interface StatuspageMembers {
1550
+ id: number | null;
1551
+ unitId: number | null;
1543
1552
  /**
1544
- * Gets or sets the insurance number of the patient, if available.
1553
+ * The group to which the unit belongs. Set new value or use existing. />.
1545
1554
  *
1546
1555
  */
1547
- insuranceNumber: string;
1556
+ group: string;
1548
1557
  /**
1549
- * Gets or sets the destination location for the patient.
1558
+ * Member will be sorted by this property, if set.
1550
1559
  *
1551
1560
  */
1552
- destination: Location;
1561
+ sortNumber: number;
1562
+ }
1563
+ export interface TaskCatalogItem {
1564
+ parameters: TaskCatalogParameter[] | null;
1553
1565
  /**
1554
- * Gets the unique identifier for the entity.
1566
+ * Gets or sets the implementation name of the task. This is the name specified in the ResQueServeTaskAttribute.
1555
1567
  *
1556
1568
  */
1557
- id: string;
1569
+ implementationName: string;
1558
1570
  /**
1559
- * Gets the unique identifier of the operation associated with this entity.
1571
+ * Gets or sets the display name of the task.
1560
1572
  *
1561
1573
  */
1562
- operationId: string;
1574
+ displayName: string;
1563
1575
  /**
1564
- * Gets or sets the first name of the person.
1576
+ * Gets or sets the description of the task.
1565
1577
  *
1566
1578
  */
1567
- firstName: string;
1579
+ description: string;
1568
1580
  /**
1569
- * Gets or sets the middle name of the person.
1581
+ * Gets or sets the category of the task.
1570
1582
  *
1571
1583
  */
1572
- middleName: string;
1584
+ category: string;
1573
1585
  /**
1574
- * Gets or sets the last name of the person.
1586
+ * Gets or sets the version of the task.
1575
1587
  *
1576
1588
  */
1577
- lastName: string;
1589
+ version: string;
1578
1590
  /**
1579
- * Gets or sets the gender of the person.
1591
+ * Gets or sets the priority of the task.
1580
1592
  *
1581
1593
  */
1582
- gender: Gender | null;
1594
+ priority: TaskPriority;
1583
1595
  /**
1584
- * Gets or sets the date of birth of the person.
1596
+ * Gets or sets the number of parameters the task requires.
1585
1597
  *
1586
1598
  */
1587
- dateOfBirth: string | null;
1588
- }
1589
- /**
1590
- * Represents a phone number with associated country and area code information.
1591
- *
1592
- */
1593
- export interface PhoneNumber {
1599
+ parameterCount: number;
1594
1600
  /**
1595
- * Gets the country associated with the phone number.
1601
+ * Gets or sets whether the task requires administrative privileges.
1596
1602
  *
1597
1603
  */
1598
- country: Country;
1604
+ requiresAdmin: boolean;
1605
+ }
1606
+ export interface TaskCatalogParameter {
1607
+ propertyName: string;
1599
1608
  /**
1600
- * Gets the country calling code derived from the enumeration.
1609
+ * Gets or sets the name of the parameter.
1601
1610
  *
1602
1611
  */
1603
- countryCode: string;
1612
+ displayName: string;
1604
1613
  /**
1605
- * Gets the area code for specific regions within the country.
1614
+ * Gets or sets the description of the parameter.
1606
1615
  *
1607
1616
  */
1608
- areaCode: string;
1617
+ description: string;
1609
1618
  /**
1610
- * Gets the local phone number.
1619
+ * Gets or sets whether this parameter is required.
1611
1620
  *
1612
1621
  */
1613
- number: string;
1614
- }
1615
- /**
1616
- * Represents a point of interest (POI) such as hospitals, fire stations, or other locations.
1617
- *
1618
- */
1619
- export interface Poi {
1620
- id: number;
1621
- commandcenterId: number;
1622
- address: Address;
1622
+ isRequired: boolean;
1623
1623
  /**
1624
- * The name of the point of interest. Is unique inside a dispatch center.
1624
+ * Gets or sets the default value for this parameter.
1625
1625
  *
1626
1626
  */
1627
- name: string;
1627
+ defaultValue: Object;
1628
1628
  /**
1629
- * The category of the point of interest.
1629
+ * Gets or sets the order in which this parameter should be displayed in a UI.
1630
1630
  *
1631
1631
  */
1632
- category: PoiCategory;
1632
+ order: number;
1633
1633
  /**
1634
- * Tags associated with the point of interest for search purposes. Separate multiple tags with a comma.
1634
+ * Gets or sets a validation pattern (regex) for string parameters.
1635
1635
  *
1636
1636
  */
1637
- searchTags: string;
1637
+ validationPattern: string;
1638
1638
  /**
1639
- * The verbal name of the point of interest. May be used on radio or calls.
1639
+ * Gets or sets whether this parameter is a secret (e.g. bearer token). Value will never be displayed on frontend.
1640
1640
  *
1641
1641
  */
1642
- verbalName: string;
1642
+ isSecret: boolean;
1643
1643
  /**
1644
- * The German genus of the point of interest (der, die, das).
1644
+ * Gets or sets the type of the parameter.
1645
1645
  *
1646
1646
  */
1647
- germanGenus: string;
1647
+ propertyType: string;
1648
+ }
1649
+ /**
1650
+ * Represents a condition used within a task.
1651
+ *
1652
+ */
1653
+ export interface TaskCondition {
1654
+ id: number;
1655
+ value: string;
1648
1656
  /**
1649
- * The hospital departments associated with the hospital POI if is hospital. Has no effect if is true.
1657
+ * Gets or sets the field to which the condition applies.
1650
1658
  *
1651
1659
  */
1652
- hospitalDepartments: PoiHospitalDepartment[] | null;
1660
+ field: TaskConditionField;
1653
1661
  /**
1654
- * Indicates whether units should be dispatched together when assigned to this POI. Should be true if non-volunteer department.
1662
+ * Gets or sets the operator used in the condition.
1655
1663
  *
1656
1664
  */
1657
- isUnitsMoveOutTogether: boolean;
1665
+ operator: TaskConditionOperator;
1666
+ }
1667
+ export interface TaskTemplate {
1658
1668
  /**
1659
- * The bonus or malus value associated with the point of interest (POI). Must be a value between -100 or +100 (%). This value affects the calculated distance if the POI is a hospital. Units will always prioritize the nearest hospital with the required hospital departments.
1669
+ * Gets or sets the conditions associated with the task template.
1660
1670
  *
1661
1671
  */
1662
- bonusMalus: number;
1672
+ conditions: TaskCondition[] | null;
1673
+ id: number;
1674
+ commandcenterId: number;
1663
1675
  /**
1664
- * Indicates whether the hospital is a maximum care hospital and has all .
1676
+ * Gets or sets the description of the task template.
1665
1677
  *
1666
1678
  */
1667
- isMaxCareHospital: boolean;
1679
+ description: string;
1668
1680
  /**
1669
- * Indicates whether the hospital is an external hospital. External hospitals do not generate patient transports, but units may use them as destinations for patients.
1681
+ * Gets or sets a value indicating whether the task is mandatory.
1670
1682
  *
1671
1683
  */
1672
- isExternalHospital: boolean;
1684
+ isMandatory: boolean;
1673
1685
  /**
1674
- * Indicates whether patient information transmission is automatic at this POI. Units will transmit patient information to the hospital non-verbally if this property is set to true.
1686
+ * Gets or sets the execution type of the task.
1675
1687
  *
1676
1688
  */
1677
- isAutomaticPatientTransmission: boolean;
1689
+ execution: TaskExecution;
1678
1690
  /**
1679
- * Indicates whether a fire alarm system is present at this POI. The presence of a fire alarm system may generate calls.
1691
+ * Gets or sets a value indicating whether all conditions must be met.
1680
1692
  *
1681
1693
  */
1682
- isWithFireAlarmSystem: boolean;
1694
+ requireAllConditions: boolean;
1683
1695
  /**
1684
- * Indicates whether the object name is shown as the caller number for this POI or a random number is generated. .
1696
+ * Gets or sets a value indicating whether a task should be created for each match found.
1685
1697
  *
1686
1698
  */
1687
- isNameCallerNumber: boolean;
1688
- coordinates: Coordinates | null;
1689
- houseNumber: string;
1690
- }
1691
- export interface Preselection {
1699
+ createTaskForEachMatch: boolean;
1692
1700
  /**
1693
- * Gets or sets the estimated time required for the resource to reach the target.
1701
+ * Indicates if the task is waiting for an external signal or callback to confirm success. If set to false, the task is considered successfully completed once the internal execution code completes.
1694
1702
  *
1695
1703
  */
1696
- routeTimeToTarget: string | null;
1704
+ requiresSuccessfulSignal: boolean;
1697
1705
  /**
1698
- * Gets or sets the estimated distance in meters for the resource to reach the target.
1706
+ * Defines a timeout in seconds for how long the task will wait before entering a failed state if is not executed in time.
1699
1707
  *
1700
1708
  */
1701
- metersToTarget: number | null;
1702
- sessionResource: SessionResource;
1709
+ timeoutSeconds: number | null;
1703
1710
  /**
1704
- * Gets the unique identifier for the entity.
1711
+ * Gets the name of the ResQueServeTask implementation to use for executing this task. This should match the Name property of a ResQueServeTaskAttribute registered in the system.
1705
1712
  *
1706
1713
  */
1707
- id: string;
1714
+ implementationName: string;
1708
1715
  /**
1709
- * Gets the unique identifier of the operation associated with this entity.
1716
+ * Gets or sets the parameters needed for task execution, keyed by parameter name.
1710
1717
  *
1711
1718
  */
1712
- operationId: string;
1719
+ parameters: {
1720
+ [key: string]: Object;
1721
+ };
1713
1722
  }
1714
1723
  /**
1715
- * Represents a radio group that can be associated with units.
1724
+ * Represents a unit within the area of a dispatch center.
1716
1725
  *
1717
1726
  */
1718
- export interface Radiogroup {
1727
+ export interface Unit {
1719
1728
  id: number;
1720
1729
  commandcenterId: number;
1721
1730
  /**
1722
- * The callsign of the command center associated with the radio group. Units will use this callsign to talk to the dispatch center.
1731
+ * The radio group associated with the unit. Is null if not set.
1723
1732
  *
1724
1733
  */
1725
- commandcenterCallsign: string;
1734
+ radiogroup: Radiogroup;
1726
1735
  /**
1727
- * The name of the radio group.
1736
+ * The point of interest (POI) where the unit is located.
1728
1737
  *
1729
1738
  */
1730
- name: string;
1739
+ poi: Poi;
1731
1740
  /**
1732
- * Indicates whether the radio group is the "first call" radio group for external units. Only one is allowed per dispatch center.
1741
+ * The point of interest (POI) where the doctor is picked up then value is set to .
1733
1742
  *
1734
1743
  */
1735
- isCommandcenterCallGroup: boolean;
1736
- }
1737
- export interface OperationResource {
1744
+ doctorPickupPoi: Poi;
1745
+ info: IUnitInformation;
1746
+ dutyPeriods: UnitDutyPeriod[] | null;
1738
1747
  /**
1739
- * Gets or sets the information of the user who dispatched the resource.
1748
+ * The (long) callsign of the unit.
1740
1749
  *
1741
1750
  */
1742
- dispatchedBy: IUserInformation;
1751
+ callsign: string;
1743
1752
  /**
1744
- * Gets or sets the date and time the resource was dispatched.
1753
+ * A short callsign variant of the unit.
1745
1754
  *
1746
1755
  */
1747
- dispatchOn: string;
1756
+ callsignShort: string;
1748
1757
  /**
1749
- * Gets or sets the date and time the resource dispatch was canceled.
1758
+ * The name of the point of interest (POI) where the unit is located.
1750
1759
  *
1751
1760
  */
1752
- cancelOn: string | null;
1761
+ station: string;
1753
1762
  /**
1754
- * Gets or sets the date and time the resource completed its task.
1763
+ * The category of the unit. By setting a value to , this can be cosmetically overridden.
1755
1764
  *
1756
1765
  */
1757
- completedOn: string | null;
1766
+ category: UnitCategory;
1758
1767
  /**
1759
- * Gets or sets the timestamps of various statuses of the resource.
1768
+ * The overridden category of the unit.
1760
1769
  *
1761
1770
  */
1762
- statusTimestamps: {
1763
- [key: number]: string;
1764
- };
1765
- sessionResource: SessionResource;
1771
+ categoryOverride: string;
1766
1772
  /**
1767
- * Gets the unique identifier for the entity.
1773
+ * The callsign displayed on maps if is set to true.
1768
1774
  *
1769
1775
  */
1770
- id: string;
1776
+ callsignGps: string;
1771
1777
  /**
1772
- * Gets the unique identifier of the operation associated with this entity.
1778
+ * The verbal callsign of the unit.
1773
1779
  *
1774
1780
  */
1775
- operationId: string;
1776
- }
1777
- export interface SessionResource {
1781
+ callsignVerbal: string;
1778
1782
  /**
1779
- * Gets or sets the static position of the unit, representing its station location when on duty without dispatch.
1783
+ * Indicates whether the unit is a first responder. This property affects suggestions and the unit's behavior on operation sites.
1780
1784
  *
1781
1785
  */
1782
- staticPosition: Coordinates;
1786
+ isFirstResponder: boolean;
1783
1787
  /**
1784
- * Gets or sets the dynamic GPS position of the unit, if available.
1788
+ * Indicates whether the unit is not a volunteer unit. Dispatch times will affect based on this value.
1785
1789
  *
1786
1790
  */
1787
- dynamicPosition: Coordinates | null;
1791
+ isNotVolunteerUnit: boolean;
1788
1792
  /**
1789
- * Gets or sets the timestamp indicating when the unit was put into preselection for an operation.
1793
+ * Indicates whether the unit starts in a new session with status . This property affects the visual representation only and does not affect the actual duty status of the unit. To control the unit's duty status, use the property. The unit will react to dispatches based on its duty status as determined by the .
1790
1794
  *
1791
1795
  */
1792
- suggestionOn: string | null;
1796
+ isStartingWithStatus6: boolean;
1793
1797
  /**
1794
- * Gets or sets the count of times the unit has been dispatched, used for load balancing between units.
1798
+ * Indicates whether the unit is equipped with GPS. This property determines whether the unit's geographical information is displayed on maps. It also affects automatic suggestions: - If false, suggestions use the location for calculating the nearest units. - If true and unit status is , suggestions use the real GPS location to calculate the distance to the operation location.
1795
1799
  *
1796
1800
  */
1797
- dispatchCounter: number;
1801
+ isEquippedWithGps: boolean;
1798
1802
  /**
1799
- * Gets or sets the identifier of the current operation if the unit is dispatched.
1803
+ * The external availability percentage of the unit when referenced by another dispatch center. This value determines the unit's potential availability.
1800
1804
  *
1801
1805
  */
1802
- currentOperationId: string | null;
1806
+ externalAvailablePercent: number;
1803
1807
  /**
1804
- * Gets the unique identifier for the entity.
1808
+ * The dispatch groups associated with the unit.
1805
1809
  *
1806
1810
  */
1807
- id: string;
1811
+ dispatchGroups: string;
1808
1812
  /**
1809
- * Gets the unique identifier of the session associated with this entity.
1813
+ * The dispatch option of the unit, determining how the unit is automatically suggested by the system.
1810
1814
  *
1811
1815
  */
1812
- sessionId: number;
1813
- unitId: number;
1816
+ dispatchOption: UnitDispatchOption;
1814
1817
  /**
1815
- * Gets or sets the unit information associated with the resource.
1818
+ * The doctor option of the unit.
1819
+ *
1816
1820
  *
1821
+ * @remarks
1822
+ * If set to , the doctor is picked up at the specified doctor pickup POI after dispatch.
1817
1823
  */
1818
- unit: IUnitInformation;
1824
+ doctorOption: UnitDoctorOption;
1819
1825
  /**
1820
- * Gets or sets the current status of the unit.
1826
+ * Determines the duty options of the unit, including its availability and reaction to dispatch.
1827
+ *
1821
1828
  *
1829
+ * @remarks
1830
+ * If set to , unit duty periods in are required.
1822
1831
  */
1823
- unitStatus: UnitStatus | null;
1832
+ dutyOptions: UnitDutyOptions;
1824
1833
  /**
1825
- * Gets or sets a non-persistent unit status for temporary tracking.
1834
+ * The list of equipment associated with the unit.
1826
1835
  *
1827
1836
  */
1828
- unitStatusNonPersistent: UnitStatusNonPersistent | null;
1837
+ equipments: UnitEquipment[] | null;
1829
1838
  }
1830
1839
  /**
1831
- * Represents event arguments for a notification-related session event.
1840
+ * Represents a duty period for a unit. Duty periods are required if the property is set to .
1832
1841
  *
1833
1842
  */
1834
- export interface NotificationSessionEventArgs {
1843
+ export interface UnitDutyPeriod {
1844
+ id: number | null;
1845
+ unitId: number;
1835
1846
  /**
1836
- * Gets or sets the notification associated with the session event.
1847
+ * Represents the day of the week for the duty period.
1837
1848
  *
1838
1849
  */
1839
- notification: Notification;
1840
- }
1841
- /**
1842
- * Represents event arguments for an event involving operation documentation.
1843
- *
1844
- */
1845
- export interface OperationDocumentationSessionEventArgs {
1850
+ day: DayOfWeek;
1846
1851
  /**
1847
- * Gets or sets the operation documentation associated with the session event.
1852
+ * Represents the starting hour of the duty period.
1848
1853
  *
1849
1854
  */
1850
- operationDocumentation: OperationDocumentation;
1851
- }
1852
- /**
1853
- * Represents event arguments for an event involving an operation event.
1854
- *
1855
- */
1856
- export interface OperationEventSessionEventArgs {
1855
+ hourStart: number;
1857
1856
  /**
1858
- * Gets or sets the operation event associated with the session event.
1857
+ * Represents the starting minute of the duty period.
1859
1858
  *
1860
1859
  */
1861
- operationEvent: OperationEvent;
1862
- }
1863
- /**
1864
- * Represents event arguments for an operation involving a resource within a session event.
1865
- *
1866
- */
1867
- export interface OperationResourceSessionEventArgs {
1860
+ minuteStart: number;
1868
1861
  /**
1869
- * Gets or sets the operation resource associated with the session event.
1862
+ * Represents the ending hour of the duty period.
1870
1863
  *
1871
1864
  */
1872
- operationResource: OperationResource;
1873
- }
1874
- /**
1875
- * Represents event arguments for an event involving an operation.
1876
- *
1877
- */
1878
- export interface OperationSessionEventArgs {
1865
+ hourEnd: number;
1879
1866
  /**
1880
- * Gets or sets the operation associated with the session event.
1867
+ * Represents the ending minute of the duty period.
1881
1868
  *
1882
1869
  */
1883
- operation: Operation;
1870
+ minuteEnd: number;
1884
1871
  }
1885
- /**
1886
- * Represents event arguments for an event involving an operation task.
1887
- *
1888
- */
1889
- export interface OperationTaskSessionEventArgs {
1872
+ export interface UnitInformation {
1890
1873
  /**
1891
- * Gets or sets the operation task associated with the session event.
1874
+ * The category of the unit. By setting a value to , this can be cosmetically overridden.
1892
1875
  *
1893
1876
  */
1894
- operationTask: IOperationTask;
1895
- }
1896
- /**
1897
- * Represents event arguments for an event involving a patient person.
1898
- *
1899
- */
1900
- export interface PatientSessionEventArgs {
1877
+ category: UnitCategory;
1901
1878
  /**
1902
- * Gets or sets the patient person associated with the session event.
1879
+ * The overridden category of the unit.
1903
1880
  *
1904
1881
  */
1905
- patient: Patient;
1906
- }
1907
- /**
1908
- * Represents event arguments for a property change within a session event.
1909
- *
1910
- */
1911
- export interface PropertyChangedSessionEventArgs {
1882
+ categoryOverride: string;
1912
1883
  /**
1913
- * Gets or sets the name of the property that changed.
1884
+ * The (long) callsign of the unit.
1914
1885
  *
1915
1886
  */
1916
- propertyName: string;
1887
+ callsign: string;
1917
1888
  /**
1918
- * Gets or sets the new value of the property.
1889
+ * A short callsign variant of the unit.
1919
1890
  *
1920
1891
  */
1921
- propertyValue: Object;
1922
- }
1923
- /**
1924
- * Represents event arguments for an event involving a resource.
1925
- *
1926
- */
1927
- export interface ResourceSessionEventArgs {
1892
+ callsignShort: string;
1928
1893
  /**
1929
- * Gets or sets the resource involved in the session event.
1894
+ * The callsign displayed on maps if is set to true.
1930
1895
  *
1931
1896
  */
1932
- resource: SessionResource;
1933
- }
1934
- /**
1935
- * Represents the base class for session event arguments.
1936
- *
1937
- */
1938
- export interface SessionEventArgs {
1939
- }
1940
- /**
1941
- * Represents event arguments for an event involving a workplace.
1942
- *
1943
- */
1944
- export interface WorkplaceSessionEventArgs {
1897
+ callsignGps: string;
1945
1898
  /**
1946
- * Gets or sets the workplace associated with the session event.
1899
+ * The name of the point of interest (POI) where the unit is located.
1947
1900
  *
1948
1901
  */
1949
- workplace: Workplace;
1902
+ station: string;
1950
1903
  }
1951
- /**
1952
- * Represents a webhook for registering HTTP callbacks to handle managed session events.
1953
- *
1954
- */
1955
- export interface SessionWebhook {
1904
+ export interface UserInformation {
1956
1905
  id: number;
1957
- sessionId: number;
1958
- headers: {
1959
- [key: string]: string;
1960
- };
1961
- events: SessionEventType[] | null;
1906
+ sub: string;
1962
1907
  /**
1963
- * Gets or sets the URL to which the webhook will send HTTP requests.
1908
+ * Represents the rank of the user.
1964
1909
  *
1965
1910
  */
1966
- url: string;
1911
+ rank: number;
1967
1912
  /**
1968
- * Gets or sets the HTTP method used for the webhook (e.g., GET, POST).
1913
+ * Represents the name (username) of the user. Unique but could change over time.
1969
1914
  *
1970
1915
  */
1971
- method: SessionWebhookMethod | null;
1916
+ name: string;
1917
+ /**
1918
+ * Represents the first name of the user, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual first name for privacy purposes.
1919
+ *
1920
+ */
1921
+ displayFirstName: string;
1922
+ /**
1923
+ * Represents the last name of the user, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual last name for privacy purposes.
1924
+ *
1925
+ */
1926
+ displayLastName: string;
1927
+ /**
1928
+ * Represents an abbreviation formed by the first two letters of the first name and the first two letters of the last name, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual last name for privacy purposes.
1929
+ *
1930
+ */
1931
+ dispatcherTag: string;
1932
+ /**
1933
+ * Represents the date and time of the user's last activity.
1934
+ *
1935
+ */
1936
+ lastActivityOn: string | null;
1972
1937
  }
1973
- /**
1974
- * Represents a status page used for displaying unit statuses.
1975
- *
1976
- */
1977
- export interface Statuspage {
1938
+ export interface ICommandcenterInformation {
1978
1939
  id: number;
1979
- commandcenterId: number;
1980
- members: StatuspageMembers[] | null;
1981
1940
  /**
1982
- * The name of the status page.
1941
+ * The name of the command center. This field may be null if the name has not been set.
1983
1942
  *
1984
1943
  */
1985
1944
  name: string;
1986
1945
  /**
1987
- * The description of the status page.
1946
+ * The category of the command center, which helps classify the center according to its primary function or operational scope.
1988
1947
  *
1989
1948
  */
1990
- description: string;
1949
+ category: CommandcenterCategory;
1991
1950
  /**
1992
- * The sort number used to determine the order of status pages.
1951
+ * The identifier for the header image of the command center, used for display purposes in interfaces.
1993
1952
  *
1994
1953
  */
1995
- sortNumber: number;
1954
+ headerImageId: string | null;
1996
1955
  /**
1997
- * The display option of the status page.
1956
+ * The date and time when the command center was last modified.
1998
1957
  *
1999
1958
  */
2000
- displayOption: StatuspageDisplayOption;
1959
+ changedOn: string | null;
1960
+ }
1961
+ export interface IGeoReferenced {
2001
1962
  /**
2002
- * If true, members in an inactive state will be hidden on the frontend.
1963
+ * Point of interest associated with the location, if applicable.
2003
1964
  *
2004
1965
  */
2005
- isInactiveResourcesHidden: boolean;
2006
- }
2007
- /**
2008
- * Represents a unit associated with a status page. Will be grouped within other units by the value in .
2009
- *
2010
- */
2011
- export interface StatuspageMembers {
2012
- id: number | null;
2013
- unitId: number | null;
1966
+ poi: IPoi;
2014
1967
  /**
2015
- * The group to which the unit belongs. Set new value or use existing. />.
1968
+ * Primary address details of the location.
2016
1969
  *
2017
1970
  */
2018
- group: string;
1971
+ address: Address;
2019
1972
  /**
2020
- * Member will be sorted by this property, if set.
1973
+ * House number at the location, if applicable.
2021
1974
  *
2022
1975
  */
2023
- sortNumber: number;
1976
+ houseNumber: string;
1977
+ /**
1978
+ * Geographical coordinates of the location.
1979
+ *
1980
+ */
1981
+ coordinates: Coordinates | null;
1982
+ /**
1983
+ * Specifies the accuracy of the coordinates from the geocoding process.
1984
+ *
1985
+ */
1986
+ accuracy: LocationAccuracy;
1987
+ /**
1988
+ * Gets a value indicating whether the coordinates have been successfully resolved for the location.
1989
+ *
1990
+ *
1991
+ * @remarks
1992
+ * Returns true if the location has been set and coordinates are not null; otherwise, false.
1993
+ */
1994
+ isCoordinatesResolved: boolean;
2024
1995
  }
2025
- export interface TaskCatalogItem {
2026
- parameters: TaskCatalogParameter[] | null;
1996
+ export interface IKeyword {
1997
+ id: number;
1998
+ commandcenterId: number;
2027
1999
  /**
2028
- * Gets or sets the implementation name of the task. This is the name specified in the ResQueServeTaskAttribute.
2000
+ * The name of the keyword used for search and identification purposes.
2029
2001
  *
2030
2002
  */
2031
- implementationName: string;
2003
+ name: string;
2032
2004
  /**
2033
- * Gets or sets the display name of the task.
2005
+ * Indicates if the emergency is urgent, which may prompt units to use sirens.
2034
2006
  *
2035
2007
  */
2036
- displayName: string;
2008
+ isUrgent: boolean;
2037
2009
  /**
2038
- * Gets or sets the description of the task.
2010
+ * Indicates if the keyword is used for auto-assigning regular ambulance transport operations where the patient can sit (mapping property).
2039
2011
  *
2040
2012
  */
2041
- description: string;
2013
+ isUsedForAmbulanceRegularSitting: boolean;
2042
2014
  /**
2043
- * Gets or sets the category of the task.
2015
+ * Indicates if the keyword is used for auto-assigning regular ambulance transport operations where the patient can only lay (mapping property).
2044
2016
  *
2045
2017
  */
2046
- category: string;
2018
+ isUsedForAmbulanceRegularLying: boolean;
2047
2019
  /**
2048
- * Gets or sets the version of the task.
2020
+ * Indicates if the keyword is used for a standby position.
2049
2021
  *
2050
2022
  */
2051
- version: string;
2023
+ isUsedForStandbyPosition: boolean;
2024
+ /**
2025
+ * Indicates if the keyword is used for automatically initiating operations triggered by fire alarm systems reporting a fire at a point of interest (POI) (mapping property).
2026
+ *
2027
+ */
2028
+ isUsedForFireAlarmSystem: boolean;
2052
2029
  /**
2053
- * Gets or sets the priority of the task.
2030
+ * Specifies whether police assistance is required for the emergency situation.
2054
2031
  *
2055
2032
  */
2056
- priority: TaskPriority;
2033
+ isPoliceRequired: boolean;
2057
2034
  /**
2058
- * Gets or sets the number of parameters the task requires.
2035
+ * Specifies the number of medical units with a doctor to be suggested (can be air or ground units).
2059
2036
  *
2060
2037
  */
2061
- parameterCount: number;
2038
+ dispatchAmountDoctor: number;
2062
2039
  /**
2063
- * Gets or sets whether the task requires administrative privileges.
2040
+ * Specifies the number of ground medical units with a doctor to be suggested (excluding air units).
2064
2041
  *
2065
2042
  */
2066
- requiresAdmin: boolean;
2067
- }
2068
- export interface TaskCatalogParameter {
2069
- propertyName: string;
2043
+ dispatchAmountDoctorGround: number;
2070
2044
  /**
2071
- * Gets or sets the name of the parameter.
2045
+ * Specifies the number of urgent ambulance units to be suggested.
2072
2046
  *
2073
2047
  */
2074
- displayName: string;
2048
+ dispatchAmountAmbulanceUrgent: number;
2075
2049
  /**
2076
- * Gets or sets the description of the parameter.
2050
+ * Specifies the number of ambulance units with a doctor to be suggested.
2077
2051
  *
2078
2052
  */
2079
- description: string;
2053
+ dispatchAmountAmbulanceDoctor: number;
2080
2054
  /**
2081
- * Gets or sets whether this parameter is required.
2055
+ * Specifies the number of regular transport ambulance units to be suggested for non-urgent patient transport.
2082
2056
  *
2083
2057
  */
2084
- isRequired: boolean;
2058
+ dispatchAmountAmbulanceRegular: number;
2085
2059
  /**
2086
- * Gets or sets the default value for this parameter.
2060
+ * Specifies the number of helicopters to be suggested.
2087
2061
  *
2088
2062
  */
2089
- defaultValue: Object;
2063
+ dispatchAmountHelicopter: number;
2090
2064
  /**
2091
- * Gets or sets the order in which this parameter should be displayed in a UI.
2065
+ * Specifies the number of ICU-equipped ambulance units to be suggested.
2092
2066
  *
2093
2067
  */
2094
- order: number;
2068
+ dispatchAmountAmbulanceICU: number;
2095
2069
  /**
2096
- * Gets or sets a validation pattern (regex) for string parameters.
2070
+ * Specifies the number of ICU-equipped helicopters to be suggested.
2097
2071
  *
2098
2072
  */
2099
- validationPattern: string;
2073
+ dispatchAmountHelicopterICU: number;
2100
2074
  /**
2101
- * Gets or sets whether this parameter is a secret (e.g. bearer token). Value will never be displayed on frontend.
2075
+ * Groups of dispatch units suggested for the keyword, used to refine the suggestions based on unit capabilities.
2102
2076
  *
2103
2077
  */
2104
- isSecret: boolean;
2078
+ dispatchGroups: string;
2105
2079
  /**
2106
- * Gets or sets the type of the parameter.
2080
+ * A list of equipment required for handling the emergency, linked to this keyword.
2107
2081
  *
2108
2082
  */
2109
- propertyType: string;
2083
+ requiredEquipment: IKeywordEquipment[] | null;
2110
2084
  }
2111
- /**
2112
- * Represents a condition used within a task.
2113
- *
2114
- */
2115
- export interface TaskCondition {
2085
+ export interface IKeywordEquipment {
2116
2086
  id: number;
2117
- value: string;
2118
2087
  /**
2119
- * Gets or sets the field to which the condition applies.
2088
+ * The amount of this equipment type required for the associated emergency scenario.
2120
2089
  *
2121
2090
  */
2122
- field: TaskConditionField;
2091
+ amount: number;
2123
2092
  /**
2124
- * Gets or sets the operator used in the condition.
2093
+ * The type of equipment required, represented as an enum of UnitEquipment.
2125
2094
  *
2126
2095
  */
2127
- operator: TaskConditionOperator;
2096
+ equipment: UnitEquipment;
2128
2097
  }
2129
- export interface TaskTemplate {
2130
- id: number;
2131
- commandcenterId: number;
2098
+ export interface INotification {
2099
+ id: string;
2132
2100
  /**
2133
- * Gets or sets the conditions associated with the task template.
2101
+ * Gets the date and time when the notification was created.
2134
2102
  *
2135
2103
  */
2136
- conditions: TaskCondition[] | null;
2104
+ createdOn: string;
2137
2105
  /**
2138
- * Gets or sets the description of the task template.
2106
+ * Gets or sets a value indicating whether the notification requires a resolution.
2139
2107
  *
2140
2108
  */
2141
- description: string;
2109
+ isRequiredToBeSolved: boolean;
2142
2110
  /**
2143
- * Gets or sets a value indicating whether the task is mandatory.
2111
+ * Gets or sets the agent associated with the notification, may be null if not applicable.
2144
2112
  *
2145
2113
  */
2146
- isMandatory: boolean;
2114
+ agent: IUserInformation;
2147
2115
  /**
2148
- * Gets or sets the execution type of the task.
2116
+ * Gets the category of the notification.
2149
2117
  *
2150
2118
  */
2151
- execution: TaskExecution;
2119
+ category: NotificationCategory;
2152
2120
  /**
2153
- * Gets or sets a value indicating whether all conditions must be met.
2121
+ * Gets or sets the text of the notification.
2154
2122
  *
2155
2123
  */
2156
- requireAllConditions: boolean;
2124
+ text: string;
2157
2125
  /**
2158
- * Gets or sets a value indicating whether a task should be created for each match found.
2126
+ * Gets or sets the identifier of the operation to which the notification is applicable, may be null.
2159
2127
  *
2160
2128
  */
2161
- createTaskForEachMatch: boolean;
2129
+ applicableOperationId: string | null;
2162
2130
  /**
2163
- * Indicates if the task is waiting for an external signal or callback to confirm success. If set to false, the task is considered successfully completed once the internal execution code completes.
2131
+ * Gets or sets the identifier of the unit to which the notification is applicable, may be null.
2164
2132
  *
2165
2133
  */
2166
- requiresSuccessfulSignal: boolean;
2134
+ applicableUnitId: number | null;
2135
+ }
2136
+ export interface IOperation {
2137
+ id: string;
2167
2138
  /**
2168
- * Defines a timeout in seconds for how long the task will wait before entering a failed state if is not executed in time.
2139
+ * Gets or sets the internal operation number.
2169
2140
  *
2170
2141
  */
2171
- timeoutSeconds: number | null;
2142
+ numberInternal: string;
2172
2143
  /**
2173
- * Gets the name of the ResQueServeTask implementation to use for executing this task. This should match the Name property of a ResQueServeTaskAttribute registered in the system.
2144
+ * Gets or sets the external operation number.
2174
2145
  *
2175
2146
  */
2176
- implementationName: string;
2147
+ numberExternal: string;
2177
2148
  /**
2178
- * Gets or sets the parameters needed for task execution, keyed by parameter name.
2149
+ * Gets or sets the name of the caller.
2179
2150
  *
2180
2151
  */
2181
- parameters: {
2182
- [key: string]: Object;
2183
- };
2184
- }
2185
- /**
2186
- * Represents a unit within the area of a dispatch center.
2187
- *
2188
- */
2189
- export interface Unit {
2190
- id: number;
2191
- commandcenterId: number;
2152
+ callerName: string;
2192
2153
  /**
2193
- * The radio group associated with the unit. Is null if not set.
2154
+ * Gets or sets the phone number of the caller.
2194
2155
  *
2195
2156
  */
2196
- radiogroup: Radiogroup;
2157
+ callerNumber: IPhoneNumber;
2197
2158
  /**
2198
- * The point of interest (POI) where the unit is located.
2159
+ * Gets or sets the date and time the operation was created.
2199
2160
  *
2200
2161
  */
2201
- poi: Poi;
2162
+ createdOn: string;
2202
2163
  /**
2203
- * The point of interest (POI) where the doctor is picked up then value is set to .
2164
+ * Gets or sets the date and time the operation was dispatched.
2204
2165
  *
2205
2166
  */
2206
- doctorPickupPoi: Poi;
2207
- info: IUnitInformation;
2208
- dutyPeriods: UnitDutyPeriod[] | null;
2167
+ dispatchedOn: string | null;
2209
2168
  /**
2210
- * The (long) callsign of the unit.
2169
+ * Gets or sets the date and time the operation was finished.
2211
2170
  *
2212
2171
  */
2213
- callsign: string;
2172
+ finishedOn: string | null;
2214
2173
  /**
2215
- * A short callsign variant of the unit.
2174
+ * Gets or sets the scheduled pick-up date and time for the operation. A reminder notification will be created based on this value.
2216
2175
  *
2217
2176
  */
2218
- callsignShort: string;
2177
+ scheduledPickUpOn: string | null;
2219
2178
  /**
2220
- * The name of the point of interest (POI) where the unit is located.
2179
+ * Gets or sets the user information for the creator of the operation.
2221
2180
  *
2222
2181
  */
2223
- station: string;
2182
+ createdBy: IUserInformation;
2224
2183
  /**
2225
- * The category of the unit. By setting a value to , this can be cosmetically overridden.
2184
+ * Gets or sets the user information for the dispatcher of the operation.
2226
2185
  *
2227
2186
  */
2228
- category: UnitCategory;
2187
+ dispatchedBy: IUserInformation;
2229
2188
  /**
2230
- * The overridden category of the unit.
2189
+ * Gets or sets the user information for the person who closed the operation.
2231
2190
  *
2232
2191
  */
2233
- categoryOverride: string;
2192
+ finishedBy: IUserInformation;
2234
2193
  /**
2235
- * The callsign displayed on maps if is set to true.
2194
+ * Gets or sets the collection of keywords associated with the operation.
2236
2195
  *
2237
2196
  */
2238
- callsignGps: string;
2197
+ keywords: IKeyword[] | null;
2239
2198
  /**
2240
- * The verbal callsign of the unit.
2199
+ * Gets or sets the location of the operation.
2241
2200
  *
2242
2201
  */
2243
- callsignVerbal: string;
2202
+ location: IGeoReferenced;
2244
2203
  /**
2245
- * Indicates whether the unit is a first responder. This property affects suggestions and the unit's behavior on operation sites.
2204
+ * Gets or sets internal information about the operation
2246
2205
  *
2247
2206
  */
2248
- isFirstResponder: boolean;
2207
+ informationInternal: string;
2249
2208
  /**
2250
- * Indicates whether the unit is not a volunteer unit. Dispatch times will affect based on this value.
2209
+ * Gets or sets external information about the operation.
2251
2210
  *
2252
2211
  */
2253
- isNotVolunteerUnit: boolean;
2212
+ informationExternal: string;
2254
2213
  /**
2255
- * Indicates whether the unit starts in a new session with status . This property affects the visual representation only and does not affect the actual duty status of the unit. To control the unit's duty status, use the property. The unit will react to dispatches based on its duty status as determined by the .
2214
+ * Gets or sets the priority of the operation.
2256
2215
  *
2257
2216
  */
2258
- isStartingWithStatus6: boolean;
2217
+ priority: OperationPriority;
2259
2218
  /**
2260
- * Indicates whether the unit is equipped with GPS. This property determines whether the unit's geographical information is displayed on maps. It also affects automatic suggestions: - If false, suggestions use the location for calculating the nearest units. - If true and unit status is , suggestions use the real GPS location to calculate the distance to the operation location.
2219
+ * Gets or sets the current status of the operation.
2261
2220
  *
2262
2221
  */
2263
- isEquippedWithGps: boolean;
2222
+ status: OperationStatus;
2264
2223
  /**
2265
- * The external availability percentage of the unit when referenced by another dispatch center. This value determines the unit's potential availability.
2224
+ * Gets or sets a dictionary of patients associated with the operation.
2266
2225
  *
2267
2226
  */
2268
- externalAvailablePercent: number;
2227
+ patients: {
2228
+ [key: string]: IPatient;
2229
+ };
2269
2230
  /**
2270
- * The dispatch groups associated with the unit.
2231
+ * Gets or sets a dictionary of documents associated with the operation.
2271
2232
  *
2272
2233
  */
2273
- dispatchGroups: string;
2234
+ documentations: {
2235
+ [key: string]: IOperationDocumentation;
2236
+ };
2274
2237
  /**
2275
- * The dispatch option of the unit, determining how the unit is automatically suggested by the system.
2238
+ * Gets or sets a dictionary of resources associated with the operation.
2276
2239
  *
2277
2240
  */
2278
- dispatchOption: UnitDispatchOption;
2241
+ resources: {
2242
+ [key: string]: IOperationResource;
2243
+ };
2279
2244
  /**
2280
- * The doctor option of the unit.
2245
+ * Gets or sets a dictionary of tasks associated with the operation.
2281
2246
  *
2282
- *
2283
- * @remarks
2284
- * If set to , the doctor is picked up at the specified doctor pickup POI after dispatch.
2285
2247
  */
2286
- doctorOption: UnitDoctorOption;
2248
+ tasks: {
2249
+ [key: string]: IOperationTask;
2250
+ };
2287
2251
  /**
2288
- * Determines the duty options of the unit, including its availability and reaction to dispatch.
2289
- *
2252
+ * Gets or sets a list of relevant audit information's associated with the operation.
2290
2253
  *
2291
- * @remarks
2292
- * If set to , unit duty periods in are required.
2293
2254
  */
2294
- dutyOptions: UnitDutyOptions;
2255
+ audits: ISessionAudit[] | null;
2295
2256
  /**
2296
- * The list of equipment associated with the unit.
2257
+ * Gets or sets the duration of the operation.
2297
2258
  *
2298
2259
  */
2299
- equipments: UnitEquipment[] | null;
2260
+ duration: string;
2300
2261
  }
2301
- /**
2302
- * Represents a duty period for a unit. Duty periods are required if the property is set to .
2303
- *
2304
- */
2305
- export interface UnitDutyPeriod {
2306
- id: number | null;
2307
- unitId: number;
2262
+ export interface IOperationDocumentation {
2263
+ id: string;
2264
+ operationId: string;
2308
2265
  /**
2309
- * Represents the day of the week for the duty period.
2266
+ * Gets or sets the date and time when this documentation was created.
2310
2267
  *
2311
2268
  */
2312
- day: DayOfWeek;
2269
+ createdOn: string;
2313
2270
  /**
2314
- * Represents the starting hour of the duty period.
2271
+ * Gets or sets the user information of the individual who created this documentation.
2315
2272
  *
2316
2273
  */
2317
- hourStart: number;
2274
+ createdBy: IUserInformation;
2318
2275
  /**
2319
- * Represents the starting minute of the duty period.
2276
+ * Gets or sets the textual content of the documentation.
2320
2277
  *
2321
2278
  */
2322
- minuteStart: number;
2279
+ text: string;
2280
+ }
2281
+ export interface IOperationResource {
2282
+ id: string;
2283
+ operationId: string;
2323
2284
  /**
2324
- * Represents the ending hour of the duty period.
2285
+ * Gets or sets the information of the user who dispatched the resource.
2325
2286
  *
2326
2287
  */
2327
- hourEnd: number;
2288
+ dispatchedBy: IUserInformation;
2328
2289
  /**
2329
- * Represents the ending minute of the duty period.
2290
+ * Gets or sets the date and time the resource was dispatched.
2330
2291
  *
2331
2292
  */
2332
- minuteEnd: number;
2333
- }
2334
- export interface UnitInformation {
2293
+ dispatchOn: string;
2335
2294
  /**
2336
- * The category of the unit. By setting a value to , this can be cosmetically overridden.
2295
+ * Gets or sets the date and time the resource dispatch was canceled.
2337
2296
  *
2338
2297
  */
2339
- category: UnitCategory;
2298
+ cancelOn: string | null;
2340
2299
  /**
2341
- * The overridden category of the unit.
2300
+ * Gets or sets the date and time the resource completed its task.
2342
2301
  *
2343
2302
  */
2344
- categoryOverride: string;
2303
+ completedOn: string | null;
2345
2304
  /**
2346
- * The (long) callsign of the unit.
2305
+ * Gets or sets the timestamps of various statuses of the resource.
2347
2306
  *
2348
2307
  */
2349
- callsign: string;
2308
+ statusTimestamps: {
2309
+ [key: number]: string;
2310
+ };
2311
+ resource: IUnitResource;
2312
+ }
2313
+ export interface IOperationTask {
2314
+ id: string;
2315
+ operationId: string;
2316
+ sessionId: number;
2350
2317
  /**
2351
- * A short callsign variant of the unit.
2318
+ * Gets or sets the task template used to create this task.
2352
2319
  *
2353
2320
  */
2354
- callsignShort: string;
2321
+ template: ITaskTemplate;
2355
2322
  /**
2356
- * The callsign displayed on maps if is set to true.
2323
+ * Gets or sets notes related to the task.
2357
2324
  *
2358
2325
  */
2359
- callsignGps: string;
2326
+ notes: string;
2360
2327
  /**
2361
- * The name of the point of interest (POI) where the unit is located.
2328
+ * Gets or sets the status of the task.
2362
2329
  *
2363
2330
  */
2364
- station: string;
2365
- }
2366
- export interface UserInformation {
2367
- id: number;
2368
- sub: string;
2331
+ status: TaskStatus;
2369
2332
  /**
2370
- * Represents the rank of the user.
2333
+ * Gets or sets the date and time the task was last completed.
2371
2334
  *
2372
2335
  */
2373
- rank: number;
2336
+ lastCompletedOn: string | null;
2374
2337
  /**
2375
- * Represents the name (username) of the user. Unique but could change over time.
2338
+ * Gets or sets information about the user who last completed the task.
2376
2339
  *
2377
2340
  */
2378
- name: string;
2341
+ lastCompletedBy: IUserInformation;
2342
+ }
2343
+ export interface IPatient {
2344
+ id: string;
2345
+ operationId: string;
2379
2346
  /**
2380
- * Represents the first name of the user, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual first name for privacy purposes.
2347
+ * Gets or sets the insurance number of the patient, if available.
2381
2348
  *
2382
2349
  */
2383
- displayFirstName: string;
2350
+ insuranceNumber: string;
2384
2351
  /**
2385
- * Represents the last name of the user, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual last name for privacy purposes.
2352
+ * Gets or sets the destination location for the patient.
2386
2353
  *
2387
2354
  */
2388
- displayLastName: string;
2355
+ destination: IGeoReferenced;
2356
+ }
2357
+ export interface IPerson {
2389
2358
  /**
2390
- * Represents an abbreviation formed by the first two letters of the first name and the first two letters of the last name, which can be displayed publicly. This property is null if the user has not set a publicly used display name. It may differ from the user's actual last name for privacy purposes.
2359
+ * Gets or sets the first name of the person.
2391
2360
  *
2392
2361
  */
2393
- dispatcherTag: string;
2362
+ firstName: string;
2394
2363
  /**
2395
- * Represents the date and time of the user's last activity.
2364
+ * Gets or sets the middle name of the person.
2396
2365
  *
2397
2366
  */
2398
- lastActivityOn: string | null;
2399
- }
2400
- /**
2401
- * Represents a workplace, including its status, associated user, and identifying number.
2402
- *
2403
- */
2404
- export interface Workplace {
2367
+ middleName: string;
2405
2368
  /**
2406
- * Gets or sets the number that identifies the workplace.
2369
+ * Gets or sets the last name of the person.
2407
2370
  *
2408
2371
  */
2409
- number: number;
2372
+ lastName: string;
2410
2373
  /**
2411
- * Gets or sets the current status of the workplace.
2374
+ * Gets or sets the gender of the person.
2412
2375
  *
2413
2376
  */
2414
- status: WorkplaceStatus;
2377
+ gender: Gender | null;
2415
2378
  /**
2416
- * Gets or sets the user information associated with the workplace.
2379
+ * Gets or sets the date of birth of the person.
2417
2380
  *
2418
2381
  */
2419
- user: IUserInformation;
2382
+ dateOfBirth: string | null;
2420
2383
  }
2421
- export interface ICommandcenterInformation {
2422
- id: number;
2384
+ export interface IPhoneNumber {
2423
2385
  /**
2424
- * The name of the command center. This field may be null if the name has not been set.
2386
+ * Gets the country associated with the phone number.
2425
2387
  *
2426
2388
  */
2427
- name: string;
2389
+ country: Country;
2428
2390
  /**
2429
- * The category of the command center, which helps classify the center according to its primary function or operational scope.
2391
+ * Gets the country calling code derived from the enumeration.
2430
2392
  *
2431
2393
  */
2432
- category: CommandcenterCategory;
2394
+ countryCode: string;
2433
2395
  /**
2434
- * The identifier for the header image of the command center, used for display purposes in interfaces.
2396
+ * Gets the area code for specific regions within the country.
2435
2397
  *
2436
2398
  */
2437
- headerImageId: string | null;
2399
+ areaCode: string;
2438
2400
  /**
2439
- * The date and time when the command center was last modified.
2401
+ * Gets the local phone number.
2440
2402
  *
2441
2403
  */
2442
- changedOn: string | null;
2443
- }
2444
- export interface IExecutable {
2445
- context: ITaskExecutionContext;
2404
+ number: string;
2446
2405
  }
2447
- export interface IGeoReferenced {
2448
- /**
2449
- * Point of interest associated with the location, if applicable.
2450
- *
2451
- */
2452
- poi: Poi;
2406
+ export interface IPoi {
2407
+ id: number;
2408
+ commandcenterId: number;
2453
2409
  /**
2454
- * Primary address details of the location.
2410
+ * The name of the point of interest. Is unique inside a dispatch center.
2455
2411
  *
2456
2412
  */
2457
- address: Address;
2413
+ name: string;
2458
2414
  /**
2459
- * House number at the location, if applicable.
2415
+ * The category of the point of interest.
2460
2416
  *
2461
2417
  */
2462
- houseNumber: string;
2418
+ category: PoiCategory;
2463
2419
  /**
2464
- * Geographical coordinates of the location.
2420
+ * Tags associated with the point of interest for search purposes. Separate multiple tags with a comma.
2465
2421
  *
2466
2422
  */
2467
- coordinates: Coordinates | null;
2423
+ searchTags: string;
2468
2424
  /**
2469
- * Specifies the accuracy of the coordinates from the geocoding process.
2425
+ * The verbal name of the point of interest. May be used on radio or calls.
2470
2426
  *
2471
2427
  */
2472
- accuracy: LocationAccuracy;
2473
- }
2474
- export interface IOperationEntity {
2428
+ verbalName: string;
2475
2429
  /**
2476
- * Gets the unique identifier for the entity.
2430
+ * The German genus of the point of interest (der, die, das).
2477
2431
  *
2478
2432
  */
2479
- id: string;
2433
+ germanGenus: string;
2480
2434
  /**
2481
- * Gets the unique identifier of the operation associated with this entity.
2435
+ * The hospital departments associated with the hospital POI if is hospital. Has no effect if is true.
2482
2436
  *
2483
2437
  */
2484
- operationId: string;
2485
- }
2486
- export interface IOperationTask {
2438
+ hospitalDepartments: PoiHospitalDepartment[] | null;
2487
2439
  /**
2488
- * Gets or sets the identifier associated with the task.
2440
+ * Indicates whether units should be dispatched together when assigned to this POI. Should be true if non-volunteer department.
2489
2441
  *
2490
2442
  */
2491
- id: string;
2443
+ isUnitsMoveOutTogether: boolean;
2492
2444
  /**
2493
- * Gets or sets the session identifier associated with the task.
2445
+ * The bonus or malus value associated with the point of interest (POI). Must be a value between -100 or +100 (%). This value affects the calculated distance if the POI is a hospital. Units will always prioritize the nearest hospital with the required hospital departments.
2494
2446
  *
2495
2447
  */
2496
- sessionId: number;
2448
+ bonusMalus: number;
2497
2449
  /**
2498
- * Gets or sets the task template used to create this task.
2450
+ * Indicates whether the hospital is a maximum care hospital and has all .
2499
2451
  *
2500
2452
  */
2501
- template: ITaskTemplate;
2453
+ isMaxCareHospital: boolean;
2502
2454
  /**
2503
- * Gets or sets notes related to the task.
2455
+ * Indicates whether the hospital is an external hospital. External hospitals do not generate patient transports, but units may use them as destinations for patients.
2504
2456
  *
2505
2457
  */
2506
- notes: string;
2458
+ isExternalHospital: boolean;
2507
2459
  /**
2508
- * Gets or sets the status of the task.
2460
+ * Indicates whether patient information transmission is automatic at this POI. Units will transmit patient information to the hospital non-verbally if this property is set to true.
2509
2461
  *
2510
2462
  */
2511
- status: TaskStatus;
2463
+ isAutomaticPatientTransmission: boolean;
2512
2464
  /**
2513
- * Gets or sets the date and time the task was last completed.
2465
+ * Indicates whether a fire alarm system is present at this POI. The presence of a fire alarm system may generate calls.
2514
2466
  *
2515
2467
  */
2516
- lastCompletedOn: string | null;
2468
+ isWithFireAlarmSystem: boolean;
2517
2469
  /**
2518
- * Gets or sets information about the user who last completed the task.
2470
+ * Indicates whether the object name is shown as the caller number for this POI or a random number is generated. .
2519
2471
  *
2520
2472
  */
2521
- lastCompletedBy: IUserInformation;
2473
+ isNameCallerNumber: boolean;
2474
+ coordinates: Coordinates | null;
2475
+ houseNumber: string;
2522
2476
  }
2523
- export interface IRealmInformation {
2477
+ export interface ISessionAudit {
2478
+ id: string;
2524
2479
  /**
2525
- * Gets or sets the unique identifier for the realm.
2480
+ * Gets information about the user who performed the audited action.
2526
2481
  *
2527
2482
  */
2528
- id: string;
2483
+ user: IUserInformation;
2529
2484
  /**
2530
- * Gets or sets the hostname associated with the realm.
2485
+ * Gets the type of action performed on the entity (Create, Update, Delete).
2531
2486
  *
2532
2487
  */
2533
- hostname: string;
2488
+ action: AuditAction;
2534
2489
  /**
2535
- * Gets or sets the country associated with the realm.
2490
+ * Gets the type of sub action performed on the entity (e.g. dispatch, status change ...).
2536
2491
  *
2537
2492
  */
2538
- country: Country;
2493
+ actionSub: AuditActionSub | null;
2539
2494
  /**
2540
- * Gets or sets the display name of the realm.
2495
+ * Gets the type of entity affected by the audit action.
2541
2496
  *
2542
2497
  */
2543
- displayName: string;
2498
+ entityType: AuditEntityType;
2544
2499
  /**
2545
- * Gets or sets the response time of the realm in milliseconds.
2500
+ * Gets the unique identifier of the specific entity instance that was affected.
2546
2501
  *
2547
2502
  */
2548
- responseTimeMs: number | null;
2503
+ entityId: string;
2549
2504
  /**
2550
- * Gets or sets the version information of the realm.
2505
+ * Gets a dictionary of property names and their new values after the action.
2551
2506
  *
2552
2507
  */
2553
- version: string;
2554
- }
2555
- export interface ISessionEntity {
2508
+ changedProperties: {
2509
+ [key: string]: string;
2510
+ };
2556
2511
  /**
2557
- * Gets the unique identifier for the entity.
2512
+ * Gets any supplementary information relevant to understanding the audit event.
2558
2513
  *
2559
2514
  */
2560
- id: string;
2515
+ additionalInfo: string;
2561
2516
  /**
2562
- * Gets the unique identifier of the session associated with this entity.
2517
+ * Gets the date and time when the audited action occurred.
2563
2518
  *
2564
2519
  */
2565
- sessionId: number;
2566
- }
2567
- export interface ITaskExecutionContext {
2568
- connector: ITaskSessionConnector;
2569
- operation: Operation;
2570
- executedBy: IUserInformation;
2571
- task: IOperationTask;
2572
- cancel: CancellationToken;
2573
- }
2574
- export interface ITaskSessionConnector {
2520
+ timestamp: string;
2575
2521
  }
2576
2522
  export interface ITaskTemplate {
2523
+ id: number;
2524
+ commandcenterId: number;
2577
2525
  /**
2578
2526
  * Gets or sets the description of the task template.
2579
2527
  *
@@ -2659,6 +2607,50 @@ export interface IUnitInformation {
2659
2607
  */
2660
2608
  station: string;
2661
2609
  }
2610
+ export interface IUnitResource {
2611
+ sessionId: number;
2612
+ unitId: number;
2613
+ /**
2614
+ * Gets or sets the unit information associated with the resource.
2615
+ *
2616
+ */
2617
+ unit: IUnitInformation;
2618
+ /**
2619
+ * Gets or sets the current status of the unit.
2620
+ *
2621
+ */
2622
+ unitStatus: UnitStatus | null;
2623
+ /**
2624
+ * Gets or sets a non-persistent unit status for temporary tracking.
2625
+ *
2626
+ */
2627
+ unitStatusNonPersistent: UnitStatusNonPersistent | null;
2628
+ /**
2629
+ * Gets or sets the static position of the unit, representing its station location when on duty without dispatch.
2630
+ *
2631
+ */
2632
+ staticPosition: Coordinates;
2633
+ /**
2634
+ * Gets or sets the dynamic GPS position of the unit, if available.
2635
+ *
2636
+ */
2637
+ dynamicPosition: Coordinates | null;
2638
+ /**
2639
+ * Gets or sets the timestamp indicating when the unit was put into preselection for an operation.
2640
+ *
2641
+ */
2642
+ suggestionOn: string | null;
2643
+ /**
2644
+ * Gets or sets the count of times the unit has been dispatched, used for load balancing between units.
2645
+ *
2646
+ */
2647
+ dispatchCounter: number;
2648
+ /**
2649
+ * Gets or sets the identifier of the current operation if the unit is dispatched.
2650
+ *
2651
+ */
2652
+ currentOperationId: string | null;
2653
+ }
2662
2654
  export interface IUserInformation {
2663
2655
  id: number;
2664
2656
  sub: string;
@@ -2693,6 +2685,23 @@ export interface IUserInformation {
2693
2685
  */
2694
2686
  lastActivityOn: string | null;
2695
2687
  }
2688
+ export interface IWorkplace {
2689
+ /**
2690
+ * Gets or sets the number that identifies the workplace.
2691
+ *
2692
+ */
2693
+ number: number;
2694
+ /**
2695
+ * Gets or sets the current status of the workplace.
2696
+ *
2697
+ */
2698
+ status: WorkplaceStatus;
2699
+ /**
2700
+ * Gets or sets the user information associated with the workplace.
2701
+ *
2702
+ */
2703
+ user: IUserInformation;
2704
+ }
2696
2705
  /**
2697
2706
  * Represents a specific address within a district, providing detailed street-level information. This record extends the to include street name and potential street number ranges, which can be used to generate random house numbers within simulations.
2698
2707
  *
@@ -2912,6 +2921,38 @@ export interface AddressState {
2912
2921
  */
2913
2922
  stateName: string;
2914
2923
  }
2924
+ export declare enum AuditAction {
2925
+ /**
2926
+ * Indicates that a new entity was created in the system.
2927
+ *
2928
+ */
2929
+ Create = 0,
2930
+ /**
2931
+ * Indicates that an existing entity was modified in the system.
2932
+ *
2933
+ */
2934
+ Update = 1,
2935
+ /**
2936
+ * Indicates that an entity was removed from the system.
2937
+ *
2938
+ */
2939
+ Delete = 2
2940
+ }
2941
+ export declare enum AuditActionSub {
2942
+ OperationPreselectionAddSuggestion = 0,
2943
+ OperationPreselectionAddManual = 1,
2944
+ OperationPreselectionRemoveManual = 2,
2945
+ OperationPreselectionRemoveTimeout = 3,
2946
+ OperationTaskMatch = 4,
2947
+ OperationTaskMissmatch = 5,
2948
+ OperationTaskExecuted = 6,
2949
+ OperationDispatch = 7,
2950
+ OperationDispatchCancel = 8,
2951
+ OperationStatusChange = 9
2952
+ }
2953
+ export declare enum AuditEntityType {
2954
+ Operation = 0
2955
+ }
2915
2956
  export declare enum CommandcenterCategory {
2916
2957
  AerztlicherBereitschaftsdienst = 0,
2917
2958
  Einsatzleitstelle = 1,
@@ -3172,38 +3213,6 @@ export declare enum NotificationCategory {
3172
3213
  */
3173
3214
  OpenTask = 9
3174
3215
  }
3175
- export declare enum OperationEventCategory {
3176
- /**
3177
- * Indicates that the operation was created.
3178
- *
3179
- */
3180
- Created = 0,
3181
- /**
3182
- * Represents a change in a property of the operation.
3183
- *
3184
- */
3185
- ChangedProperty = 1,
3186
- /**
3187
- * Represents a suggestion for unit assignment within the operation.
3188
- *
3189
- */
3190
- UnitSuggestion = 2,
3191
- /**
3192
- * Indicates that a dispatch action occurred within the operation.
3193
- *
3194
- */
3195
- Dispatch = 3,
3196
- /**
3197
- * Represents a status update for a unit involved in the operation.
3198
- *
3199
- */
3200
- UnitStatus = 4,
3201
- /**
3202
- * Represents a task-related event within the operation.
3203
- *
3204
- */
3205
- Task = 5
3206
- }
3207
3216
  export declare enum OperationPriority {
3208
3217
  /**
3209
3218
  * The priority has not been set, indicating an undefined or initial state.
@@ -3499,98 +3508,76 @@ export declare enum SessionEventType {
3499
3508
  *
3500
3509
  */
3501
3510
  OperationPropertyChanged = 4,
3502
- /**
3503
- * Indicates that a new event has been created within an operation.
3504
- *
3505
- */
3506
- OperationEventCreated = 5,
3507
3511
  /**
3508
3512
  * Indicates that documentation for an operation has been created.
3509
3513
  *
3510
3514
  */
3511
- OperationDocumentationCreated = 6,
3515
+ OperationDocumentationCreated = 5,
3512
3516
  /**
3513
3517
  * Indicates that a patient record for an operation has been created.
3514
3518
  *
3515
3519
  */
3516
- OperationPatientCreated = 7,
3520
+ OperationPatientCreated = 6,
3517
3521
  /**
3518
3522
  * Indicates that a task within an operation has been created.
3519
3523
  *
3520
3524
  */
3521
- OperationTaskCreated = 8,
3525
+ OperationTaskCreated = 7,
3522
3526
  /**
3523
3527
  * Indicates that a task within an operation has been removed.
3524
3528
  *
3525
3529
  */
3526
- OperationTaskRemoved = 9,
3530
+ OperationTaskRemoved = 8,
3527
3531
  /**
3528
3532
  * Indicates that a task within an operation is set to execute.
3529
3533
  *
3530
3534
  */
3531
- OperationTaskExecute = 10,
3535
+ OperationTaskExecute = 9,
3532
3536
  /**
3533
3537
  * Indicates that a resource is now suggested for use.
3534
3538
  *
3535
3539
  */
3536
- ResourceNowSuggested = 11,
3540
+ ResourceNowSuggested = 10,
3537
3541
  /**
3538
3542
  * Indicates that a resource is no longer suggested for use.
3539
3543
  *
3540
3544
  */
3541
- ResourceNoLongerSuggested = 12,
3545
+ ResourceNoLongerSuggested = 11,
3542
3546
  /**
3543
3547
  * Indicates that the status of a resource has changed.
3544
3548
  *
3545
3549
  */
3546
- ResourceStatusChanged = 13,
3550
+ ResourceStatusChanged = 12,
3547
3551
  /**
3548
3552
  * Indicates that a resource has been dispatched.
3549
3553
  *
3550
3554
  */
3551
- ResourceDispatched = 14,
3555
+ ResourceDispatched = 13,
3552
3556
  /**
3553
3557
  * Indicates that the dispatch of a resource has been canceled.
3554
3558
  *
3555
3559
  */
3556
- ResourceDispatchCanceled = 15,
3560
+ ResourceDispatchCanceled = 14,
3557
3561
  /**
3558
3562
  * Indicates that the dispatch of a resource has been completed.
3559
3563
  *
3560
3564
  */
3561
- ResourceDispatchCompleted = 16,
3565
+ ResourceDispatchCompleted = 15,
3562
3566
  /**
3563
3567
  * Indicates that the position of a resource has changed.
3564
3568
  *
3565
3569
  */
3566
- ResourcePositionChanged = 17,
3570
+ ResourcePositionChanged = 16,
3567
3571
  /**
3568
3572
  * Indicates a request for a resource to speak.
3569
3573
  *
3570
3574
  */
3571
- ResourceSpeakRequest = 18,
3575
+ ResourceSpeakRequest = 17,
3572
3576
  /**
3573
3577
  * Indicates that a notification has been created.
3574
3578
  *
3575
3579
  */
3576
- NotificationCreated = 19
3577
- }
3578
- export declare enum SessionState {
3579
- /**
3580
- * The session has been requested but not yet processed.
3581
- *
3582
- */
3583
- Requested = 0,
3584
- /**
3585
- * The session is ready for use.
3586
- *
3587
- */
3588
- Ready = 100,
3589
- /**
3590
- * The session has failed due to an error or issue.
3591
- *
3592
- */
3593
- Failed = 200
3580
+ NotificationCreated = 18
3594
3581
  }
3595
3582
  export declare enum SessionWebhookMethod {
3596
3583
  GET = 0,
@@ -3795,26 +3782,6 @@ export declare enum TaskStatus {
3795
3782
  */
3796
3783
  NotSupported = 5
3797
3784
  }
3798
- export declare enum UIText {
3799
- BtnSave = 0,
3800
- BtnDuplicate = 1,
3801
- BtnDelete = 2,
3802
- BtnRemove = 3,
3803
- BtnCancel = 4,
3804
- BtnConfirm = 5,
3805
- BtnCreate = 6,
3806
- BtnOk = 7,
3807
- LblRequired = 8,
3808
- LblOptional = 9,
3809
- DlgTitleDelete = 10,
3810
- DlgBodyDelete = 11,
3811
- DlgBodyDeleteWithInput = 12,
3812
- DlgTitleSuccess = 13,
3813
- DlgBodySuccessSaved = 14,
3814
- DlgTitleFailed = 15,
3815
- DlgTitleProcessing = 16,
3816
- DlgBodyProcessing = 17
3817
- }
3818
3785
  export declare enum UnitCategory {
3819
3786
  DLK = 0,
3820
3787
  ELW1 = 1,
@@ -4047,13 +4014,6 @@ export declare namespace SignalRDefaults {
4047
4014
  */
4048
4015
  const ServerTimeoutSeconds: number;
4049
4016
  }
4050
- export declare namespace SIMDispatcherDefaults {
4051
- /**
4052
- * URL for accessing forums.
4053
- *
4054
- */
4055
- const Forums: string;
4056
- }
4057
4017
  export declare namespace UrlDefaults {
4058
4018
  /**
4059
4019
  * URL for contact the customer support.
@@ -4070,8 +4030,6 @@ export declare namespace UrlDefaults {
4070
4030
  *
4071
4031
  */
4072
4032
  const Bugtracker: string;
4073
- namespace Server {
4074
- }
4075
4033
  }
4076
4034
  export declare namespace UserInterfaceDefaults {
4077
4035
  namespace UnitStatusBackground {