Medlemskap Medlemskapsunntak
API change historyTilkobling:
For å kunne benytte tjenesten må konsumenten være autorisert i Maskinporten etter avtale med NAV. Scopet på access tokenet fra Maskinporten må være: nav:medlemskap/v1/medlemskapsunntak.
Tjenesten:
Tjenesten tillater konsumenter å hente perioder som beskriver unntak fra hovedregelen om personers medlemskap i den norske folketrygden. Avhengig av hvilket endepunkt man bruker gjør man dette ved å spesifisere en naturlig ident (D- eller fødselsnummer), eller den funksjonelle ID'en til et konkret medlemskapsunntak.
Henter ut informasjon om et spesifikt medlemskapsunntak
Henter ut informasjon om et spesifikt medlemskapsunntak
Try itRequest
Request URL
Request parameters
-
integer
Format - int64. Den funksjonelle ID'en til perioden man ønsker å hente.
-
(optional)boolean
Hvorvidt man er interessert i å se sporingsinformasjonen som er registrert på perioden.
Request headers
-
string
Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten. Verdien må starte med "Bearer ", etterfulgt av tokenet.
-
string
En identifikator for denne kallrekken som kan brukes i debugging dersom en feil skulle oppstå.
-
string
Navnet på servicebrukeren til applikasjonen som gjør kallet - for eksempel "hdir".
Request body
Responses
200 OK
OK
Representations
{
"dekning": "string",
"fraOgMed": "string",
"grunnlag": "string",
"helsedel": true,
"ident": "string",
"lovvalg": "string",
"lovvalgsland": "string",
"medlem": true,
"sporingsinformasjon": {
"besluttet": "string",
"kilde": "string",
"kildedokument": "string",
"opprettet": "string",
"opprettetAv": "string",
"registrert": "string",
"sistEndret": "string",
"sistEndretAv": "string",
"versjon": 0
},
"status": "string",
"statusaarsak": "string",
"studieinformasjon": {
"delstudie": true,
"soeknadInnvilget": true,
"statsborgerland": "string",
"studieland": "string"
},
"tilOgMed": "string",
"unntakId": 0
}{
"type": "object",
"required": [
"fraOgMed",
"grunnlag",
"helsedel",
"ident",
"lovvalg",
"medlem",
"status",
"tilOgMed",
"unntakId"
],
"properties": {
"dekning": {
"type": "string",
"description": "Dekningsgraden for dette medlemskapsunntaket."
},
"fraOgMed": {
"type": "string",
"format": "date",
"description": "Startdatoen for perioden til medlemskapsunntaket, på ISO-8601 format."
},
"grunnlag": {
"type": "string",
"description": "Grunnlaget for dette medlemskapsunntaket."
},
"helsedel": {
"type": "boolean",
"description": "Hvorvidt dekningen for medlemskapsunntaket har en helsedel."
},
"ident": {
"type": "string",
"description": "Den naturlige identen som medlemskapsunntaket er lagret på."
},
"lovvalg": {
"type": "string",
"description": "Lovvalget for dette medlemskapsunntaket."
},
"lovvalgsland": {
"type": "string",
"description": "Landet dette medlemskapsunntaket gjelder for."
},
"medlem": {
"type": "boolean",
"description": "Beskriver hvorvidt dette medlemskapsunntaket handler om et medlemskap i folketrygden eller ikke."
},
"sporingsinformasjon": {
"description": "Metadata knyttet til medlemskapsunntaket.",
"type": "object",
"required": [
"kilde",
"opprettet",
"opprettetAv",
"sistEndret",
"sistEndretAv",
"versjon"
],
"properties": {
"besluttet": {
"type": "string",
"format": "date",
"description": "Når det ble tatt en beslutning om dette medlemskapsunntaket, på ISO-8601-format."
},
"kilde": {
"type": "string",
"description": "Hvilket system medlemskapsunntaket kommer fra."
},
"kildedokument": {
"type": "string",
"description": "I hvilken form søknaden om medlemskapsunntak kom til kilden."
},
"opprettet": {
"type": "string",
"format": "date-time",
"description": "Når medlemskapsunntaket ble opprettet, på ISO-8601-format."
},
"opprettetAv": {
"type": "string",
"description": "Hvem eller hva som opprettet medlemskapsunntaket."
},
"registrert": {
"type": "string",
"format": "date",
"description": "Når dette medlemskapsunntaket ble registrert, på ISO-8601-format."
},
"sistEndret": {
"type": "string",
"format": "date-time",
"description": "Når medlemskapsunntaket sist ble endret, på ISO-8601-format."
},
"sistEndretAv": {
"type": "string",
"description": "Hvem eller hva som sist endret medlemskapsunntaket."
},
"versjon": {
"type": "integer",
"format": "int32",
"description": "Versjonsnummeret på dette medlemskapsunntaket. Dette sier noe om hvor mange ganger unntaket har blitt endret."
}
},
"title": "Sporingsinformasjon"
},
"status": {
"type": "string",
"description": "Sluttdatoen for perioden til medlemskapsunntaket."
},
"statusaarsak": {
"type": "string",
"description": "Dersom statusen på medlemskapsunntaket ikke er gyldig vil dette feltet beskrive hvorfor."
},
"studieinformasjon": {
"description": "Studieinformasjonen som er registrert på et medlemskapsunntak.",
"type": "object",
"required": [
"delstudie",
"soeknadInnvilget",
"statsborgerland"
],
"properties": {
"delstudie": {
"type": "boolean",
"description": "Hvorvidt studenten er deltidsstudent."
},
"soeknadInnvilget": {
"type": "boolean",
"description": "Om søknaden om studielån er blitt innvilget av Lånekassen."
},
"statsborgerland": {
"type": "string",
"description": "Hvilket land studenten er statsborger i."
},
"studieland": {
"type": "string",
"description": "Hvilket land studenten studerer i."
}
},
"title": "Studieinformasjon"
},
"tilOgMed": {
"type": "string",
"format": "date",
"description": "Sluttdatoen for perioden til medlemskapsunntaket, på ISO-8601 format.."
},
"unntakId": {
"type": "integer",
"format": "int64",
"description": "Den funksjonelle ID'en til et medlemskapsunntak."
}
},
"title": "Medlemskapsunntak",
"description": "Informasjonen som er tilgjengelig om et medlemskapsunntak."
}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/medlemskap/v1/medlemskapsunntak/{unntakId}?inkluderSporingsinfo=false"
-H "Authorization: "
-H "Nav-Call-Id: "
-H "Nav-Consumer-Id: "
-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("Nav-Call-Id", "");
client.DefaultRequestHeaders.Add("Nav-Consumer-Id", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["inkluderSporingsinfo"] = "false";
var uri = "https://api.nav.no/medlemskap/v1/medlemskapsunntak/{unntakId}?" + 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/medlemskap/v1/medlemskapsunntak/{unntakId}");
builder.setParameter("inkluderSporingsinfo", "false");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
request.setHeader("Nav-Call-Id", "");
request.setHeader("Nav-Consumer-Id", "");
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
"inkluderSporingsinfo": "false",
};
$.ajax({
url: "https://api.nav.no/medlemskap/v1/medlemskapsunntak/{unntakId}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Nav-Call-Id","");
xhrObj.setRequestHeader("Nav-Consumer-Id","");
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/medlemskap/v1/medlemskapsunntak/{unntakId}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"inkluderSporingsinfo=false",
];
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:@"" forHTTPHeaderField:@"Nav-Call-Id"];
[_request setValue:@"" forHTTPHeaderField:@"Nav-Consumer-Id"];
[_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/medlemskap/v1/medlemskapsunntak/{unntakId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Nav-Call-Id' => '',
'Nav-Consumer-Id' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'inkluderSporingsinfo' => 'false',
);
$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': '',
'Nav-Call-Id': '',
'Nav-Consumer-Id': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'inkluderSporingsinfo': 'false',
})
try:
conn = httplib.HTTPSConnection('api.nav.no')
conn.request("GET", "/medlemskap/v1/medlemskapsunntak/{unntakId}?%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': '',
'Nav-Call-Id': '',
'Nav-Consumer-Id': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'inkluderSporingsinfo': 'false',
})
try:
conn = http.client.HTTPSConnection('api.nav.no')
conn.request("GET", "/medlemskap/v1/medlemskapsunntak/{unntakId}?%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/medlemskap/v1/medlemskapsunntak/{unntakId}')
query = URI.encode_www_form({
# Request parameters
'inkluderSporingsinfo' => 'false'
})
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['Nav-Call-Id'] = ''
# Request headers
request['Nav-Consumer-Id'] = ''
# 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