...

Indholdsfortegnelse

Endpoint

Opdater servicen kan tilgås på adressen:

[miljø url]/sor-opdater/SOROpdateringService

For eksempel, på TEST1-miljøet vil det være:

http://test1.ekstern-test.nspop.dk:8080/sor-opdater/SOROpdateringService

WSDL filen for servicen kan hentes ved at tilføje "?wsdl" til enden af URL'en.

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/2018/09/06/

Der er type med samme navne under andre namespaces, så det er vigtigt at få valgt den rigtige.

Alle svar fra servicen vil benytte typer defineret under namespacet:

http://sor.dksund.dk/

Eksterne typer

Mange af de data typer som bliver benyttet, kan typisk findes her:

http://filer.nsi.dk/sor/xsd/

Typer under både v_1_0_0 og v_2_0_0 bliver benyttet.

Følgende lokationer bliver også inkluderet for typer:

http://digitaliser.dk/resource/1945/artefact/CVR_CVRnumberIdentifier.xsd

http://rep.oio.dk/cvr.dk/xml/schemas/2005/03/22/CVR_ProductionUnitIdentifier.xsd

http://rep.oio.dk/kms.dk/xml/schemas/2007/05/23/

Alle typer hentet eksternt fra er ikke angivet i dette dokument, da listen så vil blive meget lang.

Gyldighed

I de kald hvor at SorEntity 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).

User type

...

ArrayOfLong type

...

ArrayOfsorSecurityGroupsExternal type

...

sorSecurityGroupsExternal type

...

Enumeration af security groups. Kan have en af følgende værdier:

• SorCentralRole
• SorDecentralRole
• SorEditorRole
• SorGeoRole
• SorShakRole
• SorEdiCentralRole
• SorEdiAdminRole
• SorMoveEanRole

EanLocationCodeState type

...

Enumeration af stadier. Kan have en af følgende værdier:

• Undefined
• None
• Inherited
• Own

EanLocationCodeEntityType type

...

ArrayOfEanLocationCodes type

...

ArrayOfEdiIdentifiers type

...

Status type

...

SorEntity type

...

Angiver systemleverandøren for lokationsnummeret. Obligatorisk hvis lokationsnummer oprettes.

...

CreateSorEntity

Security gruppe påkrævet: SorCentralRole

...

EditSorEntity

Security gruppe påkrævet: SorCentralRole

...

MoveSorEntity

Security gruppe påkrævet: SorCentralRole

...

ReplaceSorEntities

Security gruppe påkrævet: SorCentralRole

...

CloseSorEntity

Security gruppe påkrævet: SorCentralRole

...

EditEanLocationCodeSystemType

Security gruppe påkrævet: SorEdiCentralRole

...

EditEanLocationCodeCommunicationSupplier

Security gruppe påkrævet: SorEdiCentralRole

...

EditEanLocationCodeEdiAdministrator

Security gruppe påkrævet: SorEdiCentralRole

...

EditEanLocationCodeRegion

Security gruppe påkrævet: SorEdiCentralRole

...

EditEanLocationCodeSystemSupplier

Security gruppe påkrævet: SorEdiCentralRole

...

MoveEanLocationCode

Security gruppe påkrævet: SorEdiCentralRole

...

UpdateEdiTypes

Security gruppe påkrævet: SorCentralRole

ArrayOfEdiIdentifiers

...

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:

https://svn.nspop.dk/svn/capgemini/SORServices/NSP/sorus/trunk/SorUpdateService/src/test/java/dk/sds/nsp/sor/sorus/servlet/SorusServletIT.java

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.