NIEM Examples - Status Messages (SM)

Status Message NIEM Specifications

All messages are in plain English and use the same structure and header format as Administrative messages (AM).

If a state or other user is going to be out of service and chooses to notify all users on Nlets, an "SM" type message should be used. This message key has been granted the highest priority within the Nlets system.

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 type detailed below: Status Message (SM).

Message Formats

Status Message (SM)

n2:NLETSMailData
This element will contain all elements specific to this transaction.

n2:StatusMessageText
This element will contain the free text status message.
Nlets recommends the use of <![CDATA[]]> tags to ensure that the response does not contain any characters illegal in XML.

Status Message NIEM Example

Example 1: Status Message from a state.

<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>SM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>TXDPS0000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[LTN2000157]]></nh2:DocumentControlFieldText>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>10:35</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>10:35</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00885</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="SM">
    <n2:StatusMessageText>TX requires 8 character OLN
       Original Message:
       MKE/DQ.
       ORI/OK0000000.
       DST/TX.
       CTL/MRIA000000.
       OLN/D082000000
    </n2:StatusMessageText>
  </n2:NLETSMailData>
</n2:NLETS>

Example 2: Status Message sent from Nlets.

<?xml version="1.0" encoding="utf-16"?>
<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>SM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NLSRVCMSG</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>10:37</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>10:37</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00894</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="SM">
    <n2:StatusMessageText>Puerto Rico no longer responds to RQ and DQ Department of Motor Vehicle Queries
         ORIGINAL MESSAGE
         DQ.AZNLETS19.PR.TXTOLN/123456789
    </n2:StatusMessageText>
  </n2:NLETSMailData>
</n2:NLETS>