Helse Trygdehendelser
API change historyTilkobling:
For å kunne benytte tjeneste må konsumenten være autentisert via ID-Porten til Difi etter avtale med NAV. For å kunne bruke tjenesten må scope spesifiseres i autentiseringen mot ID-porten til å være: nav:helse/v1/trygdehendelser
.
Tjenesten:
Tjenesten tillater konsumenter å hente ut hendelser om personer relatert til medlemskap i folketrygden ved at konsumenter spesifiserer fra hvilket hendelsesnummer de ønsker å motta meldinger, og hvor mange de ønsker(maksimalt 100 per forespørsel). Hendelsene kan filtreres ved at konsument oppgir hvilken hjemmelgruppe som ønskes.
Request
Request URL
Request parameters
-
integer
Format - int64. Hendelsesnummer man ønsker å hente fra og med.
-
(optional)integer
Format - int32. Antall hendelser konsument ønsker å hente ut etter innsendt hendelsesnummer.
-
(optional)string
Filter for hjemmelgruppe, der "ALLE" inkluderer både "OEVRIGE" og "EOS".
Request headers
-
string
Format - byte. Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av ID-Porten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.
Request body
Responses
200 OK
OK
Representations
{
"antallHendelser": 0,
"hendelser": [
{
"hendelsesnummer": 0,
"innhold": {
"periodeId": 0,
"personident": "string"
},
"metadata": {
"hjemmelgruppe": "EOS",
"opprettetDato": "string"
},
"type": "OPPRETTET"
}
],
"totaltAntallHendelser": 0
}
{
"type": "object",
"properties": {
"antallHendelser": {
"type": "integer",
"format": "int32",
"description": "Antall hendelser i listen \"hendelser\"."
},
"hendelser": {
"type": "array",
"description": "Liste med hendelser basert på request.",
"items": {
"type": "object",
"properties": {
"hendelsesnummer": {
"type": "integer",
"format": "int64",
"description": "Hendelsens sekvensnummer."
},
"innhold": {
"description": "En hendelses sentrale innhold",
"type": "object",
"properties": {
"periodeId": {
"type": "integer",
"format": "int64",
"description": "Identifikator for medlemskapsperioden hendelsen gjelder. Brukes ved oppslag i Medlemskapsregisteret."
},
"personident": {
"type": "string",
"description": "FNR/DNR som hendelsen gjelder."
}
},
"title": "Innhold"
},
"metadata": {
"description": "Beskrivelse av en hendelse.",
"type": "object",
"properties": {
"hjemmelgruppe": {
"type": "string",
"description": "Hvilken hjemmelgruppe hendelsene tilhører.",
"enum": [
"EOS",
"OEVRIGE",
"ALLE"
]
},
"opprettetDato": {
"type": "string",
"format": "date-time",
"description": "Tidsstempel da hendelsen ble motatt fra Medlemskapsregisteret."
}
},
"title": "Metadata"
},
"type": {
"type": "string",
"description": "Beskriver hva hendelsen omhandler, eksempelvis melding om endring/oppretting/avsluttning av en medlemskapsperiode.",
"enum": [
"OPPRETTET",
"ENDRET",
"ANNULLERT"
]
}
},
"title": "Hendelse",
"description": "Beskrivelse av èn enkelthendelse."
}
},
"totaltAntallHendelser": {
"type": "integer",
"format": "int64",
"description": "Totalt antall tilgjengelige hendelser som tilfredsstiller requesten."
}
},
"title": "Trygdehendelse",
"description": "Responsen fra GET /api/v1/hendelser"
}
401 Unauthorized
Unauthorized
Representations
403 Forbidden
Forbidden
Representations
404 Not Found
Not Found
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}?antallHendelser=1&hjemmelgruppe=EOS"
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["antallHendelser"] = "1";
queryString["hjemmelgruppe"] = "EOS";
var uri = "https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}&" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}");
builder.setParameter("antallHendelser", "1");
builder.setParameter("hjemmelgruppe", "EOS");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"antallHendelser": "1",
"hjemmelgruppe": "EOS",
};
$.ajax({
url: "https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"antallHendelser=1",
@"hjemmelgruppe=EOS",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'antallHendelser' => '1',
'hjemmelgruppe' => 'EOS',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'antallHendelser': '1',
'hjemmelgruppe': 'EOS',
})
try:
conn = httplib.HTTPSConnection('api.nav.no')
conn.request("GET", "/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'antallHendelser': '1',
'hjemmelgruppe': 'EOS',
})
try:
conn = http.client.HTTPSConnection('api.nav.no')
conn.request("GET", "/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api.nav.no/helse/v1/trygdehendelser/hendelser?hendelsesnummer={hendelsesnummer}')
query = URI.encode_www_form({
# Request parameters
'antallHendelser' => '1',
'hjemmelgruppe' => 'EOS'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body