Bidragskrav - Q2
API change historyGrensesnitt for overføring av krav/transaksjoner mellom bidragsområdet og Elin/Navi.
Request
Request URL
Request headers
Request body
Responses
400 Bad Request
Dersom én av konteringene ikke går gjennom validering forkastes alle konteringene i kravet og en liste over konteringer som har feilet returneres, sammen med informasjon om hva som er feil.
Det er ingen garanti for at konteringer som ikke kommer med på listen over feilede konteringer er feilfrie.
Representations
{
"type": "object",
"properties": {
"konteringsfeil": {
"type": "array",
"items": {
"type": "object",
"properties": {
"feilkode": {
"type": "string",
"description": "En kode som angir type feil som har oppstått. Feilkoden er ment å kunne brukes til å maskinelt sortere feil.",
"example": "TOLKNING"
},
"feilmelding": {
"type": "string",
"description": "En beskrivelse av feilen som har oppstått. Feilmeldingen er ment å være forståelig for et menneske ved manuell gjennomgang.",
"example": "Tolkning feilet i Elin."
},
"kontering": {
"required": [
"delytelsesId",
"periode",
"transaksjonskode"
],
"type": "object",
"properties": {
"transaksjonskode": {
"type": "string",
"description": "Type transaksjon.",
"example": "B1"
},
"periode": {
"type": "string",
"description": "Angir hvilken periode (måned og år) konteringen gjelder.",
"format": "yyyy-mm",
"example": "2022-04"
},
"delytelsesId": {
"type": "string",
"description": "Unik referanse til perioden i vedtaket. I bidragssaken kan en periode strekke over flere måneder, og samme referanse blir da benyttet for alle månedene. Samme referanse kan ikke benyttes to ganger for samme transaksjonskode i samme måned.",
"example": "123456789"
}
},
"description": "Identifiserer en kontering unikt."
}
},
"description": "Beskriver feil i en enkelt kontering."
}
}
},
"description": "Lister feil i et krav."
}200 OK
Tjenesten er OK.
Representations
401 Unauthorized
Dersom klienten ikke er autentisert.
Representations
{
"feilkode": "TOKEN_MANGLER",
"feilmelding": "Fant ingen token i requesten."
}{
"required": [
"feilkode",
"feilmelding"
],
"type": "object",
"properties": {
"feilkode": {
"type": "string",
"description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
"example": "UGYLDIG_TOKEN"
},
"feilmelding": {
"type": "string",
"description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
"example": "Token utløp 2022-11-01 10:00:00"
}
},
"description": "Et kall har ført til feilmelding."
}403 Forbidden
Dersom klienten ikke har tilgang.
Representations
{
"feilkode": "INGEN_TILGANG",
"feilmelding": "Ingen tilgang med vedlagte token"
}{
"required": [
"feilkode",
"feilmelding"
],
"type": "object",
"properties": {
"feilkode": {
"type": "string",
"description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
"example": "UGYLDIG_TOKEN"
},
"feilmelding": {
"type": "string",
"description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
"example": "Token utløp 2022-11-01 10:00:00"
}
},
"description": "Et kall har ført til feilmelding."
}500 Internal Server Error
Ukjent feil. Tjenesten er ikke OK.
Representations
{
"feilkode": "UKJENT_FEIL",
"feilmelding": "Intern feil"
}{
"required": [
"feilkode",
"feilmelding"
],
"type": "object",
"properties": {
"feilkode": {
"type": "string",
"description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
"example": "UGYLDIG_TOKEN"
},
"feilmelding": {
"type": "string",
"description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
"example": "Token utløp 2022-11-01 10:00:00"
}
},
"description": "Et kall har ført til feilmelding."
}503 Service Unavailable
Service unavailable - Påløpsmodus er på.
Representations
{
"feilkode": "VEDLIKEHOLD_MODUS",
"feilmelding": "Tjenesten er utilgjengelig under vedlikehold"
}{
"required": [
"feilkode",
"feilmelding"
],
"type": "object",
"properties": {
"feilkode": {
"type": "string",
"description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
"example": "UGYLDIG_TOKEN"
},
"feilmelding": {
"type": "string",
"description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
"example": "Token utløp 2022-11-01 10:00:00"
}
},
"description": "Et kall har ført til feilmelding."
}Code samples
@ECHO OFF
curl -v -X GET "https://api-preprod.nav.no/bidrag/v1/bidragskravq2/api/liveness"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api-preprod.nav.no/bidrag/v1/bidragskravq2/api/liveness?" + 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/bidrag/v1/bidragskravq2/api/liveness");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
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
};
$.ajax({
url: "https://api-preprod.nav.no/bidrag/v1/bidragskravq2/api/liveness?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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/bidrag/v1/bidragskravq2/api/liveness";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_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/bidrag/v1/bidragskravq2/api/liveness');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api-preprod.nav.no')
conn.request("GET", "/bidrag/v1/bidragskravq2/api/liveness?%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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api-preprod.nav.no')
conn.request("GET", "/bidrag/v1/bidragskravq2/api/liveness?%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/bidrag/v1/bidragskravq2/api/liveness')
request = Net::HTTP::Get.new(uri.request_uri)
# 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