NIEM Examples - Administrative Messages (AM/AML)
NIEM
Administrative Message NIEM Specifications
This section describes NIEM format specifications and provides NIEM examples of Administrative Message (AM) and Administrative Message Law Enforcement Only (AML) transactions for state, regional and all points broadcasts.
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: Administrative Message (AM) & Administrative Message for Law Enforcement Only (AML).
Message Format
Administrative Message (AM)
Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.
Mail Text (n2:MailMessageText)
This element will contain the free text administrative message. Nlets recommends the use of <![CDATA[]]> tags to ensure
that the response does not contain any characters illegal in XML.
nc:Image
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
nc:PersonDigitalImage
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
Administrative Message for Law Enforcement Only (AML)
Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.
Mail Text (n2:MailMessageText)
This element will contain the free text administrative message. Nlets recommends the use of <![CDATA[]]> tags to ensure
that the response does not contain any characters illegal in XML.
nc:Image
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
nc:PersonDigitalImage
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
Example 1: An Administrative Message sent to Nlets with only one destination.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS19</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 2: An Administrative Message received by a user with only one destination.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS19</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>11/27/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>00:43</nh2:MessageReceiveTime>
<nh2:MessageSendDate>11/27/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>00:43</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00086</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 3: An Administrative Message sent to Nlets with Multiple destinations.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS10</nh2:DestinationORIID>
<nh2:DestinationORIID>AZNLETS11</nh2:DestinationORIID>
<nh2:DestinationORIID>AZNLETS12</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[NLETSTEST1]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 4: An Administrative Message received by a user with multiple destinations.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS12</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>11/27/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>00:49</nh2:MessageReceiveTime>
<nh2:MessageSendDate>11/27/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>00:49</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00090</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS10,AZNLETS11,AZNLETS12)
TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 5: An Administrative Message sent to Nlets using a state code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>IN</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR STATEWIDE BROADCAST
TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 6: An Administrative Message received with a state code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>IN</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>11/27/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>05:03</nh2:MessageReceiveTime>
<nh2:MessageSendDate>11/27/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>05:03</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00347</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR STATEWIDE BROADCAST
TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 7: An Administrative Message sent to Nlets using a region code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>A1</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR REGIONAL BROADCAST
TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 8: An Administrative Message received with a region code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>A1</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>11/27/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>05:06</nh2:MessageReceiveTime>
<nh2:MessageSendDate>11/27/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>05:06</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00348</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR REGIONAL BROADCAST
TEST MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 9: An Administrative Message sent to Nlets using the All Points Broadcast code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AP</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR NATIONAL BROADCAST
TEST AP MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 10: An Administrative Message received with an All Points Broadcast code.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AP</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>
<![CDATA[NLETSTEST1]]>
</nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>11/27/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>05:08</nh2:MessageReceiveTime>
<nh2:MessageSendDate>11/27/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>05:08</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00349</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>
* Powered by NLETS
REQUEST FOR NATIONAL BROADCAST
TEST AP MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>