-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
935 lines (935 loc) · 36.8 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
openapi: 3.0.2
info:
title: Emergency Incident Data Object (EIDO)
description: >-
A standard format and content definition for exchanging emergency incident
related data.
contact:
name: Richard Maw
email: [email protected]
version: '0.0.3'
servers:
- url: 'http://localhost/'
- url: 'https://localhost/'
paths:
'/EIDO/{IncidentId}':
get:
tags:
- Dereference
summary: Dereference an EIDO reference
operationId: GetEIDO
parameters:
- name: IncidentId
in: path
required: true
description: The id of the incident represented in the EIDO
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EmergencyIncidentDataObjectType'
components:
schemas:
ReferenceType:
title: Reference
required:
- $ref
properties:
$ref:
type: string
description: The $id value of the referenced data component
PrologueType:
title: Prologue
required:
- $id
- lastUpdateTimeStamp
type: object
properties:
$id:
type: string
description: Globally unique identifier of the data component
lastUpdateTimeStamp:
type: string
description: Timestamp of the last time the data component was modified
format: date-time
owningAgencyIdentifier:
type: string
description:
Owning Agency Identifier. This includes private and public
providers. Agencies are globally unique.
updatedByAgentIdentifier:
type: string
description:
A globally unique identifier of the agent or automaton that updated
the data component last
description: A common prologue on each data component
AgencyType:
title: Agency Type
description:
A data type for an organization that owns or is otherwise related to an
emergency incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- agencyRoleDescriptionRegistryText
- organizationIdentification
- agencyType
properties:
agencyRoleDescriptionRegistryText:
type: string
description: Shall only contains values present in the Agency Role registry
incidentOwningAgencyIndicator:
type: boolean
description: True if an agency owns the emergency incident; false otherwise
AgencyType:
type: array
items:
type: string
description: One or more members of a list of available provider and agency types such as Law Enforcement, Fire, EMS, Consolidated Dispatch, Ambulance Company, etc. Agency Types are defined in the IANA SOS- SubServices registry
organizationIdentification:
type: string
description:
Agency Identifier. This includes private and public providers.
Agencies are globally unique. See NENA-STA-010 Agency Identifier
section for the format and requirements
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the agency.
AgentType:
title: Agent Type
description: A data type for information about agents (e.g., call takers,
dispatchers, supervisors, responding emergency resources, etc.) and
automated systems acting as agents that are involved in an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- agentIdentification
- personRoleRegistryText
properties:
agentIdentification:
type: string
description: A globally unique identifier of an agent or automaton
responsible for generating an EIDO and/or that contributed
information contained in an EIDO.
agentWorkstationPositionIdentification:
type: string
description:
A globally unique identifier of a workstation position that
generated an EIDO or contributed information contained in an
EIDO.
agentRoleRegistryText:
type: array
items:
type: string
description: Shall only contains values present in the Agent Role registry
agencyReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked element type is AgencyType
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the agent.
IncidentMergeDirectionCodeSimpleType:
title: Incident Merge Direction Code Simple Type
type: string
description: A data type for a code list for a direction of a merge or split.
example: REPLACING
enum:
- REPLACING
- REPLACED
- SPLIT
MergeInformationType:
title: MergeInformationType
description: A data type for information about a merged or split incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- incidentMergeDirectionCode
- incidentTrackingIdentification
properties:
incidentTrackingIdentification:
type: string
description: A globally unique emergency incident identifier.
incidentMergeDirectionCode:
$ref: '#/components/schemas/IncidentMergeDirectionCodeSimpleType'
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked element type is AgentType
LinkDirectionCodeSimpleType:
title: Link Direction Code Simple Type
type: string
description: A data type for a code list for a kind of link performed.
example: PARENT
enum:
- PARENT
- CHILD
- RELATED
- UNLINK
LinkInformationType:
title: Link Information Type
description: A data type for information about a linked incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- incidentTrackingIdentification
- linkDirectionCode
properties:
incidentTrackingIdentification:
type: string
description: A globally unique emergency incident identifier.
transactionReasonText:
type: string
description: Free format narrative description of the reason for the link
involvedAgencyReference:
$ref: '#/components/schemas/ReferenceType'
description:
Agencies involved with the linked incident. Must be populated if
the agency sending the EIDO is not involved with the linked
incident.
linkDirectionCode:
$ref: '#/components/schemas/LinkDirectionCodeSimpleType'
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked element type is AgentType
NotesType:
title: Notes Type
description: A data type for notes and comments associated with an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- notesActionComments
properties:
notesActionComments:
type: string
description: A note about an incident created by an agent; in HTML5 format.
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked element type is AgentType
AdditionalDataType:
title: Additional Data Type
description:
A data type for additional information associated with an incident call,
location, or person.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
properties:
additionalDataURL:
type: string
description: A URL that references additional data associated with a call.
additionalDataDetail:
type: string
description: Additional data associated with a call.
notesReference:
type: array
description:
Notes and comments associated with an incident. Linked elements
type are NotesType
items:
$ref: '#/components/schemas/ReferenceType'
LocationInformationType:
title: Location Information Type
description: A data type for a location associated with an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- locationTypeDescriptionRegistryText
properties:
locationTypeDescriptionRegistryText:
type: string
description: Shall only contains values present in the Location type registry
locationByValue:
type: string
description:
A type for an external adapter for a Presence Information Data
Format-Location Object (PIDF-LO).
locationDescriptionText:
type: string
description: Optional text further describing the location type.
locationByReferenceURL:
type: string
description:
A URL where a location associated with an incident can be
dereferenced.
format: uri
crossStreetByValue:
type: array
description:
A nearest cross street to an incident's location in PIDF-LO
format.
items:
type: string
crossStreetByReferenceURL:
type: array
description:
A URL where a nearest cross street to an incident's location can
be dereferenced.
items:
type: string
intersectingStreetByValue:
type: array
description: An additional street, that with the location forms an
intersection, in PIDF-LO format.
items:
type: string
intersectingStreetByReferenceURL:
type: array
description:
A URL where an additional street, that with the location forms
an intersection, can be dereferenced.
items:
type: string
cellTowerSectorID:
type: string
description:
The nearest cell tower and sector/face of the tower receiving a
call associated with an incident.
additionalDataReference:
type: array
description:
Additional information associated with an incident call,
location, or person. Linked elements type are AdditionalDataType
items:
$ref: '#/components/schemas/ReferenceType'
notesReference:
type: array
description:
Notes and comments associated with an incident. Linked elements
type are NotesType
items:
$ref: '#/components/schemas/ReferenceType'
PersonInformationType:
title: Person Information Type
description: A data type for information about a person associated with an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- personIncidentRoleRegistryText
properties:
ncPersonComponent:
$ref: 'NIEMComponents//nc.yaml#/components/schemas/ncPersonType'
personIncidentRoleRegistryText:
type: array
description: Shall only contains values present in the Person Role registry
items:
type: string
additionalDataReference:
type: array
description:
Additional information associated with an incident call,
location, or person. Linked elements type are AdditionalDataType
items:
$ref: '#/components/schemas/ReferenceType'
locationReference:
type: array
description:
A location associated with an Person. Linked elements type is
LocationInformationType
items:
$ref: '#/components/schemas/ReferenceType'
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the person.
DispositionType:
title: Disposition Type
description:
A data type for incident disposition information entered or updated by a
dispatch agent and/or a responding emergency resource.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- dispositionCommonRegistryCode
properties:
dispositionCommonRegistryCode:
type: string
description:
Shall only contains values present in the Common Disposition
Code registry
dispositionPrimaryIndicator:
type: boolean
description:
True if the common disposition is the primary disposition for an
agency for an incident; false otherwise.
dispositionCategoryText:
type: string
dispositionDescriptionText:
type: string
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the incident.
VehicleInformationType:
title: Vehicle Information Type
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- ncVehicleComponent
- vehicleRelationshipType
- vehicleRelationshipTimeStamp
properties:
ncVehicleComponent:
$ref: 'NIEMComponents//nc.yaml#/components/schemas/ncVehicleType'
vehicleRelationshipType:
type: array
description:
Information about a vehicle associated with an incident. Shall
only contains values present in the Vehicle Relationship Type
registry
items:
type: string
vehicleRelationshipTimeStamp:
type: string
description:
The date and time that the relationship of the vehicle to the
incident was established
format: date-time
additionalDataReference:
type: array
description:
Additional information associated with a vehicle. Linked
elements type is AdditionalDataType
items:
$ref: '#/components/schemas/ReferenceType'
locationReference:
type: array
description:
A location associated with an vehicle. Linked elements type is
LocationInformationType
items:
$ref: '#/components/schemas/ReferenceType'
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the vehicle.
IncidentInformationType:
title: Incident Information Type
description:
A data type for general information about emergency incidents gathered
by emergency agents, responding emergency resources, from reporting
parties (callers), and devices reporting emergency incidents.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- incidentTypeCommonRegistryText
properties:
incidentTypeInternalCode:
type: string
description:
An alphanumeric code indicating the category of the incident.
This is the internal code used by the local agencies involved in
the incident.
incidentTypeInternalText:
type: string
description:
Textual description indicating the category of the incident.
This is the internal text used by the local agencies involved in
the incident.
incidentTypeCommonRegistryText:
type: string
description: Shall only contains values present in the Incident Type registry
incidentStatusInternalText:
type: array
description:
An internal code used by a local agency for a status of an
incident.
items:
type: string
incidentStatusCommonRegistryText:
type: string
description:
Shall only contains values present in the Incident Status
registry
internalIncidentID:
type: string
agentReference:
type: array
description: Linked elements type is AgentType
items:
$ref: '#/components/schemas/ReferenceType'
locationReference:
type: array
description:
A location associated with an incident. Linked elements type is
LocationInformationType
items:
$ref: '#/components/schemas/ReferenceType'
personReference:
type: array
description:
Information about a person associated with an incident. Linked
elements type is PersonInformationType
items:
$ref: '#/components/schemas/ReferenceType'
vehicleReference:
type: array
description:
Information about a vehicle associated with an incident. Linked
elements type is VehicleInformationType
items:
$ref: '#/components/schemas/ReferenceType'
documentIdentification:
type: string
reportNumberType:
type: string
incidentPriorityInternalText:
type: string
description:
An internal value used by a local agency for the priority of an
incident.
incidentCommonPriorityNumber:
type: integer
description: A globally unique priority of an incident.
format: int32
beatOrDispatchGroupText:
type: string
description: A beat or dispatch group that contains an incident.
dispositionComponent:
type: array
description:
Incident disposition information entered or updated by a
dispatch agent and/or a responding emergency resource.
items:
$ref: '#/components/schemas/DispositionType'
notesReference:
$ref: '#/components/schemas/ReferenceType'
description:
Reference to a Notes Data Component. Contains optional
alphanumeric text further describing the incident.
UpdatedCBNType:
title: Updated CBN Type
description:
A data type for additional telephone numbers and SIP equivalents that
can be used to contact the individual that made a call associated with
an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- updatedCBNIdentifierURI
properties:
updatedCBNIdentifierURI:
type: string
description:
A telephone number or SIP equivalent of a reporting party
described in the parent call.
format: uri
updatedCBNCallerDescription:
type: string
description:
Additional descriptive text about an updated caller call back
number such as the days and hours to use it and the type of
number (e.g., work, home, friend, etc.).
CallInformationType:
title: CallInformationType
description:
A data type for call information about an incident received and
collected by an agent.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- callIdentifier
- callStatusRegistryText
- callTypeDescriptionRegistryText
- activityDateRange
- deviceCallBackInformationURL
- deviceContactHeader
properties:
callIdentifier:
type: string
description: An identifier of a call associated with an incident.
relatedCallIdentifier:
type: string
description:
CallIdentifier of calls that are related to this call. Eg
Callbacks
queueIdentifier:
type: string
description: An identifier of a queue where the call is currently on.
callTypeDescriptionRegistryText:
type: string
description:
Shall only contains values present in the Call Origination
registry
additionalDataReference:
type: array
description:
Additional information associated with an incident call,
location, or person. Linked elements type is AdditionalDataType
items:
$ref: '#/components/schemas/ReferenceType'
activityDateRange:
$ref: 'NIEMComponents//nc.yaml#/components/schemas/ncDateRangeType'
answerDate:
type: string
description: A date on which the call was answered by an agent.
format: date-time
callStatusRegistryText:
type: string
description: Shall only contains values present in the Call Status registry
callMediaURL:
type: array
description:
A location where media associated with the call (images,
streaming video, streaming audio, etc.) is available.
items:
type: string
format: uri
deviceCallBackInformationURL:
type: array
description:
A URL containing limited duration information for a telephone
number or SIP equivalent for calling back a device that
initiated a call. URI(s) found in the P-Asserted-Identity
header if provided else the URI in the From header.
items:
type: string
format: uri
deviceContactHeader:
type: string
description:
Content of the device contact header.
verstat:
type: string
description:
Value of the verstat parameter. Required if known.
SIPIdentity:
type: string
description:
Content of the SIP identity header. Required if known.
callerCallBackInformationURL:
type: string
description:
A URL for a telephone number or SIP equivalent for calling back
a caller that initiated a call.
format: uri
agentReference:
type: array
description: Linked elements type is AgentType
items:
$ref: '#/components/schemas/ReferenceType'
updatedCBN:
type: array
items:
$ref: '#/components/schemas/UpdatedCBNType'
locationReference:
type: array
description:
A location associated with an incident. Linked elements type is
LocationInformationType
items:
$ref: '#/components/schemas/ReferenceType'
personReference:
type: array
description:
Information about a person associated with an incident. Linked
elements type is PersonInformationType
items:
$ref: '#/components/schemas/ReferenceType'
EmergencyResourceType:
title: Emergency Resource Type
description: A data type for a resource (vehicle, person [foot patrol],
organizational unit such as a squad or strike team, and other emergency
responder configurations) that responds to an emergency incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- agentReference
- emergencyResourceTypeCommonRegistryText
- enforcmentUnitName
- primaryUnitStatusRegistryText
- resourceAttributeRegistryText
- enforcementUnitName
- secondaryUnitStatusRegistryText
properties:
ETA:
type: string
description: Timestamp of when the unit is expected to reach it's destination
format: date-time
emergencyResourceTypeCommonRegistryText:
type: string
description:
Shall only contains values present in the Emergency Resource
Type registry
emergencyResourceTypeInternalText:
type: string
description: A local code for an emergency resource type.
resourceAttributeRegistryText:
type: array
description:
Shall only contains values present in the Resource Attribute
registry
items:
type: string
enforcementUnitName:
type: string
enforcementUnitIdentification:
type: string
primaryUnitStatusRegistryText:
type: string
description:
Shall only contains values present in the Primary Unit Status
registry
secondaryUnitStatusRegistryText:
type: array
description:
Shall only contains values present in the Secondary Unit Status
registry
items:
type: string
notesReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is NotesType
unitStatusInternal:
type: array
description: A local code for a status of an emergency resource.
items:
type: string
agentReference:
type: array
description:
Information about agents (e.g., call takers, dispatchers,
supervisors, responding emergency resources, etc.) and automated
systems acting as agents that are involved in an incident.
Linked elements type is AgentType
items:
$ref: '#/components/schemas/ReferenceType'
unitLocationReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is LocationInformationType
unitDestinationReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is LocationInformationType
personReference:
type: array
description:
Information about a person associated with an incident. Linked
elements type is PersonInformationType
items:
$ref: '#/components/schemas/ReferenceType'
vehicleReference:
type: array
description:
Information about a vehicle associated with an incident. Linked
elements type is VehicleInformationType
items:
$ref: '#/components/schemas/ReferenceType'
dispositionComponent:
type: array
description:
Incident disposition information entered or updated by a
dispatch agent and/or a responding emergency resource.
items:
$ref: '#/components/schemas/DispositionType'
additionalDataReference:
type: array
description:
Additional information associated with an emergency resource.
Linked elements type is AdditionalDataType
items:
$ref: '#/components/schemas/ReferenceType'
DispatchInformationType:
title: Dispatch Information Type
description: A data type for dispatch information related to an incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
properties:
organizationIdentification:
type: string
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is AgentType
emergencyResourceReference:
type: array
description:
A resource (vehicle, person [foot patrol], organizational unit
such as a squad or strike team, and other emergency responder
configurations) that responds to an emergency incident. Linked
elements type is EmergencyResourceType
items:
$ref: '#/components/schemas/ReferenceType'
AlarmsSensorsType:
title: AlarmsSensorsType
description:
A data type for alarms and sensors information associated with an
incident.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
properties:
CSAAAlarmInformation:
type: string
description:
Central Station Alarm Association (CSAA) data associated with an
incident.
alarmURL:
type: string
description:
A URL that references Central Station Alarm Association (CSAA)
data associated with an incident.
format: uri
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is AgentType
EmergencyIncidentDataObjectType:
title: Emergency Incident Data Object Type
description:
A data type for an information exchange containing emergency incident
related data.
allOf:
- $ref: '#/components/schemas/PrologueType'
- type: object
required:
- EIDOVersion
- agentReference
- issuingElementIdentification
- reasonForIssueRegistryText
properties:
EIDOVersion:
type: string
description: Version of the EIDO structure.
enum:
- '1.0'
incidentTrackingIdentifier:
type: string
description: A globally unique emergency incident identifier.
reasonForIssueRegistryText:
type: string
description:
Shall only contains values present in the Reason For Issue
registry
issuingElementIdentification:
type: string
description:
An identifier of a functional element that created the EIDO
instance.
incidentCollaborationURL:
type: array
description:
A URL reference to multi-media collaboration information
associated with an incident.
items:
type: string
format: uri
agentReference:
$ref: '#/components/schemas/ReferenceType'
description: Linked elements type is AgentType
agencyReference:
type: array
description:
An organization that owns or is otherwise related to an
emergency incident. Linked elements type is AgencyType
items:
$ref: '#/components/schemas/ReferenceType'
mergeComponent:
type: array
description: Information about a merged or split incident.
items:
$ref: '#/components/schemas/MergeInformationType'
linkComponent:
type: array
description: Information about a linked incident.
items:
$ref: '#/components/schemas/LinkInformationType'
incidentComponent:
$ref: '#/components/schemas/IncidentInformationType'
description:
General information about the emergency incident gathered by
emergency agents, responding emergency resources, from reporting
parties (callers), and devices reporting emergency incidents.
callComponent:
type: array
description:
Call information about an incident received and collected by an
agent.
items:
$ref: '#/components/schemas/CallInformationType'
dispatchComponent:
type: array
description: Dispatch information related to an incident.
items:
$ref: '#/components/schemas/DispatchInformationType'
alarmsSensorsComponent:
type: array
description: Alarms and sensors information associated with an incident.
items:
$ref: '#/components/schemas/AlarmsSensorsType'
agencyComponent:
type: array
description: All agencies referenced in this document are listed here
items:
$ref: '#/components/schemas/AgencyType'
agentComponent:
type: array
description: All agents referenced in this document are listed here
items:
$ref: '#/components/schemas/AgentType'
notesComponent:
type: array
description: All notes referenced in this document are listed here
items:
$ref: '#/components/schemas/NotesType'
additionalDataComponent:
type: array
description: All additional data referenced in this document are listed here
items:
$ref: '#/components/schemas/AdditionalDataType'
locationInformationComponent:
type: array
description:
All location informations referenced in this document are listed
here
items:
$ref: '#/components/schemas/LocationInformationType'
personInformationComponent:
type: array
description:
All person informations referenced in this document are listed
here
items:
$ref: '#/components/schemas/PersonInformationType'
vehicleInformationComponent:
type: array
description:
All vehicle informations referenced in this document are listed
here
items:
$ref: '#/components/schemas/VehicleInformationType'
emergencyResourceComponent:
type: array
description:
All emergency resources information referenced in this document
are listed here
items:
$ref: '#/components/schemas/EmergencyResourceType'
'@context':
type: object
description: JSON-LD context
properties:
'@vocab':
type: string
enum:
- './JSON-LD_Contexts/EmergencyIncidentDataObjectType.jsonld'