{ "openapi": "3.0.1", "info": { "title": "Helserefusjon Frikort-brev", "description": "API for å hente Frikortvedtaksbrev. \n\nPåkrevd scope-verdi for bruk av API'et er `nav:helserefusjon/v1/frikort`.\n", "version": "1.0" }, "servers": [ { "url": "https://api.nav.no/helserefusjon/v1/frikort" } ], "paths": { "/brev": { "get": { "tags": [ "Brev" ], "summary": "hentBrev", "description": "Operasjonen henter en liste med frikortvedtaksbrev. Listen er populert med første brevId og påfølgende brev.", "operationId": "hentBrev", "parameters": [ { "name": "brevId", "in": "query", "description": "Format - int32. Første brevid det skal hentes på.", "schema": { "type": "integer" } }, { "name": "antall", "in": "query", "description": "Format - int32. Antall brev som skal returneres etter gitt id.", "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returnerer brevene som ble funnet.", "content": { "application/json;charset=UTF-8": { } } }, "400": { "description": "Ugyldig input i forespørselen.", "content": { "application/json;charset=UTF-8": { } } }, "401": { "description": "Konsumenten mangler gyldig aksesstoken.", "content": { "application/json;charset=UTF-8": { } } }, "500": { "description": "Intern feil i tjenesten.", "content": { "application/json;charset=UTF-8": { } } } } } }, "/brev/avstemming": { "post": { "tags": [ "Avstemming" ], "summary": "Avstem forventede brev for gitt dato.", "description": "Operasjonen gir svar på om avstemmingen er korrekt. I tillegg listes opp resultatet av avstemmingen til brevtypene som er sendt som parameter inn. Avstemmingen baserer seg på en gitt dato. Det må sendes inn et AvstemmingRequest på JSON-format. Et eksempel på AvstemmingRequest:
\"avstemmingsdato\": \"2020-01-15\",\"avstemmingsresultat\": null, \"avstemmingDataListDTO\": [{\"brevtype\": \"Frikortvedtak\", \"forventetAntallBrevAvHdir\": 200, \"forventetLavesteIdAvHdir\": 3200, \"forventetHoyesteIdAvHdir\": 4000, \"sistAvstemtId\": 3195, \"faktiskAntallBrev\": null, \"faktiskLavesteId\": null, \"faktiskHoyesteId\": null }]
",
"operationId": "avstemming",
"parameters": [
{
"name": "avstemmingRequest",
"in": "query",
"description": "Et avstemmingRequest-objekt som avstemmer på en gitt dato. Eksempel på et avstemmingRequest er vist over. Typisk vil det være flere brevtyper som listes opp.",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "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.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Returnerer resultatet av avstemmingen."
},
"400": {
"description": "Ugyldig input i forespørselen."
},
"401": {
"description": "Konsumenten mangler gyldig aksesstoken."
},
"500": {
"description": "Intern feil i tjenesten."
}
}
}
}
},
"components": {
"securitySchemes": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "subscription-key",
"in": "query"
}
}
},
"security": [
{
"apiKeyHeader": [ ]
},
{
"apiKeyQuery": [ ]
}
],
"tags": [
{
"name": "Brev",
"description": ""
}
]
}