SOR Enkeltopslagsservice er en støtte-service på NSP, der tillader enkelt-opslag af SOR enheder og SHAK-mapninger gennem en JSON-snitflade.
Snitfladen er designet med BRS og MinSpærring in mente, men alle services, hvis behov opfyldes af de udstillede data, er velkomne til at kalde SORES's snitflade.
De udstillede data stammer fra SOR-databasen, der opdateres dagligt af SOR-importeren. En delmængde af data caches i memory og cachen refreshes i produktion af en særskilt cron-container, hvis der er opdatede data i databasen.
Snitfladebeskrivelsen indeholder - udover beskrivelse af selve snitfladen - et par eksempler på request og response.
Servletten udstiller et par funktioner via GET, mens selve opslags-funktionaliteten udstilles via en kommandostruktur sendt via POST.
SORES har kun et enkelt endpoint.
Service | Endpoint |
---|---|
SORES | /sores |
Funktion | Beskrivelse |
---|---|
/status | HTTP-response-code angiver servicens tilgængelighed |
/version | Versions-nummeret sendes som response-text |
/reload | Genindlæser data fra databasen |
Operation | Parametre | Beskrivelse |
---|---|---|
BRSGetSorEntity | 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* |
BRSSearchAllChildren | 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* |
BRSMapShakToSor | 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 |
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* |
* eller dags dato, hvis ingen dato er angivet
Herunder illustrerer et par eksempler requests og responses for de tre operationer.
|
|
|
|
|