Pensjon Samordningspliktige Hendelser

API change history

Tilkobling:

For å kunne benytte tjenesten må konsumenten være autentisert via ID-Porten til Difi etter avtale med NAV. I autentiseringen mot ID-porten må _scope spesifiseres til å være nav:pensjon/v1/samordning.

hendelserUsingGET

Endepunktet returnerer en feed som inneholder hendelser tilhørende det angitte tjenestepensjonsnummeret.

Feeden benytter paginering, som deler opp feeden i sider basert på angitt antall hendelser per side. Hver side inneholder en liste med hendelser, samt en nextUrl som peker til neste side av feeden.

Siste side er nådd når nextUrl er null.

Hver hendelse har et sekvensnummer som inkrementeres for hver ny hendelse. Sekvensnummer kan angis for å kun hente nye hendelser fra og med dette sekvensnummeret.

Try it

Request

Request URL

Request parameters

  • string

    Tjenestepensjonsnummer som vedtaket tilhører.

  • (optional)
    integer

    Format - int32. Format - int32. Start innlesningen fra dette sekvensnummeret.

  • (optional)
    integer

    Format - int32. Format - int32. Antall hendelser per side (maksimalt 10000).

  • (optional)
    integer

    Format - int32. Format - int32. Sidenummer.

Request headers

  • string

    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.

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

Request body

Responses

200 OK

OK

Representations

{
  "hendelser": [
    {
      "identifikator": "string",
      "fom": "string",
      "tom": "string",
      "vedtakId": "string",
      "ytelsesType": "string"
    }
  ],
  "nextUrl": "string"
}
{
  "title": "Feed",
  "type": "object",
  "properties": {
    "hendelser": {
      "description": "Liste av hendelser.",
      "type": "array",
      "items": {
        "title": "Hendelse",
        "type": "object",
        "properties": {
          "identifikator": {
            "description": "Identifiserer hvilken hendelse.",
            "type": "string"
          },
          "fom": {
            "description": "Dato fra og med.",
            "type": "string",
            "format": "date"
          },
          "tom": {
            "description": "Dato til og med.",
            "type": "string",
            "format": "date"
          },
          "vedtakId": {
            "description": "Identifiserer hvilket vedtak.",
            "type": "string"
          },
          "ytelsesType": {
            "description": "Type ytelse.",
            "type": "string"
          }
        }
      }
    },
    "nextUrl": {
      "description": "URL for å hente neste pagineringsside.",
      "type": "string"
    }
  }
}

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

Code samples

@ECHO OFF

curl -v -X GET "https://api-preprod.nav.no/pensjon/v1/samordning/hendelser?tpnr={tpnr}?sekvensnummer=1&antall=10000&side=0"
-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["sekvensnummer"] = "1";
            queryString["antall"] = "10000";
            queryString["side"] = "0";
            var uri = "https://api-preprod.nav.no/pensjon/v1/samordning/hendelser?tpnr={tpnr}&" + 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/samordning/hendelser?tpnr={tpnr}");

            builder.setParameter("sekvensnummer", "1");
            builder.setParameter("antall", "10000");
            builder.setParameter("side", "0");

            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
            "sekvensnummer": "1",
            "antall": "10000",
            "side": "0",
        };
      
        $.ajax({
            url: "https://api-preprod.nav.no/pensjon/v1/samordning/hendelser?tpnr={tpnr}&" + $.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-preprod.nav.no/pensjon/v1/samordning/hendelser?tpnr={tpnr}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sekvensnummer=1",
                         @"antall=10000",
                         @"side=0",
                      ];
    
    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-preprod.nav.no/pensjon/v1/samordning/hendelser?tpnr={tpnr}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sekvensnummer' => '1',
    'antall' => '10000',
    'side' => '0',
);

$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
    'sekvensnummer': '1',
    'antall': '10000',
    'side': '0',
})

try:
    conn = httplib.HTTPSConnection('api-preprod.nav.no')
    conn.request("GET", "/pensjon/v1/samordning/hendelser?tpnr={tpnr}&%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
    'sekvensnummer': '1',
    'antall': '10000',
    'side': '0',
})

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

query = URI.encode_www_form({
    # Request parameters
    'sekvensnummer' => '1',
    'antall' => '10000',
    'side' => '0'
})
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