HLR OVER HTTP

Forord
Syntax for opslag
Eksempel på svar
Fejlkoder

Forord

Dette dokument beskriver metoder og brugen af HLR Opslag gennem HTTP POST/GET.

Vores service er baseret på et script, der lytter efter de forskellige request parametre, der definere det opslag der skal foretages.
Parametre navnene er ligefrem, f.eks. hedder nummer parametret "number", og brugernavn parametret "username".

Efter et opslag vil system tilbage levere et XML dokument, der beskriver statusen på opslaget, og såfremt det er succesfuldt, de nødvendige informationer.

Syntax for opslag

HLR Opslag er baseret på både GET og POST URL forespørgsler.

Forespørgslen skal sendes til følgende adresse:

http://hlr.coolsmsc.dk/

De tilsendte variabler, analyseres som enten GET eller POST parametre.
Alle parametre skal URL Encodes, i henhold til RFC 1738, med undtagelse af at + betragtes som et mellemrum([SPACE]).

En forespørgsel vil se således ud:

http://hlr.coolsmsc.dk/?username=xxxx&password=xxxx&number=4512345678

Dette vil lave et opslag på nummeret +4512345678.

Parametre

username	Påkrævet	Brugernavnet for den konto, der laver opslaget.
password	Påkrævet	Kodeordet til den konto, der laver opslaget.
number	Påkrævet	Det nummer man ønsker at hente netværksinformation omrking.
lang		Sproget du ønsker at resultatet skal beskrives i, værdierner kan være som følger: da for Dansk. en for Engelsk. Hvis udeladt er sproget dansk.

Eksempel på svar

Når du laver et opslag vil der være en HTTP Header med navnet X-Status der enten vil være "success" eller "failure", afhængig af resultatet af forespørgslen.
Det anbefales at kontrollere resultatet af din forespørgsel med denne header.

Udover HTTP Headeren, vil der blve returneret et XML Dokument med yderligere information.

For XML Dokumentet findes der en DTD på http://hlr.coolsmsc.dk/dtd/hlr.dtd

Et eksempel på forsøg med forkert brugernavn og adgangskode, vil returnere følgende:

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE hlr SYSTEM "http://hlr.coolsmsc.dk/dtd/hlr.dtd">
<hlr version="1.0">
<status>failure</status>
   <error>
      <description>Adgang nægtet</description>
   </error>
</hlr>

Et eksempel på et korrekt oplslag med en telefon på TDCs netværk:

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE hlr SYSTEM "http://hlr.coolsmsc.dk/dtd/hlr.dtd">
<hlr version="1.0">
<status>success</status>
  <lookup>
      <number>4542701272</number>
      <mcc>238</mcc>
      <mnc>01</mnc>
      <country>Denmark</country>
      <network>TDC Denmark</network>
      <imsi>238013420181448</imsi>
      <location>4540150048</location>
   </lookup>
</hlr>

Fejlkoder