Arbeid Arbeidsavklaringspenger

API change history

API for å finne vedtak og meldekort for NAV-brukere som mottar Arbeidsavklaringspenger (AAP).

Påkrevd scope-verdi for bruk av API'et er nav:arbeid/v1/aap.

Altinn tjenestekode og tjenesteutgavekode er 5252_X, hvor X er 1 eller større.

Klikk her for begrepsforklaringer og kodeverksbeskrivelser.

Finn alle meldekort tilknyttet AAP-vedtak for en NAV-bruker i spesifisert tidsperiode.

Operasjonen henter en liste av leverte meldekort tilknyttet AAP-vedtakene for en NAV-bruker. Oppslag er på fødselsnummer. Kun meldekort for AAP-vedtak som er iverksatt (løpende) eller avsluttet vil bli returnert. Dersom ingen vedtak tilfredstiller uttrekkskriteriene, ingen meldekort er levert eller NAV-brukeren ikke finnes i fagsystemet, vil en tom meldekortliste bli returnert.

Operasjonen kan filtrere på perioden som meldekortene dekker ved å spesifisere fra-og-med- og til-og-med-datoer i input (fomDato/tomDato). Reglene for hvilke meldekortdata som returneres, er som følger.

  • Ingen data som ligger utenfor samtykkeperioden vil bli returnert.
  • Dersom ikke fomDato og/eller tomDato er spesifisert, vil operasjonen i stedet bruke samtykkeperiodens start- og/eller sluttdato.
  • Dersom fomDato er spesifisert og et meldekort dekker denne datoen, vil hele meldekortet bli returnert, eventuelt avgrenset til starten på samtykkeperioden.
  • Dersom tomDato er spesifisert og et meldekort dekker denne datoen, vil hele meldekortet bli returnert, eventuelt avgrenset til slutten på samtykkeperioden.
  • Dersom fomDato og/eller tomDato er spesifisert, men ligger utenfor samtykkeperioden, vil en 403-feil (ikke tilgang) bli returnert.

Tidligste meldekort tilknyttet AAP-vedtak som kan returneres er 01.03.2010.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - date (as full-date in RFC3339). Fra-og-med-dato på ISO-8601 format for meldekort som ønskes returnert. Dersom parameteren ikke er spesifisert, brukes samtykkeperiodens startdato.

  • (optional)
    string

    Format - date (as full-date in RFC3339). Til-og-med-dato på ISO-8601 format for meldekort som ønskes returnert. Dersom parameteren ikke er spesifisert, brukes samtykkeperiodens sluttdato.

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.

  • string

    Format - byte. Base64-kodet JWT-samtykketoken utstedt av Altinn.

  • string

    Fødselsnummer til NAV-brukeren som det spørres på.

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

Request body

Responses

200 OK

Returnerer leverte meldekort tilknyttet brukers AAP-vedtak. Returneres også dersom NAV-brukeren ikke finnes i fagsystemet.

Representations

{
  "uttrekksperiode": {
    "fomDato": "string",
    "tomDato": "string"
  },
  "meldekortliste": [
    {
      "meldekortId": 0,
      "periode": {
        "fomDato": "string",
        "tomDato": "string"
      },
      "antallTimerArbeidet": 0.0
    }
  ]
}
{
  "title": "MeldekortResponse",
  "type": "object",
  "properties": {
    "uttrekksperiode": {
      "title": "Periode",
      "description": "Representerer en tidsperiode gitt ved en fra-og-med-dato og en valgfri til-og-med-dato.",
      "type": "object",
      "properties": {
        "fomDato": {
          "description": "Fra-og-med-dato for perioden.",
          "type": "string",
          "format": "date"
        },
        "tomDato": {
          "description": "Til-og-med-dato for perioden.",
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "fomDato"
      ]
    },
    "meldekortliste": {
      "type": "array",
      "items": {
        "title": "Meldekort",
        "description": "Data for et levert meldekort.",
        "type": "object",
        "properties": {
          "meldekortId": {
            "description": "Unik identifikator på meldekortet.",
            "type": "integer",
            "format": "int32"
          },
          "periode": {
            "title": "Periode",
            "description": "Representerer en tidsperiode gitt ved en fra-og-med-dato og en valgfri til-og-med-dato.",
            "type": "object",
            "properties": {
              "fomDato": {
                "description": "Fra-og-med-dato for perioden.",
                "type": "string",
                "format": "date"
              },
              "tomDato": {
                "description": "Til-og-med-dato for perioden.",
                "type": "string",
                "format": "date"
              }
            },
            "required": [
              "fomDato"
            ]
          },
          "antallTimerArbeidet": {
            "description": "Antall timer med arbeid ført på meldekortet samlet for returnert meldekortperiode.",
            "type": "number",
            "format": "double"
          }
        }
      }
    }
  },
  "required": [
    "meldekortliste"
  ]
}

400 Bad Request

Ugyldig input i forespørselen.

Representations

{
  "timestamp": "string",
  "status": 0,
  "message": "string",
  "method": "string",
  "path": "string",
  "correlationId": "string"
}
{
  "title": "ApiError",
  "description": "Feilinformasjon som normalt blir returnert ved HTTP status 4xx og 5xx.",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Tidspunktet feilen oppstod. Formatet er yyyy-MM-ddTHH:mm:ss.SSSZ.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Inneholder HTTP statuskoden som ble returnert.",
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "description": "Tekst som beskriver feilen som oppstod.",
      "type": "string"
    },
    "method": {
      "description": "HTTP-metoden i API-kallet. (Normalt GET.)",
      "type": "string"
    },
    "path": {
      "description": "Request URI til operasjonen som ble kalt.",
      "type": "string"
    },
    "correlationId": {
      "description": "Korrelasjon ID som kan oppgis som referanse ved feil fra API-kallet.",
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "message"
  ]
}

401 Unauthorized

Konsumenten mangler gyldig aksesstoken.

Representations

{
  "timestamp": "string",
  "status": 0,
  "message": "string",
  "method": "string",
  "path": "string",
  "correlationId": "string"
}
{
  "title": "ApiError",
  "description": "Feilinformasjon som normalt blir returnert ved HTTP status 4xx og 5xx.",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Tidspunktet feilen oppstod. Formatet er yyyy-MM-ddTHH:mm:ss.SSSZ.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Inneholder HTTP statuskoden som ble returnert.",
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "description": "Tekst som beskriver feilen som oppstod.",
      "type": "string"
    },
    "method": {
      "description": "HTTP-metoden i API-kallet. (Normalt GET.)",
      "type": "string"
    },
    "path": {
      "description": "Request URI til operasjonen som ble kalt.",
      "type": "string"
    },
    "correlationId": {
      "description": "Korrelasjon ID som kan oppgis som referanse ved feil fra API-kallet.",
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "message"
  ]
}

403 Forbidden

Konsumenten har ikke tilgang til meldekortinformasjon. Situasjoner som kan gi feilen er som følger.

  • Scope til aksesstokenet gir ikke tilgang til meldekortdata.
  • Konsumenten mangler gyldig samtykketoken.
  • Samtykketokenet er ikke utstedt av altinn.no (iss).
  • Samtykket har passert utløpstidspunktet (ValidToDate).
  • Organisasjonsnummer som samtykket er i gitt til er ikke i overensstemmelse med organisasjonsnummeret som aksesstokenet er utstedt til.
  • Fødselsnummeret som har gitt samtykket er ikke i overensstemmelse med fødselsnummeret det spørres på.
  • Forespurt periode ligger utenfor samtykkeperioden.

Representations

{
  "timestamp": "string",
  "status": 0,
  "message": "string",
  "method": "string",
  "path": "string",
  "correlationId": "string"
}
{
  "title": "ApiError",
  "description": "Feilinformasjon som normalt blir returnert ved HTTP status 4xx og 5xx.",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Tidspunktet feilen oppstod. Formatet er yyyy-MM-ddTHH:mm:ss.SSSZ.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Inneholder HTTP statuskoden som ble returnert.",
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "description": "Tekst som beskriver feilen som oppstod.",
      "type": "string"
    },
    "method": {
      "description": "HTTP-metoden i API-kallet. (Normalt GET.)",
      "type": "string"
    },
    "path": {
      "description": "Request URI til operasjonen som ble kalt.",
      "type": "string"
    },
    "correlationId": {
      "description": "Korrelasjon ID som kan oppgis som referanse ved feil fra API-kallet.",
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "message"
  ]
}

500 Internal Server Error

Intern feil i tjenesten.

Representations

{
  "timestamp": "string",
  "status": 0,
  "message": "string",
  "method": "string",
  "path": "string",
  "correlationId": "string"
}
{
  "title": "ApiError",
  "description": "Feilinformasjon som normalt blir returnert ved HTTP status 4xx og 5xx.",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Tidspunktet feilen oppstod. Formatet er yyyy-MM-ddTHH:mm:ss.SSSZ.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Inneholder HTTP statuskoden som ble returnert.",
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "description": "Tekst som beskriver feilen som oppstod.",
      "type": "string"
    },
    "method": {
      "description": "HTTP-metoden i API-kallet. (Normalt GET.)",
      "type": "string"
    },
    "path": {
      "description": "Request URI til operasjonen som ble kalt.",
      "type": "string"
    },
    "correlationId": {
      "description": "Korrelasjon ID som kan oppgis som referanse ved feil fra API-kallet.",
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "message"
  ]
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.nav.no/arbeid/v1/aap/meldekort?fomDato={string}&tomDato={string}"
-H "Authorization: "
-H "NAV-Samtykke-Token: "
-H "NAV-PersonIdent: "
-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-Samtykke-Token", "");
            client.DefaultRequestHeaders.Add("NAV-PersonIdent", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

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

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

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

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'fomDato' => '{string}',
    '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': '',
    'NAV-Samtykke-Token': '',
    'NAV-PersonIdent': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

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

try:
    conn = httplib.HTTPSConnection('api.nav.no')
    conn.request("GET", "/arbeid/v1/aap/meldekort?%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-Samtykke-Token': '',
    'NAV-PersonIdent': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

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

try:
    conn = http.client.HTTPSConnection('api.nav.no')
    conn.request("GET", "/arbeid/v1/aap/meldekort?%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/arbeid/v1/aap/meldekort')

query = URI.encode_www_form({
    # Request parameters
    'fomDato' => '{string}',
    '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['NAV-Samtykke-Token'] = ''
# Request headers
request['NAV-PersonIdent'] = ''
# 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