Page History
| Navitabs | ||||
|---|---|---|---|---|
|
Indholdsfortegnelse
| Table of Contents | ||
|---|---|---|
|
Releases
En oversigt over de forskellige releases, og eventuelle kommentare omkring disse:
...
Release af version 3 af WSDL
Version 1 og version 2 er fjernet
...
Neden for kan dokumentationen for de aktive WSDL versioner findes.
Version 3
Nyeste version af systemet.
Endpoint
Opdater servicen kan tilgås på adressen:
[miljø url]/sor-opdatering/v3/SOROpdateringService
Sti til TEST1-miljøet:
http://test1-cnsp.ekstern-test.nspop.dk:8080/sor-opdatering/v3/SOROpdateringService
Sti til TEST2-miljøet:
http://test2-cnsp.ekstern-test.nspop.dk:8080/sor-opdatering/v3/SOROpdateringService
WSDL filen for servicen kan hentes ved at tilføje "?wsdl" til enden af URL'en.
Endpoint til produktion - for Regioner
Regionen skal kontakte sin lokale netværksafdeling for at få oplyst adgang til dNSP.
Snitfladebeskrivelser
Fælles
Sikkerhed
Fælles for hele servicen, er at der bliver benyttet Den Gode Webservice (DGWS) til authentifikering, og der accepteres kun niveau 3 (VOCES og FOCES) eller 4 (MOCES) ID kort udstedt af SOSI-STS. Selvom at niveau 3 både indeholder FOCES og VOCES, så er det kun FOCES som er tilladt.
Namespaces
Alle kald til servicen vil benytte typer defineret under namespacet:
http://sundhedsdatastyrelsen.dk/SOROpdateringService/2019/10/08/
Alle typer benyttet i parametre og resultater i disse kald er defineret under namespacet:
Koder
Flere felter benytter koder frem for tekst strenge til at signalere over for servicen, hvilken type enhed der er ønsket at blive oprettet, eller hvor at enheden er placeret. Eksempel på sådan er SystemTypeIdentifier under EanLocationCodeEntityType. Koderne for disse kan findes her:
http://filer.nsi.dk/sor/lookupdata/
Gyldighed
I de kald hvor at SorEntityType bliver returneret, der er den returnerede version ikke den gyldige version af enheden. Den returnerede version er hvad der vil blive gyldigt i fremtiden (tidligst dagen efter).
UserType
...
AddressInformationType
...
Feltet bruges kun til output - input i feltet bliver ignoreret.
...
AddressPostalType
...
SorIdentifierCollectionType
...
ArrayOfEanLocationCodeType
...
ArrayOfEdiIdentifierType
...
ArrayOfSorIdentifierType
...
ArrayOfPrioritizedEntitySpecialityType
...
ArrayOfReplacingInfoType
...
ArrayOfSorSecurityGroupExternalType
...
CountryIdentificationCodeType
...
CountryIdentificationSchemeType
...
Enumeration af landekode identifikations systemer. Kan have en af følgende værdier:
- iso3166-alpha2
- iso3166-alpha3
- un-numeric3
- imk
EanLocationCodeEntityType
...
EanLocationCodeStateType
...
Enumeration af nedarving status for lokationsnumre. Kan have en af følgende værdier:
- Undefined
- None
- Inherited
- Own
LocalAttributeCollectionType
...
PrioritizedEntitySpecialityType
...
ReplacingInfoType
...
SorEntityType
...
SorSecurityGroupExternalType
...
Enumeration af security groups. Kan have en af følgende værdier:
- SorDecentralRole
- SorEditorRole
- SorGeoRole
- SorShakRole
- SorMoveEanRole
- SorEdiAdminRole
SorStatusType
...
SorTypeType
...
Enumeration af SOR typer. Kan have en af følgende værdier:
- IO
- HI
- OU
StatusType
...
VirtualAddressInformationType
...
CreateSorEntity
Security gruppe påkrævet: SorCentralRole, SorDecentralRole
...
CreateSorEntityRequestParameterType
...
CreateSorEntityResponseResultType
...
EditSorEntity
Security gruppe påkrævet: SorCentralRole, SorDecentralRole
...
EditSorEntityRequestParameterType
...
EditSorEntityResponseResultType
...
MoveSorEntity
Security gruppe påkrævet: SorCentralRole, SorDecentralRole
...
MoveSorEntityRequestParameterType
...
MoveSorEntityResponseResultType
...
ReplaceSorEntities
Security gruppe påkrævet: SorCentralRole, SorDecentralRole
...
ReplaceSorEntitiesRequestParameterType
...
ReplaceSorEntitiesResponseResultType
...
CloseSorEntity
Security gruppe påkrævet: SorCentralRole, SorDecentralRole
...
CloseSorEntityRequestParameterType
...
CloseSorEntityResponseResultType
...
EditEanLocationCodeSystemType
Security gruppe påkrævet: SorEdiCentralRole, SorEdiAdminRole
...
EditEanLocationCodeSystemTypeRequestParameterType
...
EditEanLocationCodeSystemTypeResponseResultType
...
EditEanLocationCodeCommunicationSupplier
Security gruppe påkrævet: SorEdiCentralRole, SorEdiAdminRole
...
EditEanLocationCodeCommunicationSupplierRequestParameterType
...
EditEanLocationCodeCommunicationSupplierResponseResultType
...
EditEanLocationCodeEdiAdministrator
Security gruppe påkrævet: SorEdiCentralRole
...
EditEanLocationCodeEdiAdministratorRequestParameterType
...
EditEanLocationCodeEdiAdministratorResponseResultType
...
EditEanLocationCodeRegion
Security gruppe påkrævet: SorEdiCentralRole, SorEdiAdminRole
...
EditEanLocationCodeRegionRequestParameterType
...
EditEanLocationCodeRegionResponseResultType
...
EditEanLocationCodeSystemSupplier
Security gruppe påkrævet: SorEdiCentralRole
...
EditEanLocationCodeSystemSupplierRequestParameterType
...
EditEanLocationCodeSystemSupplierResponseResultType
...
MoveEanLocationCode
Security gruppe påkrævet: SorEdiCentralRole, SorDecentralRole
...
MoveEanLocationCodeRequestParameterType
...
MoveEanLocationCodeResponseResultType
...
UpdateEdiTypes
Security gruppe påkrævet: SorEdiCentralRole, SorDecentralRole
...
UpdateEdiTypesRequestParameterType
...
UpdateEdiTypesResponseResultType
...
Fejlkoder
Alle operationer vil som udgangspunkt returnere et Status objekt som en del af svaret. Dette object indeholder altid to felter, ErrorCode og Message. Hvis ErrorCode er 0, så var kaldet en succes, ellers skete der en fejl i løbet af kaldet. Positive værdier er validerings fejl fra SOR's interne systemer, og Message vil have en beskrivelse af fejlen. Mere tekniske fejl vil blive lavet som en SOAP fault. De nedenstående er hvilke denne applikation definerer:
...
Andre fejlkoder kan forekomme, men disse kommer fra backenden, eller dens underliggende services.
Det skal pointeres, at MedCom's fault code kan findes under detail sektionen af den resulterende SOAP fault. Den påkrævede faultstring vil altid være "Server".
Eksempel på kald
Java frameworks
For en eksempel implementation i Java, kan der med foredel tages udgangspunkt i servicens integrationstest:
Denne implementerer og bruge er JAX-WS klient for servicen, implementeret med Apache CXF. Klienten benytter også Seal.Java biblioteket til håndtering af SOSI ID kort og DGWS. Yderligere dokumentation på biblioteket kan findes her:
https://digitaliser.dk/group/374971
.NET frameworks
Seal.NET er .NET ekvivalenten til Seal.Java, og er dokumenteret her:
http://digitaliser.dk/group/375117
Der eksisterer ingen eksempel implementation i .NET, men bibliotek og WSDL er frit tilgængelig til at lave en sådan.