REST API umožňuje strojové získání dat o registrovaném záznamu odběrové sady GARG. Jedná se o záznamy, které uživatelé zaregistrovali na stránce https://www.gargtest.com/nebo https://covidlab.cz/.
K připojení k tomuto REST API je nezbytně nutný speciální podepsaný klientský certifikát chráněný heslem. Bez tohoto certifikátu je jakékoli připojení odmítnuto.
Rozhraní REST API je na adrese https://covitapi.imtm.cz/publicapi/checkgargcode
Parametry rozhraní:
- code - kód odběrové sady GARG
- auth - jedinečný identifikátor pro odběrové místo
Příklad použití rozhraní:
curl -v -X POST --cert-type P12 --cert /home/usr/cert.p12 -d "code=X0123&auth=xxxx" "https://covitapi.imtm.cz/publicapi/checkgargcode"
Výstup služby:
- Data jsou vrácena ve formě UZIS žádanky + dodatečné parametry. V objektu žádanky UZIS jsou vyplněné pouze parametry relevantní pro GARG odběr.
- Parametr Cislo obsahuje číslo UZIS žádanky, která byla vytvořena při registraci odběrové sady GARG. Pokud pro testovanou osobu již v době registrace existovala otevřená žádanka UZIS (indikace lékařem, KHS), parametr Cislo odkazuje na tuto existující žádanku.
- Indikace chyby nebo úspěchu je navrácena v parametru Vysledek, může nabývat těchto hodnot:
- ChybnyKod – pole code obsahuje neplatný kód
- ChybnyAuth – pole auth obsahuje neplatnou autentikaci
- ZadankaNeexistuje – pole code obsahuje platný kód, ale uživatel nezaregistroval svou odběrovou sadu
- ZadankaExistuje – registrace pro daný kód existuje a vrácený objekt obsahuje zaregistrovaná data.
Dodatečné parametry pro GARG odběrovou sadu:
- GargPayerIco - IČO společnosti, která prodala voucher na PCR test
- GargPayerName - Název společnosti, která prodala voucher na PCR test
- GargVoucherCode - Kód použitého voucheru
- GargVoucherPCR - informace zdali voucher obsahuje PCR vyšetření
- GargVoucherCert - informace zdali voucher obsahuje vystavení cestovního certifikátu