Versions Compared

Old Version 1

changes.mady.by.user Unknown User (mbm@arosii.dk)

Saved on

compared with

New Version 2

changes.mady.by.user Unknown User (mbm@arosii.dk)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootSOR Enkeltopslagsservice (SORES)
includeroottrue



Introduktion

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 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 requests kan gennemtvinge en refresh af cachen såfremt det er ønskværdigt i udviklingsøjemed, mens driften sørger for at refreshe cachen i produktion, når importeren er kørt færdig.

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 kun et enkelt endpoint.

Service

Endpoint

SORES/sores

GET-funktioner

Funktion

Beskrivelse

Eksempel-response
/statusHTTP-response-code angiver servicens tilgængelighed200 = OK
/versionVersions-nummeret sendes som response-text1.0.0
/reloadGenindlæser data fra databasen, hvis antallet af rækker er ændret siden sidste indlæsning'Reload not necessary' eller 'Reload done'
/forcereloadGenindlæser data fra databasen ubetingetReload forced

POST-operationer

Operation

Parametre

Beskrivelse
BRSGetSorEntitySorIds: 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*
BRSSearchAllChildrenSorIds: 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*
BRSMapShakToSorShakId: SHAK id, der ønskes mappet
[Date]: Datagrundlags-dato		Returnerer information for de SOR-entiteter, der på den angivne dato* havde det forespurgte SHAK id.

* eller dags dato, hvis ingen dato er angivet

Eksempler

Herunder illustrerer et par eksempler requests og responses for de tre operationer.

BRSGetSorEntity

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"BRSGetSorEntity\", \"sorIds\": [ \"8041000016000\", \"6101000016001\" ] }" http://test1.ekstern-test.nspop.dk:8080/sores/
No Format
HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Transfer-Encoding: chunked
Content-Type: text/plain;charset=utf-8
Date: Tue, 24 Mar 2020 14:31:15 GMT


{
    "8041000016000":{
        "sorId":8041000016000,
        "from":"2016-10-18",
        "name":"Sydvestjysk Sygehus",
        "healthInstitutionSorId":8041000016000,
        "parentSorId":6101000016001
    },
    "6101000016001":{
        "sorId":6101000016001,
        "from":"2015-07-30",
        "name":"Region Syddanmark"
    }
}

BRSSearchAllChildren

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"BRSSearchAllChildren\", \"sorIds\": [ \"246061000016002\" ] }" http://test1.ekstern-test.nspop.dk:8080/sores/
No Format
HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Transfer-Encoding: chunked
Content-Type: text/plain;charset=utf-8
Date: Tue, 24 Mar 2020 14:44:05 GMT


{
    "246061000016002":[
        {
            "sorId":246071000016007,
            "from":"2019-04-16",
            "name":"SVS Tand- Mund- og Kæbekirurgisk ambulatorium (Esbjerg)",
            "healthInstitutionSorId":8041000016000,
            "parentSorId":246061000016002
        },
        {
            "sorId":452041000016004,
            "from":"2019-08-17",
            "name":"SVS tand-, mund- og kæbekirurgisk amb. (Esbjerg)",
            "healthInstitutionSorId":8041000016000,
            "parentSorId":246071000016007
        },
        {
            "sorId":246081000016009,
            "from":"2019-04-16",
            "name":"SVS Tand- Mund- og Kæbekirurgisk afsnit (Esbjerg)",
            "healthInstitutionSorId":8041000016000,
            "parentSorId":246061000016002
        }
    ]
}


BRSMapShakToSor

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"BRSMapShakToSor\", \"shakId\": \"5501\" }" http://test1.ekstern-test.nspop.dk:8080/sores/
No Format
HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Transfer-Encoding: chunked
Content-Type: text/plain;charset=utf-8
Date: Tue, 24 Mar 2020 14:39:37 GMT


{
    "5501":[
        {
            "sorId":245601000016003,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245531000016006,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245271000016006,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245011000016008,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246271000016001,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244461000016003,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245931000016001,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245141000016005,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":618861000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246331000016007,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245731000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246221000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":320651000016001,
            "from":"2019-04-16",
            "healthInstitutionSorId":22232009
        },
        {
            "sorId":246291000016002,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244851000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244811000016003,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245451000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244721000016002,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244591000016008,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246531000016001,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244681000016007,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245221000016007,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245581000016005,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246571000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245851000016003,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245891000016009,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246251000016008,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245401000016001,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245771000016002,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":8041000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245641000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":618901000016009,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":618911000016006,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246311000016001,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":244441000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245501000016002,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246361000016004,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246091000016006,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":318611000016008,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246321000016005,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246191000016005,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246061000016002,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246231000016003,
            "from":"2019-04-16",
            "healthInstitutionSorId":22232009
        },
        {
            "sorId":390631000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":245511000016000,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        },
        {
            "sorId":246551000016006,
            "from":"2019-12-20",
            "healthInstitutionSorId":8041000016000
        }
    ]
}