Offerteaanvraag afwijzen¶
POST Wijs een offerteaanvraag af in PharmaPortal.
Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem offerteaanvragen te verwerken. Met dit endpoint kunt u een aanvraag afwijzen.
Toegang
Alleen beschikbaar voor licentiehouders van PharmaPortal.
Endpoint¶
| Parameter | In | Type | Verplicht | Omschrijving |
|---|---|---|---|---|
id |
pad | string | ja | ID van de aanvraag. |
Request-body¶
| Veld | Type | Verplicht | Omschrijving |
|---|---|---|---|
reden |
string | ja | De reden voor het afwijzen van de offerte. Wordt opgeslagen in PharmaPortal en in ZAGIS (zichtbaar voor ziekenhuizen). Max 250 karakters. Mag leeg zijn. |
toelichting |
string | nee | Een uitgebreide toelichting die wordt gemaild naar het ziekenhuis. Max 25000 karakters. Plaintext. |
Authenticatie¶
Deze API maakt gebruik van IP-whitelisting en een API-key. Stuur de volgende headers mee:
| Header | Toelichting |
|---|---|
x-portal-key |
De aan uw organisatie uitgereikte API-key. |
x-portal-hmac |
HMAC van het bericht, SHA512, hexadecimaal, gegenereerd met de aan uw organisatie uitgereikte API-secret. |
Request¶
curl -X POST https://demo.pharma-portal.nl/api/offerte-aanvraag/afwijzen/ronde-3077 \
-H "x-portal-key: <uw-api-key>" \
-H "x-portal-hmac: <hmac>" \
-d "reden=<reden>" \
-d "toelichting=<toelichting>"
Response¶
| Code | Betekenis |
|---|---|
200 |
Ronde is gesloten. |
200 |
Ronde is al eerder gesloten (ter voorkoming van dubbele requests; er wordt geen update verstuurd naar ZAGIS). |
400 |
Geen POST request. |
401 |
Foutieve authenticatie of HMAC. |
404 |
Ongeldig aanvraag-id. |
Voorbeeld van een response bij een succesvol en correct request:
Aandachtspunten
Wilt u uw integratie testen? Neem tijdig contact op via info@zagis.nl voor testdata en een API-key.