Navet Bilaga 8

Navet Bilaga 8
Teknisk handledning E-persondata Demo V2
Version 2.0
*Skatteverket
2(7)
BILAGA 8
Navet
1
Datum
Version
2015-06-04
2.0
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
Utgivare
Adress
[1]
Allmän beskrivning
Navet,
http://www.skatteverket.se/foretagorganisation
Skatteverket er/formyndigheterkommuner/navet.4.18e1b10
334ebe8bc80001754.html Välj sedan länken
’Allmän beskrivning’.
[2]
Teknisk beskrivning
Navet,
http://www.skatteverket.se/foretagorganisation
Skatteverket er/formyndigheterkommuner/navet/tekniskbes
krivning.4.4bf45f331098492fe0e8000813.html
Välj sedan länken ’Teknisk beskrivning’.
[3]
Bilaga 6, Teknisk
handledning Web
Service V2
Navet,
http://www.skatteverket.se/foretagorganisation
Skatteverket er/formyndigheterkommuner/navet/tekniskbes
krivning.4.4bf45f331098492fe0e8000813.html
Välj sedan länken bilaga 6, Teknisk
handledning Web Service V2
[4]
Bilaga 9, Testdata för Navet,
http://www.skatteverket.se/foretagorganisation
E-persondata Demo Skatteverket er/formyndigheterkommuner/navet/tekniskbes
krivning.4.4bf45f331098492fe0e8000813.html
Välj sedan länken bilaga 9, Testdata för
demoversion Web Service
[5]
Navet XML-schema
för Epersondata
Navet,
http://xmls.skatteverket.se/se/skatteverket/folk
Skatteverket bokforing/na/epersondata/V1/Epersondata.xsd
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se
*Skatteverket
3(7)
BILAGA 8
Navet
2
Datum
Version
2015-06-04
2.0
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
används med ett testcertifikat, se kapitel 2.4.
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:
Indata
Bestallning
OrgNr
Beskrivning
Organisationsnumret måste matcha certifikatets
organisationsnummer. Testcertifikatets organisationsnummer är
162021004748.
BestallningsId I denna demoapplikation görs ingen kontroll av att
beställningsidentiteten är ett giltigt beställningsnummer.
Exempel på beställningsidentitet som kan användas vid test med
testcertifikat:
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.
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se
*Skatteverket
4(7)
BILAGA 8
Navet
Datum
Version
2015-06-04
2.0
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:
Indata
Beskrivning
Bestallning
OrgNr
Organisationsnumret måste matcha certifikatets
organisationsnummer. Testcertifikatets organisationsnummer
är 162021004748.
BestallningsId I denna demoapplikation görs ingen kontroll av att
beställningsidentiteten är ett giltigt beställningsnummer.
Exempel på beställningsidentitet som kan användas vid test
med testcertifikat:
00000079-FO01-0001
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.
Sökvillkor
- 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.
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se
*Skatteverket
5(7)
BILAGA 8
Navet
Datum
Version
2015-06-04
2.0
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.
2.3 Felmeddelanden
2.3.1 Felkoder Web Service Personpost
Web Service Personpost returnerar 0-1 personpost, beroende på om efterfrågad
person finns i Navet eller ej. Om till exempel inparametrarna är felaktiga eller något fel
uppstår i tjänsten returneras i stället ett specifikt SOAP-felmeddelande. De olika typerna
av fel har olika felkoder.
Följande felkoder kan erhållas från Personpost i denna demoapplikation [4, -11]. De
olika felkoderna finns beskrivna i ref [3], kapitel 5.1.5.
Tabellen nedan visar hur ett specifikt fel kan framkallas.
Felkod Beskrivning
Framkallas genom att
4
Felaktiga inparametrar:
Beställningsid har ett
ogiltigt värde.
Ange en beställningsidentitet med
felaktigt format. Det giltiga formatet
är NNNNNNNN-TTNN-NNNN
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: Angivet Orgnr
matchar inte med orgnr på
Certifikatet.
Ange ett organisationsnummer i
inparametern som inte matchar
organisationsnummer på certifikatet.
2.3.2 Felkoder Web Service Namnsökning
Web Service Namnsökning returnerar 0, 1 eller flera namnposter beroende på antalet
personer som motsvarar angivna sökvillkor. Om till exempel inparametrarna är felaktiga
eller något fel uppstår i tjänsten returneras i stället ett specifikt SOAP-felmeddelande.
De olika typerna av fel har olika felkoder
Följande felkoder kan erhållas från Namnsökning i denna demoapplikation [4, -11].
De olika felkoderna finns beskrivna i ref [3], kapitel 5.2.5.
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se
*Skatteverket
6(7)
BILAGA 8
Navet
Datum
Version
2015-06-04
2.0
Tabellen nedan visar hur ett specifikt fel kan framkallas.
Felkod Beskrivning
Framkallas genom att
4
Felaktiga inparametrar:
Beställningsid har ett
ogiltigt värde.
Ange en beställningsidentitet med felaktigt
format. Det giltiga formatet är
NNNNNNNN-TTNN-NNNN
4
Felaktiga inparametrar:
Termens längd är felaktig.
Ange ett förnamn som är längre än 80
tecken.
4
Felaktiga inparametrar:
Talet är felaktigt.
Ange ett postnummer som har ett felaktigt
format.
-11
Ange ett organisationsnummer i
Behörighetsfel: Angivet
Orgnr matchar inte med orgnr inparametern som inte matchar
organisationsnummer på certifikatet.
på Certifikatet.
2.3.3 Felsituationer
Förutom de fel som resulterar i att ett SOAP-fault returneras 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 tillsammans med XML-Schema Epersondata. 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/na/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/na/na_epersondata_demo/V2/personpost
För anslutning mot Web Service Personpost i XML-format anges följande adress:
https://ppx4.skatteverket.se/na/na_epersondata_demo/V2/personpostXML
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se
*Skatteverket
7(7)
BILAGA 8
Navet
Datum
Version
2015-06-04
2.0
För anslutning mot Web Service Namnsökning i format termkod/termdata anges
följande adress:
https://ppx4.skatteverket.se/na/na_epersondata_demo/V2/namnsokning
För anslutning mot Web Service Namnsökning i XML-format anges följande adress:
https://ppx4.skatteverket.se/na/na_epersondata_demo/V2/namnsokningXML
2.7 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.
SK A TTEVERK ET
Postadr ess
1 7 1 9 4 SOLNA
Telefon
010 5748050
E-post adr ess
navet.solna@skatteverket.se
W eb
www.skatteverket.se