NIEM Examples - Error Messages (ER)

NIEM

Error Message NIEM Specifications

This section provides NIEM format and examples for Error Messages (ER).

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.

Note: The Nlets system (ORI NL0000000) is the only originator of ER messages.

Neither state computer systems nor terminals may generate ER messages.

Element Dictionary

Transaction types detailed below include: Error Message (ER).

Message Formats

Error Message (ER)

Response Data (n2:NLETSResponseData)
This element will contain all elements specific to this transaction.

Error Text (n2:ResponseText)

This element will contain the free text error message. Nlets utilizes a

<n2:DocumentControlFieldText><![CDATA[123(567&90]]></n2:DocumentControlFieldText>

section to ensure that the response does not contain any characters illegal in XML.

Nlets Error NIEM Examples

Example 1: Error message sent on a Vehicle Registration query.

<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>ER</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[CROSSFIRE1]]></nh2:DocumentControlFieldText>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>10:16</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>10:16</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00841</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <tns4:NLETSResponseData tns4:key="ER" xmlns:tns4="http://www.nlets.org/niem/1.0">
    <tns4:ResponseText>
0 MESSAGE FORMAT/STRUCTURE ERROR
THE RECEIVED MESSAGE IS INCORRECTLY FORMATTED

TRANSACTION DATA
-----------------
Current Date-Time:      2019-10-22T10:16:40.035-07:00
Transaction Identifier: 2001192940410144431000


ERROR DETAIL
-------------
INVALID MESSAGE: Received input message with an incorrect format

TXT Not Found


 
ORIGINAL MESSAGE
----------------
RQ.AZNLETS47.AZ.*CROSSFIRE1.
</tns4:ResponseText>
  </tns4:NLETSResponseData>
</n2:NLETS>

Example 2: Error message sent on a Hit Confirmation query.

<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>ER</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>10:21</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>10:21</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00854</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <tns4:NLETSResponseData tns4:key="ER" xmlns:tns4="http://www.nlets.org/niem/1.0">
    <tns4:ResponseText>0 SYSTEM ERROR
RQMG UNAVAILABLE
TRANSACTION DATA
----------------
nCurrent Date-Time:      2019-10-22T10:21:28.807-07:00
Transaction Identifier: 2001192940410661720682
System | Service:       RQMG
</tns4:ResponseText>
  </tns4:NLETSResponseData>
</n2:NLETS>