﻿<?xml version="1.0" encoding="UTF-8" ?>
<?xml-stylesheet type="text/xsl" href="../notes.xsl"?>
<Documentation>
  <Title code="0921">Number Lookup</Title>
  <Overview>
    <p>Schema used to perform a WMRS request. This method depends on the user supplying a US mobile number.</p>
  </Overview>
  <Request schema="0921_RequestNumberLookup.xsd">
    <p>
      The 'UserID' and 'Password' elements identify the account.
      The 'ServiceName' element must be set to 'NumberLookup'.
      The 'SoftwareVersion' element is for internal 2SMS use only and should not be set.
      The 'Number' element must be set as this is the number that will queried for it's service provider. This can be repeat for each number to be queried.
    </p>
  </Request>
  <Response schema="0921_ResponseNumberLookup.xsd">
    <p>
      This method returns a successful '00/OK' response if the request has passed the following conditions:
      <ol>
        <li>The XML Gateway has successfully made a call to the number lookup service.</li>
      </ol>
    </p>
    <p>
      The 'Detail' element contains the details for each number queried:
    </p>
    <ul>
      <li>
        Country: 
          <ul>
            <li>Code: The ISO code for the country.</li>
            <li>ISOCode: The ISO A3 code for the country.</li>
            <li>LocaleName: The local name of the country.</li>
            <li>Name: The name of the country</li>
          </ul>
      </li>
      <li>IMSI: International mobile subscriber identity </li>
      <li>MCC: The mobile country code </li>
      <li>Number: The number that was queried. </li>
      <li>
          Network: 
            <ul>
              <li>MNC: The mobile network code the number was originally registered with.</li>
              <li>Name: The name of the network the number was originally registered with </li>
            </ul>
      </li>
      <li>Ported: Determines if the number has been ported.</li>
      <li>
        PortedNetwork:
        <ul>
          <li>MNC: The mobile network code of the network the number has been ported to.</li>
          <li>Name: The name of the network of the network the number has been ported to.</li>
        </ul>
      </li>
      <li>
        RoamingNetwork:
        <ul>
          <li>Country: The name of the country the number is currently connected to.</li>
          <li>ISOCode: The ISOCode of the country the number is currently connected to.</li>
          <li>MNC: The mobile network code the number is currently connected to.</li>
          <li>MNC: The mobile network code of the network the number is currently connected to.</li>
          <li>Name: The name of the network of the network the number is currently connected to.</li>
          <li>State: The state of the number on the roaming network.</li>
        </ul>
      </li>
      <li>
        StateInfo:
        <ul>
          <li>Description: The state description.</li>
          <li>Status: The status of the HLR lookup</li>
          <li>UpdatedAt: The timestamp of when the HLR was last updated</li>
        </ul>
      </li>
    </ul>
  </Response>
</Documentation>