Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Navitabs

root	SOR Enkeltopslagsservice (SORES)
includeroot	true

Table of Contents

Introduktion

SOR Enkeltopslagsservice er en støtte-service på NSP, der tillader enkelt-opslag af SOR enheder og SHAK-, CVR-mapninger gennem en JSON-snitflade.
Snitfladen er designet med BRS, MinSpærring, IDSAS og graviditetsmappen in mente, men alle NSP services, hvis behov opfyldes af de udstillede data, er velkomne til at kalde SORES's snitflade.

De udstillede data stammer fra SOR2-importeren, som indlæser det til stamdata-databasen. En delmængde af data caches i memory og cachen refreshes i produktion af en særskilt cron-container, hvis der er opdaterede data i databasen.

Snitfladebeskrivelsen indeholder - udover beskrivelse af selve snitfladen - eksempler på requests og responses.

Warning
SORES er kun til internt brug på NSP, den må ikke kaldes af eksterne anvendere. Der henvises til SORLS i stedet for.

Snitfladebeskrivelse

Generelt

Servletten udstiller et par funktioner via GET, mens selve opslags-funktionaliteten udstilles via en kommandostruktur sendt via POST.

Endpoints

SORES har to endpoints, hvor v2-udgaven medsender ejer-organisationens ID for SOR-entiteter.

Service	Endpoint
SORES	/sores
SORESv2	/sores/v2
SORESv3	/sores/v3

GET-funktioner

Funktion	Beskrivelse
/status	HTTP-response-code angiver servicens tilgængelighed
/version	Versions-nummeret sendes som response-text
/reload	Genindlæser data fra databasen

POST-operationer

Operation	Parametre	Beskrivelse
GetSorEntity	SorIds: Array af SOR-Id'er, der ønskes fremsøgt [Date]: Datagrundlags-dato	Returnerer information for hver af de forespurgte SOR entiteter, der gjaldt på den angivne dato* Operationen hed i første udgave af servicen BRSGetSorEntity, hvilket stadig understøttes som alias.
SearchAllChildren	SorIds: Array af SOR-Id'er, hvis under-entiteter ønskes fremsøgt [Date]: Datagrundlags-dato	Returnerer information for alle under-entiteter for hver af de forespurgte SOR entiteter, der gjaldt på den angivne dato* Operationen hed i første udgave af servicen BRSSearchAllChildren, hvilket stadig understøttes som alias.
MapShakToSor	ShakId: SHAK id, der ønskes mappet [Date]: Datagrundlags-dato	Returnerer information for de SOR-entiteter, der på den angivne dato* havde det forespurgte SHAK id. Operationen hed i første udgave af servicen BRSMapShakToSor, hvilket stadig understøttes som alias.
GetSorEntityByProvider	ProviderIds: Array af ydernumre [Date]: Datagrundlags-dato	Returnerer information for (en liste af) alle SOR entiteter, der var tildelt det angivne ydernummer på den angivne dato*
IsSorEntityDescendantOfSorEntity	SorIdAndParentSorIdPairs: Todimensionelt array af SOR-Id-par [Date]: Datagrundlags-dato	Returnerer et array af booleans - for hvert par af id'er [id, mulig forælder] - om den pågældende enhed hørte under den mulige forælder i hierarkiet på den angivne dato*
EntityNameLookup	MatchEntityName: Streng, der matches på som en del af enhedsnavnet CVR: CVR-nummer på den enhed, hvis undersåtter udgør søgeområdet EntityTypeNames: Liste af entitets-type-navne, der medtages [Date]: Datagrundlags-dato	Returnerer information for et mindre antal SOR entiteter, hvis navn indeholder den angivne søgestreng begrænset af at entiteten: ligger i SOR-træet under en entitet med det givne CVR-nummer har en entitets-type, der findes i den givne liste af entitets-typer var gyldig på den angivne dato, eller dags dato, hvis ingen dato er angivet Hvis intet CVR-nummer er angivet, søges i hele SOR-træet. Hvis entitets-type listen ikke er angivet eller er tom, returneres entiteter uanset deres type. Det anbefales på det kraftigste at anvende filtrering i videst mulige omfang. Såfremt søgningen matcher flere SOR entiteter end servicen er konfigureret til at returnere, indkluderer responset json-markøren `AdditionalRecordsExist` med værdien `True`.
InstitutionOwnerCvrNumber	SorIds: Array af SOR-Id'er, der ønskes fremsøgt [Date]: Datagrundlags-dato	Returnerer CVR nummeret på den Institutionsejer som den forespurgte SOR enhed hørte under på den angivne dato*
InstitutionOwnerCvrNumberByShak	ShakIds: Array af SHAK-Id'er, der ønskes fremsøgt	Returnerer CVR nummeret på den Institutionsejer som den forespurgte SHAK enhed hører under. Der tjekkes udelukkende på de fire første cifre af SHAK-id'et
BatchedOperations	Operations: Array af operationer	Returnerer et array med resultaterne fra de forskellige operationer i den rækkefølge som de er komme i.
ReplacedSORMap	SorIds: Array af SOR-Id'er, der ønskes fremsøgt	Tage imod en liste af SOR koder og for hver af dem returnere en liste af de SOR koder som er erstattet af dem.

Eksempler

Herunder illustreres eksempel-requests og de tilhørende responses for operationerne.

...

Code Block

language	bash
title	Request

curl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"ReplacedSORMap\", \"sorIds\": [ \"8041000016000459811000016001\", \"1292411000016002\", \"6101000016001501281000016008\", \"91331000016003239871000016006\" ] }" http://test1.ekstern-test.nspop.dk:8080/sores/

Code Block

language	js
title	Response

HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

{
    "8041000016000459811000016001":["8041000016012", "8041000016013"],

        {
            "fromSor":"459811000016001",
            "toSor":"1292411000016002",
            "6101000016001fromDate":[],
"2024-01-01",
            "91331000016003toDate":["6101000016001""
        },
        {
            "fromSor":"595111000016009",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        },
        {
            "fromSor":"595161000016006",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        },
        {
            "fromSor":"653971000016003",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        }
    ],
    "1292411000016002":[
        {
            "fromSor":"459811000016001",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        },
        {
            "fromSor":"595111000016009",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        },
        {
            "fromSor":"595161000016006",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        },
        {
            "fromSor":"653971000016003",
            "toSor":"1292411000016002",
            "fromDate":"2024-01-01",
            "toDate":""
        }
    ],
    "501281000016008":[
        {
            "fromSor":"501281000016008",
            "toSor":"1449941000016009",
            "fromDate":"2025-06-01",
            "toDate":""
        },
        {
            "fromSor":"501341000016007",
            "toSor":"1449941000016009",
            "fromDate":"2025-06-01",
            "toDate":""
        }
    ],
    "239871000016006":[
        {
            "fromSor":"239871000016006",
            "toSor":"239861000016001",
            "fromDate":"2024-01-01",
            "toDate":""
        }
    ]
}

Content

Space Tools