Pensjon Ytelsehistorikk

API change history

For å kunne bruke tjenesten må scope i autentiseringen mot Maskinporten settes til nav:pensjon/v1/ytelsehistorikk.

Tjenesten returnerer nødvendig informasjonen om brukers ytelse.

hentYtelsehistorikk

Utleverer informasjon om en brukers ytelsehistorikk i en gitt periode.

Try it

Request

Request URL

Request parameters

  • string

    Format - date (as full-date in RFC3339). Dato i ISO-8601 format, uten klokkeslett. Angir fomDato for perioden man ønsker opplysninger for.

  • (optional)
    string

    Format - date (as full-date in RFC3339). Dato i ISO-8601 format, uten klokkeslett. Angir tomDato for perioden man ønsker opplysninger for.

Request headers

  • string

    Format - byte. Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.

  • string

    Brukers fnr/dnr.

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK

Representations

{
  "fnr": "string",
  "ytelser": [
    {
      "type": "string",
      "fomDato": "string",
      "tomDato": "string",
      "apenSoknad": true,
      "perioder": [
        {
          "eksportertYtelse": true,
          "uforegrad": 0,
          "uttaksgrad": 0,
          "fomDato": "string",
          "tomDato": "string",
          "minstepensjon": true,
          "tt_kap19": 0,
          "tt_kap20": 0,
          "prorata_nevner": 0,
          "prorata_teller": 0,
          "tt": 0
        }
      ]
    }
  ]
}
{
  "title": "hentYtelsehistorikkResponse",
  "type": "object",
  "properties": {
    "fnr": {
      "description": "Brukers fnr/dnr.",
      "type": "string"
    },
    "ytelser": {
      "description": "En liste over brukers ytelser. Dersom bruker ikke har noen ytelse returneres en tom liste.",
      "type": "array",
      "items": {
        "title": "Ytelse",
        "type": "object",
        "properties": {
          "type": {
            "description": "Saktypen for ytelsen.",
            "type": "string"
          },
          "fomDato": {
            "description": "Dato i ISO-8601 format, uten klokkeslett. Første virk for ytelsen.",
            "type": "string",
            "format": "date"
          },
          "tomDato": {
            "description": "Dato i ISO-8601 format, uten klokkeslett. Dagen før opphør av ytelsen.",
            "type": "string",
            "format": "date"
          },
          "apenSoknad": {
            "description": "Angir om det finnes et åpent krav av typen førstegangsbehandling.",
            "type": "boolean"
          },
          "perioder": {
            "description": "En liste over ytelseperioder som er gjeldende innenfor perioden i spørring.",
            "type": "array",
            "items": {
              "title": "Ytelseperiode",
              "type": "object",
              "properties": {
                "eksportertYtelse": {
                  "description": "Angir om ytelsen er eksportert i perioden. Påkrevd for alle typer ytelse, bortsett fra AFP_PRIVAT, GJENLEV og BARNEP.",
                  "type": "boolean"
                },
                "uforegrad": {
                  "description": "Brukers uføregrad for UP/UT.",
                  "type": "integer",
                  "format": "int32"
                },
                "uttaksgrad": {
                  "description": "Brukers uttaksgrad for alderspensjon. For AP67 settes alltid 100.",
                  "type": "integer",
                  "format": "int32"
                },
                "fomDato": {
                  "description": "Dato i ISO-8601 format, uten klokkeslett. FomDato til perioden.",
                  "type": "string",
                  "format": "date"
                },
                "tomDato": {
                  "description": "Dato i ISO-8601 format, uten klokkeslett. TomDato til perioden.",
                  "type": "string",
                  "format": "date"
                },
                "minstepensjon": {
                  "description": "Flagg fra beregning om bruker er minstepensjonist i perioden. Settes for ytelse av typen ALDER, UFOREP, AFP.",
                  "type": "boolean"
                },
                "tt_kap19": {
                  "description": "Kapittel 19 trygdetid brukt i beregning for AP2011 og AP2016.",
                  "type": "integer",
                  "format": "int32"
                },
                "tt_kap20": {
                  "description": "Kapittel 20 trygdetid brukt i beregning for AP2016 og AP2025.",
                  "type": "integer",
                  "format": "int32"
                },
                "prorata_nevner": {
                  "description": "Nevner for proratabrøk brukt i beregning for uføre. Må være satt hvis prorata_teller er satt.",
                  "type": "integer",
                  "format": "int32"
                },
                "prorata_teller": {
                  "description": "Teller for proratabrøk brukt i beregning for uføre. Må være satt hvis prorata_nevner er satt.",
                  "type": "integer",
                  "format": "int32"
                },
                "tt": {
                  "description": "Trygdetid brukt i beregning for AP67, UP, UT, AFP, FAM_PL.",
                  "type": "integer",
                  "format": "int32"
                }
              },
              "required": [
                "fomDato"
              ]
            }
          }
        },
        "required": [
          "type",
          "apenSoknad"
        ]
      }
    }
  },
  "required": [
    "fnr",
    "ytelser"
  ]
}

400 Bad Request

Ugyldig input i forespørselen.

Representations

401 Unauthorized

Ugyldig aksesstoken til tjenesten.

Representations

404 Not Found

Person ikke funnet.

Representations

500 Internal Server Error

Intern feil i tjenesten.

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}?tomDato={string}"
-H "Authorization: "
-H "fnr: "
-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("fnr", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["tomDato"] = "{string}";
            var uri = "https://api-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}&" + 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-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}");

            builder.setParameter("tomDato", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("fnr", "");
            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
            "tomDato": "{string}",
        };
      
        $.ajax({
            url: "https://api-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("fnr","");
                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-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"tomDato={string}",
                      ];
    
    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:@"fnr"];
    [_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-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'fnr' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'tomDato' => '{string}',
);

$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': '',
    'fnr': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'tomDato': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api-preprod.nav.no')
    conn.request("GET", "/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}&%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': '',
    'fnr': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'tomDato': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api-preprod.nav.no')
    conn.request("GET", "/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}&%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-preprod.nav.no/pensjon/v1/ytelsehistorikk/?fomDato={fomDato}')

query = URI.encode_www_form({
    # Request parameters
    'tomDato' => '{string}'
})
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['fnr'] = ''
# 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