*Skatteverket
Navet Bilaga 8
Teknisk handledning E-persondata Demo
Version 1.34
Navet Bilaga 8 Teknisk handledning E-persondata Demo
Version: 1.34
2015-02-27
Innehållsförteckning
1.
DOKUMENTINFORMATION ...................................................................................... 3
1.1
1.2
1.3
2.
SYFTE ......................................................................................................................... 3
MÅLGRUPP.................................................................................................................. 3
REFERENSER ............................................................................................................... 3
BESKRIVNING AV SÖKTJÄNSTERNA .................................................................... 4
2.1
INDATA OCH SÖKVILLKOR ........................................................................................... 4
2.1.1 Utformning av indata till Web Service Personpost................................................ 4
2.1.2 Utformning av indata till Web Service Namnsökning............................................ 5
2.2
TESTDATA OCH UTDATA ............................................................................................. 5
2.3
FELMEDDELANDEN ..................................................................................................... 6
2.3.1 Meddelandekoder Web Service Personpost ........................................................... 6
2.3.2 Meddelandekoder Web Service Namnsökning ....................................................... 6
2.3.3 Felsituationer ......................................................................................................... 7
2.4
CERTIFIKAT ................................................................................................................ 7
2.5
WSDL-FILER .............................................................................................................. 7
2.6
UPPKOPPLING ............................................................................................................. 7
2.7
TILLGÄNGLIGHET........................................................................................................ 8
Navet
Skatteverket
Sida 2 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
Version: 1.34
2015-02-27
1.
Dokumentinformation
1.1
Syfte
Dokumentet är en användarhandledning för användare av Navets demoversion för
onlinetjänsten ePersondata som innehåller Web Service Personpost och
Web Service Namnsökning.
1.2
Målgrupp
Målgruppen för dokumentet är kommunikations- och applikationsansvariga hos de
kunder till Skatteverket som skall använda Web Services för att ställa frågor mot
Navet.
1.3
Referenser
Ref. Dokumenttitel
Navet
Utgivare
Adress
[1]
Allmän beskrivning
Navet,
http://www.skatteverket.se/foretagorganisati
Skattever oner/formyndigheterkommuner/navet.4.18e1
ket
b10334ebe8bc80001754.html Välj sedan
länken ’Allmän beskrivning’.
[2]
Teknisk beskrivning
Navet,
http://www.skatteverket.se/foretagorganisati
Skattever oner/formyndigheterkommuner/navet/teknis
ket
kbeskrivning.4.4bf45f331098492fe0e80008
13.html Välj sedan länken ’Teknisk
beskrivning’.
[3]
Bilaga 6, Teknisk
handledning Web
Service
Navet,
http://www.skatteverket.se/foretagorganisati
Skattever oner/formyndigheterkommuner/navet/teknis
ket
kbeskrivning.4.4bf45f331098492fe0e80008
13.html Välj sedan länken bilaga 6, Teknisk
handledning Web Service
[4]
Bilaga 9, Testdata för Navet,
http://www.skatteverket.se/foretagorganisati
E-persondata Demo Skattever oner/formyndigheterkommuner/navet/teknis
ket
kbeskrivning.4.4bf45f331098492fe0e80008
13.html Välj sedan länken bilaga 9, Testdata
för demoversion Web Service
Skatteverket
Sida 3 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
2.
Version: 1.34
2015-02-27
Beskrivning av söktjänsterna
Med denna onlinetjänst kan man testa sin egen Web Service klient under
utvecklingstiden för att se hur den fungerar mot Navets gränssnitt. Denna tjänst
erbjuder ett begränsat antal testpersoner samt begränsade sökvillkor vid namnsökning.
Den kan användas med ett testcertifikat som erhålls från Skatteverket.
För ytterligare information angående Navets tjänster, se Navets Allmänna beskrivning
ref [1], Tekniska beskrivning ref [2] och Teknisk handledning Web Service ref [3] .
2.1
Indata och sökvillkor
2.1.1 Utformning av indata till Web Service Personpost
De korrekta inparametrarna som ska anges till Web Service Personpost
beskrivs i ref [3], kapitel 5.1.3. I denna demoapplikation anges:
Inparameter
Beskrivning
bestallningsid
Organisationsnumret måste matcha certifikatets organisationsnummer.
Testcertifikatets organisationsnummer är 162021004748. I denna demoapplikation
görs ingen kontroll av att den sista delen i beställningsidentiteten är ett giltigt
beställningsnummer.
Exempel på beställningsidentitet som kan användas vid test med testcertifikat:
162021004748 00000079-FO01-0001
personid
Giltig personidentitet anges enligt formatet ÅÅÅÅMMDDNNNK. Med personidentitet
avses både Personnummer och Tilldelat personnummer/Samordningsnummer.
Exempel på personidentitet:
194110288083
Det finns endast ett fåtal personer att söka på, se ref [4].
För exempel på hur ett SOAP-meddelande utformas för Web Service Personpost se
ref [3], kapitel 5.1.3.
Navet
Skatteverket
Sida 4 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
Version: 1.34
2015-02-27
2.1.2 Utformning av indata till Web Service Namnsökning
De korrekta inparametrarna som ska anges till Web Service Namnsökning
beskrivs i ref [3], kapitel 5.2.3. I denna demoapplikation anges:
Inparameter
Beskrivning
bestallningsid
Organisationsnumret måste matcha certifikatets organisationsnummer.
Testcertifikatets organisationsnummer är 162021004748. I denna demoapplikation
görs ingen kontroll av att den sista delen i beställningsidentiteten är ett giltigt
beställningsnummer.
Exempel på beställningsidentitet som kan användas vid test med testcertifikat:
162021004748 00000079-FO01-0001
Sökvillkor
Det går att söka på ett fåtal förnamn och ett fåtal postnummer from
var för sig, dvs. det går inte att kombinera de båda sökvillkoren.
- Förnamn
Sökning kan göras på förnamn, se termkod 01012 i ref [4]. * kan
användas som fritt tecken i början av ett namn för att söka på del av
förnamn. Det görs ingen skillnad på versaler och gemener.
- Postnr from
Sökning kan göras på postnummer from för folkbokföringsadress,
termkod 01034 i ref [4]. Postnummer kan anges enligt följande:
Postnr from Beskrivning
1
Samtliga postnummer som börjar på 1.
11
Samtliga postnummer som börjar på 11.
114
Samtliga postnummer som börjar på 114.
1143
Samtliga postnummer som börjar på 1143.
11435
Samtliga postnummer som börjar på 11435.
För exempel på hur ett SOAP-meddelande utformas för Web Service Namnsökning se
ref [3], kapitel 5.2.3.1.
2.2
Testdata och utdata
Personer som går att söka på är de som finns beskrivna i dokumentet innehållande
testdata ref [4]. Det resultat som returneras ska matcha dessa personer. Olika typer av
testdata förekommer på personerna så att alla uppgifter är möjliga att erhålla på någon
person.
Utdata ingår i ett SOAP-meddelande i format termkod/termdata eller i XML-format.
För information om hur detta meddelande är utformat se ref [3], kapitel 5.1.4 samt
5.2.4.
Navet
Skatteverket
Sida 5 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
2.3
Version: 1.34
2015-02-27
Felmeddelanden
2.3.1 Meddelandekoder Web Service Personpost
Web Service Personpost returnerar en personpost när efterfrågad person hittas.
Om till exempel inparametrarna är felaktiga, sökt post inte finns eller vid tekniskt fel
returneras i stället ett specifikt SOAP-meddelande. De olika typerna av fel har olika
meddelandekoder.
Följande meddelandekoder kan erhållas från Personpost i denna demoapplikation
(1, 4, -11). De olika meddelandekoderna finns beskrivna i ref [3], kapitel 5.1.5.
Tabellen nedan visar hur ett specifikt fel kan framkallas.
Meddelandekod/ Meddelandetext/
faultcode
faultstring
Framkallas genom att
1
Ingen person finns med
angivet personnummer.
Söka på ett personnummer som inte finns i
testdatat.
4
Felaktiga inparametrar:
Beställningsid har ett
ogiltigt värde.
Ange ett organisationsnummer som inte är 12
tecken dvs TTTTTTTTTTTT eller ange en
beställningsidentitet med felaktigt format.
Det giltiga formatet är NNNNNNNN-TTNNNNNN
4
Felaktiga inparametrar:
Ogiltigt värde på
personidentiteten. Skall
vara 12-siffrigt på
formen 'ÅÅÅÅMMDDNNNK'.
Ange ett felaktigt format för personidentitet,
som inte har formen 'ÅÅÅÅMMDDNNNK’.
-11
Behörighetsfel: Orgnr i
Beställningsid matchar
inte med orgnr på
Certifikatet.
Ange ett organisationsnummer i inparametern
som inte matchar organisationsnummer på
certifikatet.
2.3.2 Meddelandekoder Web Service Namnsökning
Web Service Namnsökning returnerar namnposter när personer hittas enligt
angivna sökvillkor. Om till exempel inparametrarna är felaktiga, inga personer hittas
eller vid tekniskt fel returneras i stället ett specifikt SOAP-meddelande. De olika
typerna av fel har olika meddelandekoder.
Följande meddelandekoder kan erhållas från Namnsökning i denna
demoapplikation (1, 4, -11). De olika meddelandekoderna finns beskrivna i ref [3],
kapitel 5.2.5.
Navet
Skatteverket
Sida 6 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
Version: 1.34
2015-02-27
Tabellen nedan visar hur ett specifikt fel kan framkallas.
Meddelandekod/ Meddelandetext/
faultcode
faultstring
Framkallas genom att
1
Inga personer uppfyllde
sökvillkoren
Söka på personuppgifter som inte finns i
testdatat.
4
Felaktiga inparametrar:
Beställningsid har ett
ogiltigt värde.
Ange ett organisationsnummer som inte är 12
tecken dvs TTTTTTTTTTTT eller ange en
beställningsidentitet med felaktigt format.
Det giltiga formatet är NNNNNNNN-TTNNNNNN
4
Felaktiga inparametrar:
Termens längd är
felaktig.
Ange ett förnamn som är längre än 80 tecken.
Felaktiga inparametrar:
Talet är felaktigt.
Ange ett postnummer som har ett felaktigt
format.
Behörighetsfel: Orgnr i
Beställningsid matchar
inte med orgnr på
Certifikatet.
Ange ett organisationsnummer i inparametern
som inte matchar organisationsnummer på
certifikatet.
-11
2.3.3 Felsituationer
Förutom de meddelandekoder som returneras via ett SOAP-fault kan också andra
felsituationer uppstå. Felet kan bero på fel hos Skatteverket eller hos klienten.
Exempel på felsituationer beskrivs i ref [3], kapitel 6.
2.4
Certifikat
Denna tjänst ska användas med ett testcertifikat, vilket finns för nedladdning hos
http://eid.steria.se. Det testcertifikat server/funktion som ska användas är ett
testcertifikat för SHS, Företag: Kommun A, Org.Nr: 162021004748, CN:
Notarealhost.kommun-a.se. (Finns för närvarande under Information för
systemleverantörer > Testcertifikat > Testcertifikat för server/funktion- och
stämpellegitimationer)
Mer information om certifikat finns i ref [3], kapitel 3.
2.5
WSDL-filer
Gränsnittet till Web Service Personpost och Web Service Namnsökning beskrivs via
dess WSDL-filer. Se Bilaga 1-4 som finns i ref [3]. Det som skiljer dessa WSDL-filer
från de som ska användas för denna applikation är att
”https://www2.skatteverket.se/na/na_epersondata” ska ersättas med
”https://ppx4.skatteverket.se/naa10/na_epersondata_demo”.
2.6
Uppkoppling
För anslutning mot Web Service Personpost i format termkod/termdata anges följande
adress:
https://ppx4.skatteverket.se/naa10/na_epersondata_demo/services/personpost
Navet
Skatteverket
Sida 7 av 8
Navet Bilaga 8 Teknisk handledning E-persondata Demo
Version: 1.34
2015-02-27
För anslutning mot Web Service Personpost i XML-format anges följande adress:
https://ppx4.skatteverket.se/naa10/na_epersondata_demo/services/personpostXML
För anslutning mot Web Service Namnsökning i format termkod/termdata anges
följande adress:
https://ppx4.skatteverket.se/naa10/na_epersondata_demo/services/namnsokning
För anslutning mot Web Service Namnsökning i XML-format anges följande adress:
https://ppx4.skatteverket.se/naa10/na_epersondata_demo/services/namnsokningXML
2.7
Navet
Tillgänglighet
Tjänsten kommer i stort sett att vara tillgänglig dygnet runt. Enstaka störningar kan
dock förekomma. Ingen information om eventuella störningar publiceras på webben.
Skatteverket
Sida 8 av 8