Page History
Navitabs | ||||
---|---|---|---|---|
| ||||
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 den XML fil som SOR stiller til rådighed på deres hjemmeide. 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.
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 |
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 | Returnerer information for et mindre antal SOR entiteter, hvis navn indeholder den angivne søgestreng begrænset af at entiteten:
Hvis intet CVR-nummer er angivet, søges i hele SOR-træet. Såfremt søgningen matcher flere SOR entiteter end servicen er konfigureret til at returnere, indkluderer responset json-markøren |
InstitutionOwnerCvrNumber | SorIds: Array af SOR-Id'er, der ønskes fremsøgt | 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 |
Eksempler
Herunder illustreres et par eksempel-requests og de tilhørende responses for operationerne.
GetSorEntity
Expand | ||
---|---|---|
| ||
|
GetSorEntity (v2)
Expand | ||
---|---|---|
| ||
|
GetSorEntityByProvider
Expand | ||
---|---|---|
| ||
|
GetSorEntityByProvider (v2)
Expand | ||
---|---|---|
| ||
|
SearchAllChildren
Expand | ||
---|---|---|
| ||
|
SearchAllChildren (v2)
Expand | ||
---|---|---|
| ||
|
IsSorEntityDescendantOfSorEntity (v1 og v2)
Expand | ||
---|---|---|
| ||
|
EntityNameLookup
Expand | ||
---|---|---|
| ||
|
EntityNameLookup (v2)
Expand | ||
---|---|---|
| ||
|
MapShakToSor (v1 og v2)
Expand | ||
---|---|---|
| ||
|
InstitutionOwnerCvrNumber (v1 og v2)
Expand | ||
---|---|---|
| ||
|
InstitutionOwnerCvrNumberByShak (v1 og v2)
Expand | ||
---|---|---|
| ||
|