Versions Compared

Key

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

...

Operation

Parametre

Beskrivelse
GetSorEntitySorIds: 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.
SearchAllChildrenSorIds: 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.
MapShakToSorShakId: 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.
GetSorEntityByProviderProviderIds: 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*
IsSorEntityDescendantOfSorEntitySorIdAndParentSorIdPairs: 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

Returner array med resultaterne fra de forskellige operationer i den rækkefølge som de er komme i. 


Eksempler

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

...

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"SearchAllChildren\", \"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: application/json;charset=utf-8


{
    "246061000016002":[
        {
            "sorId":246071000016007,
            "from":"2020-06-16",
            "name":"SVS Kæbekirurgisk ambulatorium (Esbjerg)",
            "institutionOwnerSorId":6101000016001,
            "healthInstitutionSorId":8041000016000,
            "shakId":"550108T",
            "parentSorId":246061000016002
        },
        {
            "sorId":452041000016004,
            "from":"2020-06-16",
            "name":"SVS kæbekirurgisk amb. (Esbjerg)",
            "institutionOwnerSorId":6101000016001,
            "healthInstitutionSorId":8041000016000,
            "shakId":"550108T",
            "parentSorId":246071000016007
        },
        {
            "sorId":246081000016009,
            "from":"2020-06-16",
            "name":"SVS Kæbekirurgisk afsnit (Esbjerg)",
            "institutionOwnerSorId":6101000016001,
            "healthInstitutionSorId":8041000016000,
            "shakId":"5501081",
            "parentSorId":246061000016002
        }
    ]
}

...

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"InstitutionOwnerCvrNumberByShak\", \"shakIds\": [ \"1301\", \"6610123\", \"9999\" ] }" 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: application/json;charset=utf-8


{
    "1301":"29190623",
    "6610123":"29190925",
    "9999":""
}

BatchedOperations (v1 og v2)

Expand
titlecurl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"BatchedOperations\", \"operations\": [ ... ] }" http://test1.ekstern-test.nspop.dk:8080/sores/
No Format
curl -i -X POST -H "Content-Type: application/json" -d "{\"op\": \"BatchedOperations\", \"operations\": [ 
	{\"op\": \"InstitutionOwnerCvrNumberByShak\", \"shakIds\": [ \"1301\", \"6610123\", \"9999\" ] },
	{\"op\": \"GetSorEntity\", \"sorIds\": [ \"8041000016000\", \"6101000016001\", \"91331000016003\" ] }, 
	{\"op\": \"GetSorEntityByProvider\", \"providerIds\": [ \"303712\" ] },
	{\"op\": \"SearchAllChildren\", \"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: application/json;charset=utf-8

{
    "BatchedOperations":[
        {
		    "1301":"29190623",
   			"6610123":"29190925",
    		"9999":""
		},
		{
    		"8041000016000":{
        		"sorId":8041000016000,
        		"from":"2016-10-18",
        		"name":"Sydvestjysk Sygehus",
        		"institutionOwnerSorId":6101000016001,
        		"healthInstitutionSorId":8041000016000,
        		"shakId":"5501",
        		"parentSorId":6101000016001
    		},
    		"6101000016001":{
        		"sorId":6101000016001,
        		"from":"2015-07-30",
        		"name":"Region Syddanmark",
        		"institutionOwnerSorId":6101000016001
    		},
    		"91331000016003":{
        		"sorId":91331000016003,
        		"from":"2012-10-12",
        		"name":"Jørn Bøgh ApS",
        		"institutionOwnerSorId":91311000016009,
        		"healthInstitutionSorId":91321000016000,
        		"providerId":"097926",
        		"shakId":"7034010",
        		"parentSorId":91321000016000
    		}
		},
		{
    		"303712":[
       			{
            		"sorId":709251000016004,
            		"from":"2018-08-18",
            		"name":"Fodterapeut Mette Nielsen",
            		"healthInstitutionSorId":399351000016009,
             		 "providerId":"303712",
             		 "parentSorId":399351000016009
         		},
         		{
             		 "sorId":842311000016008,
            		 "from":"2018-08-18",
             		 "name":"Hanne Møller-San Pedro",
             		 "healthInstitutionSorId":842301000016006,
             		 "providerId":"303712",
            		 "parentSorId":842301000016006
         		},
         		{
             		 "sorId":701371000016004,
             		 "from":"2018-08-18",
             		 "name":"Annette Steen Nielsen",
             		 "healthInstitutionSorId":701361000016009,
 		             "providerId":"303712",
          		     "parentSorId":701361000016009
 		        }
 		     ]
 		},
	    {
    		"246061000016002":[
        		{
            		 "sorId":246071000016007,
             		 "from":"2020-06-16",
       		       	 "name":"SVS Kæbekirurgisk ambulatorium (Esbjerg)",
      		         "healthInstitutionSorId":8041000016000,
     		         "shakId":"550108T",
     		         "parentSorId":246061000016002
    		    },
     		    {
    		         "sorId":452041000016004,
    		         "from":"2020-06-16",
   		             "name":"SVS kæbekirurgisk amb. (Esbjerg)",
   		             "healthInstitutionSorId":8041000016000,
   		             "shakId":"550108T",
    		         "parentSorId":246071000016007
     		    },
      		    {
     		         "sorId":246081000016009,
     		         "from":"2020-06-16",
      		         "name":"SVS Kæbekirurgisk afsnit (Esbjerg)",
      		         "healthInstitutionSorId":8041000016000,
       		         "shakId":"5501081",
        		     "parentSorId":246061000016002
       		    }
     		 ]
 		 }
    ]
}