Section 08: Error Messages

Error Messages (ER)

This section of the Nlets User Guide presents pertinent information about error messages. If Nlets detects any condition that prevents delivery of an input message to the destination, an error message will be sent to the originating station explaining the condition.

Note: The Nlets system (ORI NL0000000) is the only originator of ER messages. Neither state computer systems nor terminals may generate ER messages.

Nlets Error Message Specifications

Each Error Message Will Contain:
Standard output header
A numeric and plain English error notification.
The first 100 characters of the input message.
The sending ORI will always be NL0000000. (ORI assigned to the Nlets message-switch [NJIN])

Nlets Error Messages, Numbers and Explanations

Below is a list of all error messages generated by Nlets with the associated error numbers for each error message.

Error #:	Nlets Error Message:	Explanation:
0	MESSAGE FORMAT/STRUCTURE ERROR THE RECEIVED MESSAGE IS INCORRECTLY FORMATTED	The received message was not formatted correctly.
.01.	INVALID HEADER INFORMATION	This error message indicates that there is an error in the message header. Specific information about the error is returned in the message itself.
.02.	MESSAGE TYPE NOT ALLOWED TO DESTINATION	Indicates that a state does not accept the message type being sent. Specific information about the error is returned in the message itself.
.03.	TXT NOT FOUND OR IMPROPERLY FORMED XML	The Nlets System encountered a problem parsing the XML or the TXT could not be found in the message. Specific information about the error is returned in the message itself.
.04.	MEXICAN CDL ERROR	Missing or invalid field to destination. Specific information about the error is returned in the message itself.
.05.	DOB INVALID or MISSING	Indicates that the DOB field could not be found, exceeded maximum length or had a non-numeric character within the date of birth.
.06.	INVALID MESSAGE FORMAT FOR CN	Missing or invalid field to destination. Specific information about the error is returned in the message itself.
.10.	A YEAR FIELD IS INVALID or MISSING	A year field such as VYR, BEG, END and LIY is invalid or missing. Specific information about the error is returned in the message itself.
.14.	FIELDS MISSING	Indicates that a required field could not be found. Specific information about the error is returned in the message itself.
.16.	ATN FIELD INVALID	Indicates that the attention field has invalid characters. Specific information about the error is returned in the message itself.
.19.	INVALID DESTINATION ORIs	Indicates that the message is being sent to an invalid destination. Specific information about the error is returned in the message itself.
.20.	INVALID CONTROL FIELD	Indicates that the control field is too long or has illegal characters. Specific information about the error is returned in the message itself.
.21.	INVALID SENDING ORI	Indicates that the source ORI is invalid or does not belong to the user. Specific information about the error is returned in the message itself.
.22.	INVALID MESSAGE FORMAT	Indicates that incorrect fields or missing fields found in message. Specific information about the error is returned in the message itself.
.23.	INVALID FIELD LENGTH	Indicates that a required field is too short or too long. Specific information about the error is returned in the message itself.
.24.	MESSAGE HAS AN INVALID FIELD	Indicates that there is an invalid field in the message. Specific information about the error is returned in the message itself.
.27.	MESSAGE HAS TOO MANY DESTINATIONS	Indicates that the user has included too many destinations.
.29.	MESSAGE NOT ALLOWED FROM SENDER	Indicates that the sender has tried to send a message type that they are not authorized to send.
.53.	DESTINATION DOES NOT ACCEPT MESSAGES FROM THIS TYPE OF ORI	Indicates that the destination does not accept messages from this ORI type (i.e. ORI ending in a "S" or "F").
.54.	TOO MANY DESTINAITONS FOR HIT CONFIRMATION	Indicates that too many destinations have placed in the header of the hit confirmation.
.75.	REQUIRED FIELD MISSING	Indicates that a required field is missing from the message type. Specific information about the error is returned in the message itself.

A snippet of an XML Error Message:

<n2:ResponseText><![CDATA[.01. MSG TYPE INVALID or INVALID TO DESTINATION]]></n2:ResponseText>

Top

GJXDM (DEPRECATED)

GJXDM has been deprecated. Please contact Nlets for additional assistance with GJXDM.

Top

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>

Top

Legacy (DEPRECATED)

This section provides the Legacy format for Nlets generated Error Messages (ER).

Note: The Nlets system (ORI NL0000000) is the only originator of ER messages. Neither state computer systems nor terminals may generate ER messages.

Nlets Error Message Specifications

Each Nlets error message will contain:
Standard output header.
A numeric and plain English error notification.
The first 100 characters of the input message.
The sending ORI will always be NL0000000. (This the ORI assigned to the Nlets message-switching computer.)

Message Formats

The detailed message format for error messages is presented below.

Entry	Field Size	Explanation
ER.	2	Message type followed by a period.
Message Header	69-76	Standard output message header, may include control field.
Error message	Varies	Message explaining the problem with a 2-digit error number at the beginning.
CR,LF,DEL	3	Control characters
Message text	100	The first 100 characters of the message to which this error message pertains.

Nlets Error Legacy Examples

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

ER.NL0000000 08:00 01/01/2010 01239 08:00 01/01/2011 01233 AZNLETS20 TXT .22. INVALID MESSAGE FORMAT - REFER TO RQ MKE OPTIONS BELOW   1. LIC, LIY, LIT   ORIGINAL MESSAGE RQ.AZNLETS20.AZ.TXT LIC/123456.LIT/PC

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

ER.NL0000000 08:00 01/01/2010 01231 08:00 01/01/2010 01235 AZNLETS20 TXT .22. INVALID MESSAGE FORMAT - REFER TO YQ MKE OPTIONS BELOW   1. RTY, RNO, PRI, OCA, NIC, TYP, SER, RNA, RAG   ORIGINAL MESSAGE   YQ.AZNLETS20.AZ0000000.TXT RTY/SS.PRI/R.OCA/10000000000.NIC/A111110000. SER/110011001100.DEN/123456789. RNA/NLETS_ANALYST.RAG/NLETS.PHO/8005284020. REM/PLS CONFIRM STILL STOLEN.

Top

Downloads

Download ER Schema

Download ER Stylesheet

Top /