NIEM Examples - Help File (AM)
HELP File NIEM Specifications
This section provides NIEM formats and NIEM examples for HELP files that deal with state or other member HELP records. HELP messages are sent in the same format as Administrative Messages. The destination ORI identifies these messages are Help messages, as opposed to standard Administrative Messages. The destination ORI for help file messages will be formulated in this manner:
First two characters: 2 character code of state help file that you are interacting with (your own state for APND, UPDT, CNCL, or the state in question for queries).
Characters 3-5: Code indicating the specific help file you are dealing with.
BAS - Boat and Snowmobile
COR - Corrections Information
GUN - Gun File Information
LIC - Vehicle License
NOQ - Name Only Query Information
OLN - Operator's License
ORI - Nlets "S" ORI Information
PAR - Parole Information
PPC - Parole, Probation and Correction Information
PRO - Probation Information
SIR - Criminal History
SOR - Sex Offender Registry
SWQ - State Warrant Information
WTH - Weather Information
The last 4 characters will indicate the type of transaction you are performing and are detailed below.
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: Help File Update (AM), Help File Append (AM), Help File Cancel (AM) & Help File Query (AM).
Query Formats
Help File Update (AM)
Note: When the update function is used, the last four characters of the destination ORI will be "UPDT".
Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.
Mail Text (n2:MailMessageText)
This contents of this element will replace any record currently on file. Nlets recommends the use of <![CDATA[]]> tags to ensure
that the response does not contain any characters illegal in XML.
Help File Append (AM)
Note: When the update function is used, the last four characters of the destination ORI will be "APND".
Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.
Mail Text (n2:MailMessageText)
This contents of this element will be added to the record currently on file. Nlets recommends the use of <![CDATA[]]> tags to ensure
that the response does not contain any characters illegal in XML.
Help File Cancel (AM)
Note: When the cancel function is used, the last four characters of the destination ORI will be "CNCL".
This message clears the file. Any state inquiring to the file after the cancel is issued will receive
a message stating "NO HELP INFO AVAILABLE."
Help File Query (AM)
Note: To request data from a help file, the last 4 characters of the destination ORI will be "HELP".
HELP NIEM Examples
Example 1: Update message to create a new HELP.
<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>AZNLETS49</nh2:OriginatingORIID>
<nh2:DestinationORIID>NLNLEUPDT</nh2:DestinationORIID>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
NEW HELP MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
The NLNLEHELP file now will return a response of:
<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>NLNLEHELP</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
<nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>09:50</nh2:MessageReceiveTime>
<nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>09:50</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00792</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
NEW HELP MESSAGE</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
Example 2: Appending a message to the NLNLEHELP HELP file.
<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>AZNLETS47</nh2:OriginatingORIID>
<nh2:DestinationORIID>NLNLEAPND</nh2:DestinationORIID>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
NEW UPDATE *APND*</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
The NLNLEHELP file now will return a response of:
<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>NLNLEHELP</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
<nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>09:53</nh2:MessageReceiveTime>
<nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>09:53</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00796</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
NEW UPDATE *APND*</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
</n2:NLETS>
Example 3: Cancelling a the NLNLEHELP HELP file.
<?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>AM</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
<nh2:DestinationORIID>NLNLECNCL</nh2:DestinationORIID>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>
The NLNLEHELP file now will return a response of:
<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>NLNLEHELP</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
<nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>09:57</nh2:MessageReceiveTime>
<nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>09:57</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00805</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="AM">
<n2:MailMessageText>(AZNLETS47)
NO NLE HELP INFORMATION AVAILABLE FOR THIS USER</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>