NIEM Examples - Alarm Exchange Transactions (ALQ/ALR)
Alarm Exchange NIEM Specifications
This section describes the NIEM format specifications and provides examples for the Alarm Exchange Transactions (ALQ/ALR).
The Alarm Exchange Message Transaction follows a National Information Exchange Model (NIEM) structure. The payload of the message will be located inside of the <![CDATA[]]> tag of the Nlets message.
The standardization of this message is maintained by The Association of Public-Safety Communications Officials (APCO) and Central Station Alarm Association (CSAA). Additional documentation on this message key can be found at http://niem.gtri.gatech.edu/niemtools/iepdt/display/container.iepd?ref=Ow8gz1Pl7b4#.
All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.
Element Dictionary
Transaction types detailed below include: Alarm Exchange Query (ALQ) & Alarm Exchange Response (ALR).
Query Formats
Alarm Exchange Query (ALQ)
Inquiry Data (n:NLETSInquiryData)
This element will contain all elements specific to this transaction.
Query Text (n:InquiryText)
This element will contain the payload of the message. Nlets recommends the use of
<![CDATA[]]>
tags to ensure that the response does not contain any characters illegal in XML.
Response Formats
Alarm Exchange Response (ALR)
Response Data (n2:NLETSResponseData)
This element will contain all elements specific to this transaction.
Response Text (n2:ResponseText)
This element will contain the payload of the response. Nlets recommends the use of
<![CDATA[]]>
tags to ensure that the response does not contain any characters illegal in XML.
Alarm Exchange NIEM Examples
Example 1: An Alarm Exchange query.
<n2:NLETS xmlns:n2="http://www.nlets.org/niem/1.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
version="4.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>ALQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>NL00001VS</nh2:OriginatingORIID>
<nh2:DestinationORIID>VA12200B2</nh2:DestinationORIID>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="String">
<n2:InquiryText>
<![CDATA[ <apco-alarm:ExternalAlarm xmlns:em="http://niem.gov/niem/domains/emergencyManagement/2.0" xmlns:j="http://niem.gov/niem/domains/jxdm/4.0" xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:apco-alarm="http://www.apcointl.com/new/commcenter911/external-alarm.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <apco-alarm:AlarmPayload> <j:ActivityLocationAssociation> <nc:ActivityReference s:ref="act1"/> <nc:LocationReference s:ref="loc1"/> </j:ActivityLocationAssociation> <apco-alarm:AlarmEvent s:id="act1"> <nc:ActivityIdentification> <nc:IdentificationID>111111111</nc:IdentificationID> </nc:ActivityIdentification> <nc:ActivityCategoryText>Alarm</nc:ActivityCategoryText> <nc:ActivityDate> <nc:DateTime>2012-01-01T16:00:00.000Z</nc:DateTime> </nc:ActivityDate> <nc:ActivityStatus> <nc:StatusDescriptionText> </nc:StatusDescriptionText> </nc:ActivityStatus> <em:AlarmEventCategoryText>TAMPER</em:AlarmEventCategoryText> <em:AlarmEventLocationCategoryText>Commercial</em:AlarmEventLocationCategoryText> <em:AlarmEventDetailsText>XXX111DOOR(S) CARRAGE HSE 100</em:AlarmEventDetailsText> <em:AlarmEventCallPrivacyBypassCode> </em:AlarmEventCallPrivacyBypassCode> <em:AlarmEventPermit> <em:PermitIdentification> <nc:IdentificationID> </nc:IdentificationID> </em:PermitIdentification> <em:PermitCategoryText> </em:PermitCategoryText> </em:AlarmEventPermit> <em:AlarmEventDispatchAgency> <nc:OrganizationIdentification> <nc:IdentificationID>VA12200B2</nc:IdentificationID> </nc:OrganizationIdentification> <nc:OrganizationName>P-RICHMOND (CITY), VA-APCO</nc:OrganizationName> </em:AlarmEventDispatchAgency> <apco-alarm:AlarmEventAugmentation> <apco-alarm:AlarmAudibleDescriptionText>AUDIBLE</apco-alarm:AlarmAudibleDescriptionText> <apco-alarm:AlarmConfirmationText> </apco-alarm:AlarmConfirmationText> <apco-alarm:CallToPremiseText>ANSWERING MACH/NO MESSAGE</apco-alarm:CallToPremiseText> </apco-alarm:AlarmEventAugmentation> </apco-alarm:AlarmEvent> <apco-alarm:AlarmMonitoringStation> <nc:OrganizationIdentification> <nc:IdentificationID>NL00001VS</nc:IdentificationID> </nc:OrganizationIdentification> <nc:OrganizationName>VECTOR SECURITY</nc:OrganizationName> <apco-alarm:AlarmMonitoringStationAugmentation> <nc:PersonCurrentEmploymentAssociation> <nc:EmployeeIdentification> <nc:IdentificationID>DMB</nc:IdentificationID> </nc:EmployeeIdentification> <nc:EmploymentContactInformationReference s:ref="cxt1"/> </nc:PersonCurrentEmploymentAssociation> <nc:SourceIDText>NL00001VS</nc:SourceIDText> </apco-alarm:AlarmMonitoringStationAugmentation> </apco-alarm:AlarmMonitoringStation> <apco-alarm:AlarmServiceLocation s:id="loc1"> <nc:LocationAddress> <nc:AddressFullText>116 E LEIGH ST MAGGIE WALKER COMPLEX VA 23223</nc:AddressFullText> <nc:StructuredAddress> <nc:AddressSecondaryUnitText> </nc:AddressSecondaryUnitText> <nc:AddressSecondaryUnitText> </nc:AddressSecondaryUnitText> <nc:AddressBuildingText> </nc:AddressBuildingText> <nc:LocationStreet> <nc:StreetNumberText>116</nc:StreetNumberText> <nc:StreetPredirectionalText>E</nc:StreetPredirectionalText> <nc:StreetName>LEIGH</nc:StreetName> <nc:StreetCategoryText>ST</nc:StreetCategoryText> <nc:StreetPostdirectionalText> </nc:StreetPostdirectionalText> </nc:LocationStreet> <nc:LocationCityName>RICHMOND</nc:LocationCityName> <nc:LocationCountyName>RICHMOND CITY</nc:LocationCountyName> <nc:LocationStateName>VA</nc:LocationStateName> <nc:LocationPostalCode>23223</nc:LocationPostalCode> </nc:StructuredAddress> </nc:LocationAddress> <nc:LocationCrossStreet> <nc:CrossStreetDescriptionText> </nc:CrossStreetDescriptionText> </nc:LocationCrossStreet> <nc:LocationDescriptionText> </nc:LocationDescriptionText> <nc:LocationName>MAGGIE WALKER COMPLEX</nc:LocationName> <em:AlarmEventLocationAugmentation> <em:LocationDirectionsText> </em:LocationDirectionsText> <em:LocationInformationText> </em:LocationInformationText> </em:AlarmEventLocationAugmentation> <apco-alarm:AlarmServiceLocationAugmentation> <apco-alarm:LocationCaptureDateTime>2012-01-01T16:00:00.000Z</apco-alarm:LocationCaptureDateTime> </apco-alarm:AlarmServiceLocationAugmentation> </apco-alarm:AlarmServiceLocation> <nc:ContactInformation s:id="cxt1"> <nc:ContactTelephoneNumber> <nc:FullTelephoneNumber> <nc:TelephoneNumberFullID>800-666-4642</nc:TelephoneNumberFullID> </nc:FullTelephoneNumber> </nc:ContactTelephoneNumber> <nc:ContactTelephoneNumber> <nc:NANPTelephoneNumber> <nc:TelephoneAreaCodeID>800</nc:TelephoneAreaCodeID> <nc:TelephoneExchangeID>666</nc:TelephoneExchangeID> <nc:TelephoneLineID>4642</nc:TelephoneLineID> </nc:NANPTelephoneNumber> </nc:ContactTelephoneNumber> <nc:ContactInformationDescriptionText>Land line</nc:ContactInformationDescriptionText> </nc:ContactInformation> <nc:ContactInformation s:id="cxt2"> <nc:ContactTelephoneNumber> <nc:FullTelephoneNumber> <nc:TelephoneNumberFullID>804-795-5018</nc:TelephoneNumberFullID> </nc:FullTelephoneNumber> <nc:NANPTelephoneNumber> <nc:TelephoneAreaCodeID>804</nc:TelephoneAreaCodeID> <nc:TelephoneExchangeID>795</nc:TelephoneExchangeID> <nc:TelephoneLineID>5018</nc:TelephoneLineID> <nc:TelephoneSuffixID> </nc:TelephoneSuffixID> </nc:NANPTelephoneNumber> </nc:ContactTelephoneNumber> </nc:ContactInformation> <nc:PersonActivityInvolvementAssociation> <nc:ActivityReference s:ref="act1"/> </nc:PersonActivityInvolvementAssociation> <nc:PersonContactInformationAssociation> <nc:ContactInformationReference s:ref="cxt2"/> </nc:PersonContactInformationAssociation> </apco-alarm:AlarmPayload> </apco-alarm:ExternalAlarm> ]]></n2:InquiryText>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 2: An Alarm Exchange response.
<n2:NLETS xmlns:n2="http://www.nlets.org/niem/1.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
version="4.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>ALR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>VA12200P6</nh2:OriginatingORIID>
<nh2:DestinationORIID>NL00001VS</nh2:DestinationORIID>
</n2:NLETSMessageHeader>
<n2:NLETSResponseData n2:key="ALR">
<n2:ResponseText>
<![CDATA[ <apco-alarm:ExternalAlarm xmlns:j="http://niem.gov/niem/domains/jxdm/4.0" xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:ns1="http://niem.gov/niem/fbi/2.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0" xmlns:ns3="http://niem.gov/niem/appinfo/2.0" xmlns:ns2="http://niem.gov/niem/nga/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:apco-alarm="http://www.apcointl.com/new/commcenter911/external-alarm.xsd" xmlns:em="http://niem.gov/niem/domains/emergencyManagement/2.0"> <apco-alarm:AlarmPayload> <apco-alarm:AlarmEvent> <nc:ActivityIdentification> <nc:IdentificationID>237411570</nc:IdentificationID> </nc:ActivityIdentification> <nc:ActivityStatus> <nc:StatusText>Accept</nc:StatusText> <nc:StatusDescriptionText>SENT TO POLICE DISPATCH QUEUE</nc:StatusDescriptionText> </nc:ActivityStatus> <em:AlarmEventDispatchAgency> <nc:OrganizationIdentification> <nc:IdentificationID>VA12200B2</nc:IdentificationID> </nc:OrganizationIdentification> </em:AlarmEventDispatchAgency> <apco-alarm:AlarmEventAugmentation> <apco-alarm:AlarmEventDispatchActivity> <nc:ActivityIdentification> <nc:IdentificationID>201201010000</nc:IdentificationID> </nc:ActivityIdentification> </apco-alarm:AlarmEventDispatchActivity> </apco-alarm:AlarmEventAugmentation> </apco-alarm:AlarmEvent> <apco-alarm:AlarmMonitoringStation> <nc:OrganizationIdentification> <nc:IdentificationID>NL00001VS</nc:IdentificationID> </nc:OrganizationIdentification> <apco-alarm:AlarmMonitoringStationAugmentation> <nc:SourceIDText>NL00001VS</nc:SourceIDText> </apco-alarm:AlarmMonitoringStationAugmentation> </apco-alarm:AlarmMonitoringStation> <apco-alarm:AlarmServiceLocation> <nc:LocationAddress> <nc:AddressFullText>116 E LEIGH ST RICH</nc:AddressFullText> </nc:LocationAddress> <nc:LocationMapLocation> <nc:MapHorizontalCoordinateText>37.547630888888889</nc:MapHorizontalCoordinateText> <nc:MapVerticalCoordinateText>-77.437561166666669</nc:MapVerticalCoordinateText> </nc:LocationMapLocation> <nc:LocationTwoDimensionalGeographicCoordinate> <nc:GeographicDatumCode>NAD83</nc:GeographicDatumCode> <nc:GeographicCoordinateLatitude> <nc:LatitudeDegreeValue>37</nc:LatitudeDegreeValue> <nc:LatitudeMinuteValue>32</nc:LatitudeMinuteValue> <nc:LatitudeSecondValue>51.4712</nc:LatitudeSecondValue> </nc:GeographicCoordinateLatitude> <nc:GeographicCoordinateLongitude> <nc:LongitudeDegreeValue>-77</nc:LongitudeDegreeValue> <nc:LongitudeMinuteValue>26</nc:LongitudeMinuteValue> <nc:LongitudeSecondValue>15.2202</nc:LongitudeSecondValue> </nc:GeographicCoordinateLongitude> </nc:LocationTwoDimensionalGeographicCoordinate> </apco-alarm:AlarmServiceLocation> </apco-alarm:AlarmPayload> </apco-alarm:ExternalAlarm> ]]></n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>