Svarskoder
Dokumenthistorik
Datum | Version | Namn | Förändring |
|---|---|---|---|
Mar 12, 2020 | 2.0 | @Former user (Deleted) | Nya svarskoder från och med version 4.3 |
Mar 16, 2020 | 2.1 | @Former user (Deleted) | Uppdaterat rubrik. |
May 27, 2021 | 2.2 | @Former user (Deleted) | Tagit bort felaktigt fält i felmeddelanden. |
Jul 19, 2023 | 3.0 | @Former user (Deleted) | Anpassad för extern publicering. |
Innehåll
Se även Best practice i regel 11, RIVTA "Best-practice för felhantering".
Gemensamt för alla interaktioner
Felmeddelanden
Enligt ws Basic Profile v1.1 returneras alla Soap faults med en HTTP 500 error status.
När en användare inte är behörig att anropa tjänsten returneras ett soap:Fault med följande felmeddelande;
Obehörigt anrop för system <systemHsaID>.
Läsande interaktioner
Samtliga läsande interaktioner returnerar en beskrivande text som svar när ett fel uppstår.
Soap svar:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Beskrivande felmeddelande</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>Felmeddelanden per läsande kontrakt
Vid kända fel returneras ett soap:Fault med faultcode soap:Client samt faultstring med beskrivande felmeddelande enligt följande tabell.
Kontrakt | Felorsak | Felmeddelande (faultstring) |
|---|---|---|
LookupResidentForFullProfile | Listan med personidentiteter innehåller för många element | Listan vid namn personidentiteter innehåller för många element, maxgränsen är maxgräns. |
Felaktigt format på en personidentitet | Ogiltigt format på personidentitet: 196604072f808 | |
LookupResidentsForProfile | Inga personidentiteter angivna | Listan med personidentiteter måste innehålla minst ett element. |
Felaktigt format på personid eller personid saknas | Ogiltigt format på personidentitet: 123456 | |
Personidentitetstyp saknas | Personidentitetstypen får inte vara tom. | |
Felaktigt format på personidentitetstyp eller personidentitetstyp är tom | Ogiltigt format på personidentitetstypen. | |
Tom/ogiltig profiltyp | En giltig profiltyp kunde inte hittas. | |
GetFilesForOrderId | Orderid saknas eller är tom | Orderid får inte vara tom. |
GetPersonContactInformation GetPersonContactInformationUnrestricted | Personidentitet saknas eller är tom | Personidentitet får inte vara tom. |
Ogiltigt format på personidentitet | Ogiltigt format på personidentitet för angiven typ 1.2.752.129.2.1.3.3 | |
Personidentitetstypen saknas eller är tom | Personidentitetstyp får inte vara tom. | |
Ogiltigt format på personidentitetstypen | Kan inte hitta angivet OID för 1.2.752.129.2f. | |
Personidentitet och personidentitetstyp matchar inte | Angiven OID 1.2.752.129.2.1.3.3 är inte giltig för identitet 196604072808 | |
Inga resultat finns att visa | Sökningen resulterade inte i några träffar. | |
GetPersonsForProfile GetPersonsForProfileUnrestricted | Inga personidentiteter angivna | Listan med personidentiteter måste innehålla minst ett element. |
Personid saknas eller är tom | Personidentitet får inte vara tom. | |
Ogiltigt format på personidentitet | Ogiltigt format på personidentitet för angiven typ 1.2.752.129.2.1.3.1 | |
Personidentitetstyp saknas eller är tom | Personidentitetstyp får inte vara tom. | |
Ogiltigt format på personidentitetstyp | Kan inte hitta angivet OID för 1.2.752.129.2f. | |
Personidentitet och personidentitetstyp matchar inte | Angiven OID 1.2.752.129.2.1.3.3 är inte giltig för identitet 196604072808 | |
Tom/ogiltig profiltyp | En giltig profiltyp kunde inte hittas. | |
SearchPersonsForProfile SearchPersonsForProfileUnrestricted SearchPersonsForProfileByOrder SearchPersonsForProfileByOrderUnrestricted | Frågan saknas eller är tom | Frågan får inte vara tom. |
Ogiltigt format på frågan (ex. FROM uttrycket saknas) | Tolkning av förfrågan misslyckades. Kontrollera syntax och försök igen. | |
Frågespråket saknas eller är tom | Frågespråket får inte vara tom. | |
Frågespråket finns inte i systemet | SimpleQR känns inte igen. | |
Tom/ogiltig profiltyp | En giltig profiltyp kunde inte hittas. |
Vid okända fel returneras ett soap:Fault med faultcode soap:Server och faultstring "Internt systemfel" enligt följande exempel;
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Internt systemfel</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>Skrivande interaktioner
När en skrivande interaktion går fel på grund av ett okänt fel så returneras ett soap:Fault enligt föregående exempel.
När en skrivande interaktion går fel på grund av ett känt fel så returneras alltid en kod ERROR med en sträng som beskriver vad som gick fel, exempelvis:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:response xmlns:ns5="urn:riv:itintegration:registry:1" xmlns:ns4="urn:riv:strategicresourcemanagement:persons:person:3.2" xmlns:ns3="urn:riv:strategicresourcemanagement:persons:person:3.1" xmlns:ns2="urn:riv:strategicresourcemanagement:persons:person:ResponseType:3" xmlns="urn:riv:strategicresourcemanagement:persons:person:3">
<ns2:result>
<resultCode>ERROR</resultCode>
<resultText>Beskrivande text om vad som gick fel.</resultText>
</ns2:result>
</ns2:Response>
</soap:Body>
</soap:Envelope>Samtliga meddelanden från kända fel returneras i returtypen result.resultText.
Generella fel för alla skrivande interaktioner
Skulle ett anrop mot något av de uppdaterande kontrakten som tar emot en identitet få en felaktig identitet där root inte stämmer överens med formatet på extension returneras följande meddelande:
Personidentiteten är angiven på ogiltigt format.
När versionen som anges vid en uppdatering inte är den senaste:
Valideringsfel, angiven version är inte den senaste.
När ett okänt fel uppstår:
Internt systemfel.(soap:Fault)
När ett värde inte följer specifikationen för given typ:
Värdet för parameter use är inte giltigt. (Där use är ett enum för exempelvis kontaktuppgifter)
Eller mer utförligt med beskrivning av specifikationen:
contactInformation.period -> Minst en av parametrarna start och end måste ha ett värde i formatet YYYY-MM-DD.
LinkPersonIdentity
Nationellt ramverk för hantering av reservidentiteter
Som stöd vid implementering av interaktioner kring identitetskopplingar har ett nationellt ramverk tagits fram utifrån rutinerna för uttag och hantering av reservidentiteter i ett antal olika antal landsting och regioner. Detta återfinns under Personuppgiftstjänstens sidor för Dokument: https://www.inera.se/personuppgiftstjansten/dokument. Även de filmer som visar tjänstens administrationsgränssnitt i FAQn kan vara till hjälp i arbetet.
Meddelande vid försök till att koppla en person som redan är kopplad till en huvudidentitet:
Valideringsfel, [extension 99002040AAA9 : root 1.2.752.74.9.1] är kopplad till en annan identitet. Använd dess huvudidentitet för att administrera kopplingar.
Koppla en identitet till sig själv:
Valideringsfel, identiterna får inte vara identiska.
Skapa en koppling där personnummer/samordningsnummer anges som fromIdentity:
Valideringsfel, bara Skatteverket kan utföra en koppling som resulterar i att ett PNR/SNR står som sekundär identitet.
Koppla två lokala reservnummer:
Valideringsfel, koppling mellan lokala reservnummer är inte tillåtet.
Koppla ett lokalt id till ett nationellt id:
Valideringsfel, koppling måste följa hierarkin LRID → NRID → SNR → PNR.
UnlinkPersonIdentity
Nationellt ramverk för hantering av reservidentiteter
Som stöd vid implementering av interaktioner kring identitetskopplingar har ett nationellt ramverk tagits fram utifrån rutinerna för uttag och hantering av reservidentiteter i ett antal olika antal landsting och regioner. Detta återfinns under Personuppgiftstjänstens sidor för Dokument: https://www.inera.se/personuppgiftstjansten/dokument. Även de filmer som visar tjänstens administrationsgränssnitt i FAQn kan vara till hjälp i arbetet.
Meddelande vid försök att koppla isär en identitet från samma identitet:
Valideringsfel, identiterna får inte vara identiska.
Koppla isär två identiteter som inte är kopplade:
Valideringsfel, identiteten [extension 22760208AAA4 : root 1.2.752.74.9.1] är inte kopplad till angiven huvudidentitet [extension 190302158282 : root 1.2.752.129.2.1.3.1].
Koppla isär en identitet som inte har några kopplade identiteter:
Valideringsfel, identiteten [extension 196812732391 : root 1.2.752.129.2.1.3.3] har inga kopplingar.
Koppla isär en identitet med personnummer/samordningsnummer:
Valideringsfel, isärkoppling mellan personnummer och samordningsnummer är ej tillåtet.
UpdatePersonContactInformation
Meddelande vid försök att sätta optoutPaperNotification till sant när det inte finns en contactInformation som har digitalNotification satt till sant.
Det måste finnas en kontaktinformation som kan ta emot de digital aviseringarna.
När digitalNotification för contactPerson.contactInformation sätts till sant:
Digital notifiering kan inte aktiveras för en kontaktperson.
När personen är sekretessmarkerad eller har skyddad folkbokföring:
Valideringsfel, får inte lägga till kontaktinformation för en sekretessmarkerad identitet.