Page History
AFVENTER ENDELIG GODKENDELSE
Navitabs | ||||
---|---|---|---|---|
| ||||
Indholdsfortegnelse
Table of Contents | ||||
---|---|---|---|---|
|
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:
Eksterne typer
Mange af de data typer som bliver benyttet, kan typisk findes her:
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.
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. Eksempler på sådanne er SystemTypeIdentifier
under EanLocationCodeEntityType, eller RegionCode
under de forskellige adresse typer (aktivitet, post, of visitation). Koderne for disse kan findes her:
http://filer.nsi.dk/sor/lookupdata/
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
...
Releases SORUS WSDL
En oversigt over de forskellige releases, og eventuelle kommentarer omkring disse:
Release WSDL | Kommentar |
---|---|
3.0 | Release af version 3 af WSDL - gældende version |
2.0 | Release af version 2 - ikke tilgængelig |
1.0 | Release af version 1 - ikke tilgængelig |
Neden for kan dokumentationen for de aktive WSDL versioner findes.
Releases SORUS
Nyeste version af systemet.
Release SORUS | Kommentar |
---|---|
1.2.3 | Med rettelser efter QA v. Arosii. (SOR-429). SVN sendt til NSP d. 17.11.2022 - til TEST1 miljø. Godkendt v. Arosii. Deployed på TEST1 miljø og deployed på TEST2 miljø d. 20.01.23. Deploy til PROD miljø afventer at ekstern anvender har testet ok ved hul-i-gennem-test (opdateret d. 23.1.23) |
1.2.2 | Med rettelser efter QA v. Arosii. (SOR-414). SVN sendt til NSP d. 11.10.2022 - til TEST1 miljø Godkendt v. Arosii - sendt til Netic d. 13.10.22 |
1.2.1. | Med rettelser efter QA v. Arosii. (SOR-414). SVN sendt til NSP d. 21.9.2022 |
1.2.0 | Ændringer i forbindelse med overgang til Nemlogin3 og MitID (SOR-394) |
1.1 | Release af version 3 af WSDL |
1.0 | Release af version 1 af WSDL |
Endpoint
Endpoints til services på NSP er forskellige for kommuner/lægepraksissystemer og regioner.
Kommunerne/lægepraksissystemer benytter den centrale NSP, cnsp, og regionerne bruger den decentrale NSP.
Opdater servicen kan tilgås på adressen:
[miljø url]/sor-opdatering/v3/SOROpdateringService
TEST1-miljøet
https://test1-cnsp.ekstern-test.nspop.dk:8443/sor-opdatering/v3/SOROpdateringService
TEST2-miljøet:
https://test2-cnsp.ekstern-test.nspop.dk:8443/sor-opdatering/v3/SOROpdateringService
WSDL filen for servicen kan hentes ved at tilføje "?wsdl" til enden af URL'en.
Produktionsmiljø:
https://cnsp.nsp.dsdn.dk:8443/sor-opdatering/v3/SOROpdateringService
Via SDN - Kræver aftale med SDN.
Snitfladebeskrivelser
Fælles
Sikkerhed
Succesfuld anvendelse af SORUS service kræver, at der medsendes gyldig sikkerhedsbillet (SOSI Idkort) fra STS i kaldet.
Valideringen af de indkommende sikkerhedsbilletter foretages vha NSP Security API.
Sikkerhedsbillletter på niveau 3 og 4 (FOCES, VOCES, MOCES og lokale identifikationsmidler) tillades. 'På vegne af' understøttes ikke.
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.
For koderne til disse kan henvises til Klassifikationstabellen på KRS eller SorDataTypes.xml-filen som findes i SOR.zip her: https://sor-filer.sundhedsdata.dk/sor_produktion/data/sor/sorxml/.
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). Dvs. det er muligt at se de ændringer som man har foretaget i kaldet eller den fremtidige enhed.
UserType
Element | Data type | Beskrivelse |
---|---|---|
Roles | ArrayOfSorSecurityGroupExternalType | Liste af sikkerheds grupper som skal bruges under autoriseringen af et kald. Hvert type af kald har sin type som er nødvendigt, for at kunne udføre operationen. Afsenders CVR nummer skal være knyttet til den afsendte gruppe. |
Entities | SorIdentifierCollectionType | Liste af SOR-koder hvis træer som afsenderen har adgang til at redigere i. Indholdet bruges kun under autorisering af CreateSorEntity, EditSorEntity, MoveSorEntity, ReplaceSorEntities, CloseSorEntity og MoveEanLocationCode. Benyttes ikke ved EDI operationer. |
AddressInformationType
Element | Data type | Beskrivelse |
---|---|---|
AdditionalAddressInformationText | String | Yderligere oplysninger om adressen |
AddressPostal | AddressPostalType | Indeholder yderligere adresse informationer |
InheritanceIndicator | Boolean | Indikerer om adressen er nedarvet eller ej ("TRUE" = Ja) |
SkipAddressValidation | Boolean | Indikerer om den indtastede adresse skal valideres. Kun til input. Er altid sat til false i retur objektet. |
MunicipalityCode | String | Kommunekode |
StreetCode | String | Vejkodefeltet bruges kun til output - input i feltet bliver ignoreret. |
RegionName | String | Indeholder navnet på den valgte regionskode. Feltet bruges kun til output - input i feltet bliver ignoreret. |
RegionCode | String | Feltet bruges ikke - input i feltet bliver ignoreret. |
CoordETRS89z32NMeasure | Decimal | Northing koordinater i UTM zone 32 (ETRS89, North). Feltet bruges kun til output - input i feltet bliver ignoreret. |
CoordETRS89z32EMeasure | decimal | Easting koordinater i UTM zone 32 (ETRS89, East). Feltet bruges kun til output - input i feltet bliver ignoreret. |
AddressPostalType
Element | Data type | Beskrivelse |
---|---|---|
StreetName | String | Vejnavn |
StreetBuildingIdentifier | String | Husnummer |
FloorIdentifier | String | Etage |
SuiteIdentifier | String | Adressens dør eller til højre, til venstre eller midt for |
PostOfficeBoxIdentifier | Integer | Postboks. Feltet bruges ikke i dag - input i feltet bliver ignoreret |
PostCodeIdentifier | String | Postnummer |
DistrictName | String | Postdistrikt - input i feltet bliver ignoreret. |
CountryIdentificationCode | CountryIdentificationCodeType | Postadressens landekode |
SorIdentifierCollectionType
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
...
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier |
Liste af long |
Feltet benyttes ikke
Eksterne typer med lokale ændringer
Disse typer har ændringer i forhold til hvad man kan finde fra deres originale lokation.
AddressInformation type
...
Liste af SOR-koder |
ArrayOfEanLocationCodeType
Element | Data type | Beskrivelse |
---|---|---|
EanLocationCode | Liste af long | Liste af lokationsnumre |
ArrayOfEdiIdentifierType
Element | Data type | Beskrivelse |
---|---|---|
EdiIdentifier | Liste af long | Liste af EDI meddelelsestyper |
ArrayOfSorIdentifierType
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier | Liste af long | Liste af SOR-koder |
ArrayOfPrioritizedEntitySpecialityType
Element | Data type | Beskrivelse |
---|---|---|
PrioritizedEntitySpeciality | Liste af PrioritizedEntitySpecialityType | Liste af SOR-enhedens kliniske specialer. Der kan angives op til 8, hvoraf nr. 1 er hoved specialet. |
ArrayOfReplacingInfoType
Element | Data type | Beskrivelse |
---|---|---|
ReplacingInfoType | Liste af ReplacingInfoType | Liste af SOR-enheder |
ArrayOfSorSecurityGroupExternalType
Element | Data type | Beskrivelse |
---|---|---|
SorSecurityGroupExternal | Liste af SorSecurityGroupExternalType | Security groups |
CountryIdentificationCodeType
Element | Data type | Beskrivelse |
---|---|---|
Scheme | CountryIdentificationSchemeType | Landekode identifikations system |
Value | String | Landekode |
CountryIdentificationSchemeType
Element | Data type | Beskrivelse |
---|---|---|
String | Enumeration af landekode identifikations systemer. Kan have en af følgende værdier:
|
EanLocationCodeEntityType
Element | Data type | Beskrivelse |
---|---|---|
EanLocationCode | Long | Lokationsnummer |
OnlyInternalIndicator | Boolean | Angiver om lokationsnummeret er til internt brug |
NonActiveIndicator | Boolean | Angiver om lokationsnummeret er ikke-aktivt |
SystemSupplierIdentifier | Long | Systemleverandør-id |
CommunicationSupplierIdentifier | Long | Netoperatør-id |
SystemTypeIdentifier | Long | EDB-system-id |
EdiAdministratorIdentifier | Long | EDI-Administrator-id |
SorNote | String | Angiver eventuelle bemærkninger til lokationsnummeret |
SorStatus | SorStatusType | Angiver SOR enhedens status. Kun output. Input bliver ignoreret. |
RegionCode | String | Regionens kode, f.eks. 1084 for RegionHovedstaden |
EanLocationCodeStateType
Element | Data type | Beskrivelse |
---|---|---|
String | Enumeration af nedarving status for lokationsnumre. Kan have en af følgende værdier:
|
LocalAttributeCollectionType
Element | Data type | Beskrivelse | ||||||
---|---|---|---|---|---|---|---|---|
AddressPostalLocalAttribute1AddressPostal | StringMunicipalityCode | Lokal attribut 1 | ||||||
MunicipalityCodeLocalAttribute2 | StreetCodeString | StreetCodeLokal attribut 2 | ||||||
LocalAttribute3 | RegionCode | Feltet benyttes ikke | AdditionalAddressInformationText | AdditionalAddressInformationText | CoordETRS89z32NMeasure | CoordETRS89z32NMeasure | CoordETRS89z32EMeasure | CoordETRS89z32EMeasure |
SkipAddressValidation | boolean | Nyt felt. Indikerer om den indtastede adresse skal valideres. Er altid sat til false i retur objektet. | ||||||
RegionName | string | Nyt felt. Indeholder navnet på den valgte regionskode. | ||||||
InheritanceIndicator | boolean | Nyt felt. Indikerer om informationerne er nedarvet eller ej. |
VirtualAddressInformation type
...
String | Lokal attribut 3 | |
LocalAttribute4 | String | Lokal attribut 4 |
LocalAttribute5 | String | Lokal attribut 5 |
PrioritizedEntitySpecialityType
Element | Data type | Beskrivelse |
---|---|---|
SpecialityIdentifier | Long | Speciale-id: Identifikationskode der identificerer et lægefagligt speciale. Kommentar: Identifikationskoden er et begrebs-id fra SNOMED CT. |
SpecialityPriorityIdentifier | Long | Prioriteten af specialet. Hoved-/bi-speciale: Markerer om det er et hoved- eller bi-speciale. |
ReplacingInfoType
Element | Data type | Beskrivelse | ||
---|---|---|---|---|
EmailAddressIdentifierNameEmailAddressIdentifier | StringWebsite | Enhedens navn | ||
WebsiteSorId | TelehponeNumberIdentifier | TelehponeNumberIdentifier | FaxNumberIdentifier | FaxNumberIdentifier |
InheritanceIndicator | boolean | Nyt felt. Indikerer om informationerne er nedarvet eller ej. |
CreateSorEntity
Security gruppe påkrævet: SorCentralRole
Long | Enhedens SOR-kode | |
Date | Date | Dato for erstatning |
SorEntityType
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
UserSorIdentifier | User | User element til brug i autorisering af kaldet |
SorObject | SorEntity | Det SOR objekt som skal oprettes |
Output | ||
Element | Data type | Beskrivelse |
Status | Status | Status for hvordan kaldet gik |
CreateSorEntityResult | SorEntity | Det SOR objekt som blev oprettet i systemet |
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: SorEdiCentralRole
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:
...
Long | Unik nøgle der identificerer en SOR enhed. Genereres automatisk. En SOR-kode består af fire komponenter: - Fortløbende nummer - Namespace (7 cifre: "1000016") - Partition-ID (2 cifre) - Checksum-ciffer (1 cifre). Den første mulige SOR-kode er dermed '11000016002'. | |
SorType | SorTypeType | SOR-type. Angiver SOR-typen. Fx. "Institutionsejer" eller "Sundhedsinstitution". |
SorStatus | SorStatusType | Angiver SOR enhedens status. Overbegreb - indeholder dato og opdateringsoplysninger. |
GeographicalLocalisationIdentifier | Long | Id på den geografiske lokation. Bruges kun til output. Må kikke angives i input. |
GeographicalLocalisationName | String | Navn på den geografiske lokation. Bruges kun til output. Må ikke angives i input |
HasGeographicalLocalisation | Boolean | Angiver om SOR enheden har en geografisk lokation, skal være false eller tom hvis SOR typen er IO. |
ParentSorIdentifier | Long | Forældre SOR-id, må ikke udfyldes hvis SOR typen er IO. Ved Edit må feltet ikke udfyldes. Benyttes som input til CreateSorIntity operationen. Benyttes som output fra begge. |
ActivityAddressInformation | AddressInformationType | Aktivitetsadressen, skal være tom hvis SOR typen er IO eller HI. Hvis en OU oprettes/redigeres uden en aktivitetsadresse, nedarves den fra egen besøgsadresse. |
VisitingAddressInformation | AddressInformationType | Besøgsadressen, skal være tom hvis SOR typen er IO. Hvis HI/OU oprettes/redigeres uden en besøgsadresse, nedarves den fra enhedens egen postadresse. |
PostalAddressInformation | AddressInformationType | Postadressen, skal være udfyldt vis SOR typen er IO. For HI og OU gælder det, hvis enheden oprettes/redigeres uden en postadresse, nedarves den fra forældre enhedens postadresse. |
PharmacyIdentifier | String | SOR-enhedens apoteksnummer, skal være tom hvis SOR typen er IO, og hvis enheden ikke er en apoteksenhed |
EntityName | String | SOR Enhedens navn |
EntityTypeIdentifier | Long | Teknisk nøgle for EntityType (SNOMED Concept Id) |
VirtualAddressInformation | VirtualAddressInformationType | Angiver enhedens hjemmesideadresse, email, telefonnummer og faxnummer. Er obligatorisk for IO. For HI/OU gælder: Hvis objektet er null, så bliver VirtualAddress autoamtisk nedarvet fra parent-enheden |
ReportingLevelIndicator | Boolean | Angiver om enheden er indberetningsniveau til Landspatientregisteret (LPR2). Kun OU under HI med typen hospital kan have en. Feltet skal være false eller tom hvis SOR typen er IO eller HI, og hvis det ikke er en OU under en HI med typen hospital. |
LocalAttributeCollection | LocalAttributeCollectionType | Der kan være op til 5 lokale attributter, skal være tom hvis SOR typen er IO eller HI |
LocalCode | string | SOR-enhedens lokale kode. Kun OU under HI med typen hospital kan have en. Feltet skal være tom hvis SOR typen er IO eller HI, og hvis det er en OU som ikke er under en HI med typen hospital. Attribut der frit kan benyttes af anvender organisationen. |
EanLocationCodeState | EanLocationCodeStateType | Angiver om lokationsnummer er nedarvet fra den hierarkiske mor. Kan være 'own', 'inherited' eller 'none'. |
EanLocationCodeEntity | EanLocationCodeEntityType | Angiver lokationsnummeroplysninger på SOR enheden |
PatientsAdmittedIndicator | boolean | Angiver om enheden er et sengeafsnit. Kun OU under HI med typen hospital kan have en. Feltet skal være false eller tom hvis SOR typen er IO eller HI, og hvis det ikke er en OU under en HI med typen hospital. |
AmbulantActivityIndicator | boolean | Angiver om enheden er et ambulatorie. Kun OU under HI med typen hospital kan have en. Feltet skal være false eller tom hvis SOR typen er IO eller HI, og hvis det ikke er en OU under en HI med typen hospital. |
ShakIdentifier | String | Angiver hvilken sygehusafdelingskode, der er knyttet til SOR-enheden. Den samme sygehusafdelingskode kan være knyttet til mere end én SORenhed. Der kan kun registreres officielle sygehusafdelingskoder. Skal være tom hvis SOR typen er IO. |
PrioritizedEntitySpecialityCollection | ArrayOfPrioritizedEntitySpecialityType | Liste af SOR-enhedens kliniske specialer. Der kan angives op til 8, hvoraf nr. 1 er hovedspecialet. Skal være tom hvis SOR typen er IO eller HI. |
ProviderIdentifier | String | SOR-enhedens ydernummer feltet skal være tom, hvis SOR typen er IO eller HI eller det er en OU som ikke er under en HI med typen "hospital". Kun OU ikke under HI med typen hospital kan have en. Input i feltet bliver ignoreret uden varsel hvis der er tale om en hospital OU. |
CVRNumberIdentifier | string | CVR nummer for SOR-enheden. Obligatorisk hvis SOR typen er IO. |
ProductionUnitIdentifier | String | P nummer for SOR-enheden, skal være tom hvis SOR typen er IO, eller hvis det er en OU under en HI med typen hospital |
ReplacedByEntityCollection | ArrayOfReplacingInfoType | Liste af SOR-enheder denne enhed er blevet erstattet af |
ReplacesEntityCollection | ArrayOfReplacingInfoType | Liste af SOR-enheder denne enhed erstatter |
SorSecurityGroupExternalType
Element | Data type | Beskrivelse |
---|---|---|
String | Enumeration af security groups. Kan have en af følgende værdier:
|
SorStatusType
Element | Data type | Beskrivelse |
---|---|---|
FromDate | Date | Kun output-felt. Input i feltet bliver ignoreret. FromDate bliver default set til i dag+1 dag. Dvs. ændringer gælder altid fra i morgen. Under oprettelse (CreateSorEntity): Skal indeholde den første dag, hvor enheden er aktiv. Under rettelser (EditSorEntity), output: første dag ændring er aktiv/dato for dagen ændringen gælder fra. |
ToDate | Date | Sidste dag enheden er aktiv. Kun output-felt. Input i feltet bliver ignoreret. Brug CloseSorEntity() til at lukke en enhed. |
UpdatedAt | Date | Dato hvornår enheden sidst er opdateret. Kun output-felt. Input I feltet bliver ignoreret. |
FirstFromDate | Date | Dato for hvornår enheden første gang var aktiv. Bliver kun brugt til output. Input i feltet bliver ignoreret. |
SorTypeType
Element | Date type | Beskrivelse |
---|---|---|
String | Enumeration af SOR-typer. Kan have en af følgende værdier:
|
StatusType
Element | Data type | Beskrivelse |
---|---|---|
ErrorCode | Int | Hvis kaldet var en succes, så vil denne have værdien 0. Ved validerings fejl, så vil denne have en positiv værdi. Ved Tekniske og praktiske fejl, så vil denne have en negativ værdi. |
ErrorMessage | String | Hvis ErrorCode er 0, er dette felt tomt. Ellers indeholder den en kort beskrivelse af, hvilken fejl der skete. |
VirtualAddressInformationType
Element | Data type | Beskrivelse |
---|---|---|
InheritanceIndicator | Boolean | Indikerer om informationerne er nedarvet eller ej fra parent enheden. |
EmailAddressIdentifier | String | Emailadresse |
Website | String | Hjemmesideadresse |
TelephoneNumberIdentifier | String | Telefonnummer |
FaxNumberIdentifier | String | Fax-nummer |
CreateSorEntity
Security gruppe påkrævet: SorDecentralRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | CreateSorEntityRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | CreateSorEntityResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
CreateSorEntityRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorEntity | SorEntityType | Det SOR objekt som skal oprettes |
CreateSorEntityResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
SorEntity | SorEntityType | Det SOR objekt som blev oprettet i systemet |
EditSorEntity
Security gruppe påkrævet: SorDecentralRole, SorEditorRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditSorEntityRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditSorEntityResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditSorEntityRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorEntity | SorEntityType | Det SOR objekt som skal redigeres |
EditSorEntityResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
SorEntity | SorEntityType | SOR objektet som det ser ud efter redigering |
MoveSorEntity
Security gruppe påkrævet: SorDecentralRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | MoveSorEntityRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | MoveSorEntityResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
MoveSorEntityRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier | Long | SOR-kode på det SOR objekt som skal flyttes |
ParentSorIdentifier | Long | SOR-kode på det SOR objekt der skal være den nye parent |
FromDate | Date | Dato for hvornår at flytningen skal træde i kraft |
MoveSorEntityResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
ReplaceSorEntities
Security gruppe påkrævet: SorDecentralRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | ReplaceSorEntitiesRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | ReplaceSorEntitiesResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
ReplaceSorEntitiesRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier | Long | SOR-kode på det SOR objekt som skal flyttes |
FromDate | Date | Dato for hvornår at erstatningen skal træde i kraft |
ReplacesEntityCollection | ArrayOfSorIdentifierType | Liste af SOR-koder på de enheder som skal erstattes |
ReplaceSorEntitiesResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
CloseSorEntity
Security gruppe påkrævet: SorDecentralRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | CloseSorEntityRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | CloseSorEntityResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
CloseSorEntityRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier | Long | SOR-kode på det SOR objekt som skal lukkes |
ToDate | Date | Sidste dato for hvornår at enheden er aktiv |
CloseSorEntityResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
EditEanLocationCodeSystemType
Security-gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditEanLocationCodeSystemTypeRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.ententies ikke benyttes for EditEanLocationCodeSystemType operationen. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditEanLocationCodeSystemTypeResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditEanLocationCodeSystemTypeRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SystemTypeIdentifier | Long | EDB-system-id |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
EditEanLocationCodeSystemTypeResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
EditEanLocationCodeCommunicationSupplier
Security gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditEanLocationCodeCommunicationSupplierRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.Entities benyttes ikke for EditEanLocationCodeCommunicationSupplier operationen. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditEanLocationCodeCommunicationSupplierResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditEanLocationCodeCommunicationSupplierRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
CommunicationSupplierIdentifier | Long | VANS leverandør (ID) |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
EditEanLocationCodeCommunicationSupplierResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
EditEanLocationCodeEdiAdministrator
Security gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditEanLocationCodeEdiAdministratorRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.Entities benyttes ikke for EditEanlocationCodeEdiAdministrator operationen. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditEanLocationCodeEdiAdministratorResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditEanLocationCodeEdiAdministratorRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
EdiAdministratorIdentifier | Long | EDI-Administrator-id |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
EditEanLocationCodeEdiAdministratorResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
EditEanLocationCodeRegion
Security gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditEanLocationCodeRegionRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.Entities benyttes ikke for EditEanLocationCodeRegion operationen. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditEanLocationCodeRegionResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditEanLocationCodeRegionRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
RegionCode | Long | Region |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
EditEanLocationCodeRegionResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
EditEanLocationCodeSystemSupplier
Security gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | EditEanLocationCodeSystemSupplierRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.Entities benyttes ikke for EditEanLocationCodeSystemSupplier. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | EditEanLocationCodeSystemSupplierResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
EditEanLocationCodeSystemSupplierRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SystemSupplierIdentifier | Long | Systemleverandør-id |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
EditEanLocationCodeSystemSupplierResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
MoveEanLocationCode
Security gruppe påkrævet: SorDecentralRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | MoveEanLocationCodeRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | MoveEanLocationCodeResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
MoveEanLocationCodeRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
SorIdentifier | Long | SOR-kode for den nye enhed, som den skal knyttes til |
EanLocationCode | Long | Angiver lokationsnummeret for enheden |
MoveEanLocationCodeResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
UpdateEdiTypes
Security gruppe påkrævet: SorEdiAdminRole
Input | ||
Element | Data type | Beskrivelse |
---|---|---|
Parameter | UpdateEdiTypesRequestParameterType | Parametre for operationen |
User | UserType | User element til brug i autorisering af kaldet. User.Entities benyttes ikke for UpdateEdiTypes operationen. |
Output | ||
Element | Data type | Beskrivelse |
---|---|---|
Result | UpdateEdiTypesResponseResultType | Resultatet af operationen |
Status | StatusType | Status for hvordan kaldet gik |
UpdateEdiTypesRequestParameterType
Element | Data type | Beskrivelse |
---|---|---|
EdiIdentifiers | ArrayOfEdiIdentifierType | Liste af EDI-meddelelsestyper som skal tilføjes til lokationsnumre som skal opdateres. Ved tom liste slettes alle EDI numre fra lokationsnumre som skal opdateres. |
EanLocationCodeEntities | ArrayOfEanLocationCodeType | Liste af lokationsnumre som skal opdateres |
UpdateEdiTypesResponseResultType
Element | Data type | Beskrivelse |
---|---|---|
Tomt objekt |
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:
MedCom fault code | Fault string | Beskrivelse |
---|---|---|
missing_required_header | Ikke muligt at læse forespørgslen | Autentifikations fejl, kan ikke læse forespørgslen |
ticket_missing | Der opstod en fejl under autentificeringen: Manglende sikkerhedsbillet i forespørgsel | Autentifikations fejl, manglende sikkerhedsbillet i forespørgsel |
ticket_not_valid | Der opstod en fejl under autentificeringen: Sikkerhedsbilletten er ikke gyldig | Autentifikations fejl, ugyldig sikkerhedsbillet i forespørgsel |
principal_user_present | Der opstod en fejl under autoriseringen: På vegne af understøttes ikke | Autorisations fejl, på vegne af tillades ikke adgang |
organisation_missing | Der opstod en fejl under autoriseringen: Manglende organisation i sikkerhedsbilletten | Autorisations fejl, organisation ikke angivet |
user_type_not_valid | Der opstod en fejl under autoriseringen: Brugertypen kan ikke autoriseres | Autorisations fejl, brugertypen tillades ikke adgang |
not_authorized | CVR er ikke whitelistet | Autorisations fejl, manglende whitelisting |
syntax_error | Det er ikke muligt at læse body | Fejl under transformeringen af SOAP body til et objekt |
processing_problem | Ugyldig requesttype | Request typen i SOAP action findes ikke |
processing_problem | Det er ikke muligt at læse forespørgslen | Request body kan ikke læses |
processing_problem | Der er sket en fejl i forsøget på at kontakte SOR databasen | Fejl under forespørgsel mod whitelistingdatabasen |
processing_problem | Error happened while contacting SOR backend | Fejl under forespørgsel mod backenden Supporten kan søge i SOR ekstern/SOR intern fejllogs |
processing_problem | Det er ikke muligt at skrive objekt | Fejl under at skrive det transformerede objekt til klienten |
processing_problem | Det er ikke muligt at skrive body | Fejl under transformeringen af object til XML |
processing_problem | Det er ikke muligt at læse body | Fejl under transformeringen af SOAP body til et objekt |
Andre fejlkoder kan forekomme, men disse kommer fra SOR Ekstern eller SOR Intern.
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 et eksempel implementation i Java, kan der med fordel tages udgangspunkt i servicens integrationstest:
Denne implementerer og bruger 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 for seal 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
...
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.
Kendte fejl
Der er desværre en udfordring med at sende værdien null frem og tilbage, som ikke er muligt at få løst før en fremtidig release. Heldigvis er de lette at detektere og håndtere.
Alle dato værdier som burde blive returneret som null, vil i stedet blive returneret som 0001-01-01 (så, starten for vores tidsregning).
Alle tal felter som burde blive returneret som null, vil i stedet blive returneret som deres mindste værdi. Felter som er long vil blive -9.223.372.036.854.775.808, integer vil blive -2.147.483.648, og så videre.
Alle boolean felter som burde være null, vil i stedet blive returneret som false. Men dette vil også være den forventede værdi i tilfælde af at den mangler.
Alle string felter er dog ikke kendt at have dette null problem, og burde blive returneret korrekt.