GDP OpenAPI Dokumentation

Denna tjänst ger information om utlysningar, ansökningar och finansierade aktiviteter.

Autentisering

För att använda API:et behöver du en API-nyckel. Denna nyckel ska inkluderas i alla anrop till API:et i request header som 'Authorization'.

API Endpoints

Följande endpoints är tillgängliga:

• Metadata: /v1/metadata - Hämta information om API:et

• Ansökningar: /v1/ansokningar - Hämta en lista med ansökningar baserat på olika filter

• Finansierade Aktiviteter: /v1/finansieradeaktiviteter - Hämta en lista med finansierade aktiviteter baserat på olika filter

• Utlysningar: /v1/utlysningar - Hämta en lista med utlysningar baserat på olika filter

Filtrering och Paginering

Filtrera Ansökningar

För att filtrera ansökningar, använd följande query parametrar:

• programDiarienummer för att filtrera ansökningar efter program.

• utlysningDiarienummer för att filtrera ansökningar efter utlysning.

• organisationsnummer för att hitta ansökningar kopplade till en specifik organisation.

• Tidsbaserade filter som från Tidpunkt och till Tidpunkt för att filtrera ansökningar baserade på när de senast ändrades.

• status för att filtrera ansökningar baserat på deras aktuella status, exempelvis Avslagen eller Beviljad.

• franBeslutDatum och tillBeslutDatum för att filtrera ansökningar baserat på beslutsdatum.

Paginering

För att hantera stora volymer av data effektivt använder API:et pagineringsparametrarna limit och offset. Dessa parametrar hjälper till att kontrollera antalet poster som returneras i varje svar och att navigera genom datamängderna.

• limit - Specificerar maximalt antal poster som ska returneras i svaret.

• offset - Anger startpunkten för datahämtningen, vilket är nyttigt för paginering.

Exempel: För att hämta de första 50 ansökningarna använd limit=50 och offset=0. För att därefter hämta de nästa 50 ansökningarna, använd limit=50 och offset=50.

Exempel på API-anrop

För att använda filtrerings- och pagineringsparametrar i praktiken, här är ett exempel på hur ett anrop till API:et kan se ut när du vill hämta godkända ansökningar:

GET /v1/ansokningar?status=Beviljad&limit=50&offset=0

Användning av API:et

Exempel på användning av API:et