NIEM Examples - LoJack Transactions (LE/LR)

LoJack NIEM Specifications

This section includes format specifications and an example of a NIEM LoJack Query and Response (LE/LR).

There are no edits or requirements on a LoJack transaction, other than standard Nlets XML formatting.

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: LoJack Message Query (LE) & LoJack Message Response (LR).

Query Formats

LoJack Message Query (LE)

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

Query Text (n2:InquiryDescriptionText)
This element will contain the free text message. Nlets recommends the use of

<!&#91;CDATA&#91;&#93;&#93;>

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

Response Formats

LoJack Message Response (LR)

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

Response Text (n2:ResponseText)
This element will contain the free text message response. Nlets recommends the use of

<!&#91;CDATA&#91;&#93;&#93;>

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

LoJack NIEM Examples

Example 1: Entry (EV) message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.EV.AZNLETS20.....111111XXX111.2000.INGS.CE.AI.BGE/ONG.20120101.
       200000000000X000...TAKEN IN BURGLARY /MODEL 185..</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 2: Response from LoJack on an Entry message.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>RR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>MAMSP0043</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/01/2012</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2012</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>
      <![CDATA[LOJACK.
       VEHICLE ENTERED IS FOR A KNOWN INSTALLED LOJACK UNIT
       QUERY IS BEING SENT TO NCIC TO DETERMINE VEHICLE STATUS FOR
       VIN:200000000000X000]]>
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 3: Modify (MV) message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.MV.AZNLETS20.NIC/X111111111.OCA/12-000000.
       MIS/NINJA 250 WITH A BLACK GAS TANK</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 4: Modify response from LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>RR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>MAMSP0043</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/01/2012</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2012</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>
      <![CDATA[LOJACK.
       VEHICLE MODIFIED IS FOR A KNOWN INSTALLED LOJACK UNIT
         QUERY IS BEING SENT TO NCIC TO DETERMINE VEHICLE STATUS FOR
         VIN:AA1AA1AA111111111]]>
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 5: Confirmation of stolen vehicle response from LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>RR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>MAMSP0043</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/01/2012</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2012</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>
      <![CDATA[LOJACK.
       MODIFIED LOJACK UNIT IS BEING ACTIVATED
         NCIC INDICATES THAT VEHICLE IS STOLEN
         VIN = AA1AA1AA111111111
         NIC = X111111111
 
 
         MKE/STOLEN VEHICLE - HOLD FOR LATENTS
         ORI/AZNLETS20
         VIN/AA1AA1AA111111111 VYR/2010
         VMA/SUZI VMO/CYL VST/MC VCO/BLK/YEL DOT/20120101
         OCA/AA11-11-11111
         VLD/20120101
         MIS/H0LD F0R FINGERPRINT PR0CESSING IN MARICOPA C0UNTY
         MIS/0NLY, VM0/XXXX111, 1X111, JOHN SMITH, RPTR JOHN SMITH, 602-555-1234,
         MIS/602-555-1234
         NIC/X111111111 DTE/20120101 1000 EDT DLU/20120101 1000 EDT
         ORI IS PHOENIX PD 602 555-1234
         IMMED CONFIRM RECORD WITH ORI]]>
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 6: Locate (LV) message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.
         LV.AZNLETS20.LIC/XX11111.OCA/111111111.20120101.0900000</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 7: Cancel (XV) message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.XV.AZNLETS20.NIC/X111111111.
      OCA/11-11111.20120101</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 8: Clear (CV) message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.CV.AZNLETS20.NIC/X111111111.
       OCA/X11-11111.20120101.AZ0000000</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 9: A De-activate response sent from LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>RR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>MAMSP0043</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/01/2012</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2012</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>
      <![CDATA[LOJACK.
         LOJACK UNIT IS BEING DE-ACTIVATED
         NCIC INDICATES THAT VEHICLE IS NOT STOLEN
         VIN = 1XXXX11X11X111111
 
 
         NO RECORD VIN/1XXXX11X11X111111]]>
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 10: QUERY message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.REPLY.XXX11</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 11: A Reply response from LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>RR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>MAMSP0043</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/01/2012</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2012</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>
      <![CDATA[LOJACK.
         LOJACK REPLY CODE = XXX11
         LOJACK REPLY CODE IS FOR A KNOWN UNIT
         QUERY BEING SENT TO NCIC TO DETERMINE VEHICLE STATUS FOR
         VIN:XXXXX11X111111111]]>
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 12: CHECK message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.CHECK.XXX11</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 13: QUIET message sent to LoJack.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>LE</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>LJ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LE">
    <n2:InquiryDescriptionText>LOJACK.QUIET.XXX11</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>