Dokumentation
För närvarande erbjuder vi bara en liten försmak av vad vi har tillgängligt: Privatpersonsuppslag och nummer-till-namn-uppslag.
Privatpersonsuppslag
Anrop
Anrop sker genom att göra en HTTP-GET på följande format:
http://developer.118100.se:8080/openapi-1.1/appetizing?query=Anders+Andersson+Anderstorp&pageSize=10&key=XXXXXXXXXXXXXX.XXXXXXXX
query-variabeln kan innehålla alla tänkbara söktermer: Förnamn, efternamn, ort, gata, gatunummer, telefonnummer, postnummer etc. Ordningen på söktermerna spelar ingen roll försåvitt en term inte är komposit, exempelvis "Olof Palmes Gata" där ordningen på de komposita termerna spelar roll.
pageSize-variabeln är frivillig och kan innehålla ett nummer mellan 1 och 50 och reglerar antalet svar som returneras för frågan. Nummer utanför intervallet 1-50 går att skicka, men ignoreras. Om pageSize inte anges är skönsvärdet satt till 10.
key-variabeln måste innehålla en giltig licensnyckel. Licensnycklar erhålls kostnadsfritt på denna site ("Registrering").
Svar
Svaret kommer på ett XML-format som är fullständigt definierat i denna XSD-fil. Värt att notera är att privatpersonsuppslag inte kommer att returnera några företagsuppgifter; den delen av XSD:n används endast av nummer-till-namn-uppslag (se nedan)
Exempel
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse>
<query>
<queryString>conny svensson</queryString>
<offset>0</offset>
<pageSize>3</pageSize>
</query>
<response>
<personHits hitCount="161987">
<person sequenceNumber="0">
<individual>
<name type="first">Conny</name>
<name type="last">Svensson</name>
</individual>
<address type="street">
<street>
<name>John Ericssons Vg</name>
<number>77</number>
<suffix>B</suffix>
</street>
<zip>21747</zip>
<city>MALM</city>
<country>SE</country>
</address>
<phoneNumber type="mobile">
<internationalPrefix>46</internationalPrefix>
<areaCode>73</areaCode>
<localNumber>4134075</localNumber>
</phoneNumber>
</person>
<person sequenceNumber="1">
<individual>
<name type="first">Conny</name>
<name type="last">Svensson</name>
</individual>
<address type="street">
<street>
<name>Ryd Bjrkhagen</name>
</street>
<zip>53010</zip>
<city>VEDUM</city>
<country>SE</country>
</address>
<phoneNumber type="landLine">
<internationalPrefix>46</internationalPrefix>
<areaCode>512</areaCode>
<localNumber>72111</localNumber>
</phoneNumber>
</person>
<person sequenceNumber="2">
<individual>
<name type="first">Conny</name>
<name type="last">Svensson</name>
</individual>
<individual>
<name type="first">Kerstin</name>
<name type="last">Ek</name>
</individual>
<address type="street">
<street>
<name>Ryd Bjrkhagen</name>
</street>
<zip>53010</zip>
<city>VEDUM</city>
<country>SE</country>
</address>
<phoneNumber type="landLine">
<internationalPrefix>46</internationalPrefix>
<areaCode>512</areaCode>
<localNumber>72012</localNumber>
</phoneNumber>
</person>
</personHits>
</response>
</queryResponse>
Nummer-till-namn
Anrop
Anrop sker genom att göra en HTTP-GET på följande format:
http://developer.118100.se:8080/openapi-1.1/appetizing?query=081231231&key=XXXXXXXXXXXXXX.XXXXXXXX
query-argumentet får innehålla viket nummer som helst, men för att få bra träffar är det lämpligt att skicka med riktnummer. Internationellt prefix (+46 eller 0046) går bra, men kom ihåg att strippa första nollan i riktnumret om du kör internationellt.
key-argumentet måste innehålla en giltig licensnyckel. Licensnycklar erhålls kostnadsfritt på denna site ("Registrering").
Svar
Svaret på nummer-till-namn-frågor är på samma format som privatpersonsuppslag, med den skillnaden att man här kan få träff på företagsuppgifter också, vilket innebär att man använder en större del av formatet.
Exempel
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse>
<query>
<queryString>0856261200</queryString>
<offset>0</offset>
<pageSize>1</pageSize>
</query>
<response>
<companyHits hitCount="1">
<company sequenceNumber="0">
<organizationNumber>165565740759</organizationNumber>
<name type="legal">Itesco AB</name>
<address type="street">
<street>
<name>Solna Torg</name>
<number>19</number>
</street>
<zip>17145</zip>
<city>SOLNA</city>
<country>SE</country>
</address>
<address type="postal">
<street/>
<country>SE</country>
</address>
<phoneNumber type="pbx">
<internationalPrefix>46</internationalPrefix>
<areaCode>8</areaCode>
<localNumber>56261200</localNumber>
</phoneNumber>
<phoneNumber type="fax">
<internationalPrefix>46</internationalPrefix>
<areaCode>8</areaCode>
<localNumber>56261201</localNumber>
</phoneNumber>
<teleAddress type="web">http://www.itesco.com</teleAddress>
<teleAddress type="email">info@itesco.com</teleAddress>
</company>
</companyHits>
</response>
</queryResponse>
