Ga naar inhoud

Claims — lijst

GET Haal de lijst met ingelezen claims op uit PharmaPortal.

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met ingelezen claims op te vragen. Dit is een REST-API met één endpoint en één mogelijke actie.

Toegang

Alleen beschikbaar voor licentiehouders van PharmaPortal.

Endpoint

GET https://demo.pharma-portal.nl/api/claims/list/[jaar]

GET https://www.pharma-portal.nl/api/claims/list/[jaar]
Parameter In Type Verplicht Omschrijving
jaar pad string nee Jaar waarvoor claims worden opgehaald. Bij leeglaten wordt automatisch het huidige jaar gebruikt.

Authenticatie

Deze API maakt gebruik van IP-whitelisting en een API-key voor authenticatie en rate-limiting. Stuur de header mee:

Header Toelichting
x-portal-key De aan uw organisatie uitgereikte API-key.

Request

Requests zijn GET-requests.

curl https://demo.pharma-portal.nl/api/claims/list/2019 \
  -H "x-portal-key: <uw-api-key>"

Response

Code Betekenis
200 Correct request.
401 Foutieve authenticatie of HMAC.

Voorbeeld van een succesvolle response:

{
  "jaar": "2019",
  "numClaims": 2,
  "claims": [
    {
      "GroothandelPiCode": "871079",                      // PI-code verwijzend naar de groothandel
      "ControleResultaat": "3",                           // 1 = Correct, 2 = Geaccepterd met verschillen, 3 = Wacht op correctie, 4 = Correctie ontvangen, 5 = In behandeling
      "LaatsteControleOp": null,                          // Moment van laatste controle door gebruiker
      "ClaimType": "W",                                   // Type bestand conform FIX specificatie
      "Volgnummer": "44",                                 // Volgnummer van het bestand, aangegeven door de groothandel
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",    // Naam van de afzender, aangegeven door de groothandel
      "BestandsDatum": "2019-02-01",                      // Datum waarop het bestand is aangemaakt door groothandel
      "Slug": "8711722006004-1-brocacef-2"                // Uniek ID om claimregels via API op te halen
    },
    {
      "GroothandelPiCode": "871079",
      "ControleResultaat": "2",
      "LaatsteControleOp": null,
      "ClaimType": "W",
      "Volgnummer": "44",
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",
      "BestandsDatum": "2019-02-01",
      "Slug": "8711722006004-1-brocacef-3"
    }
  ]
}

Velden

Veld Type Omschrijving
jaar string Jaar waarop de claims betrekking hebben.
numClaims integer Aantal claims in de response.
claims object[] Lijst met claims.
GroothandelPiCode string PI-code verwijzend naar de groothandel.
ControleResultaat string 1 = Correct, 2 = Geaccepterd met verschillen, 3 = Wacht op correctie, 4 = Correctie ontvangen, 5 = In behandeling.
LaatsteControleOp string Moment van laatste controle door gebruiker.
ClaimType string Type bestand conform FIX-specificatie.
Volgnummer string Volgnummer van het bestand, aangegeven door de groothandel.
NaamAfzender string Naam van de afzender, aangegeven door de groothandel.
BestandsDatum string Datum waarop het bestand is aangemaakt door de groothandel.
Slug string Uniek ID om claimregels via API op te halen.

Aandachtspunten

Wilt u uw integratie testen? Neem tijdig contact op via info@zagis.nl. Wij zetten dan testdata voor u klaar en voorzien u van een API-key.