POST /api/vaccine-certificate-records/:id/revoke — pawthosx-business-api-v1

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

VaccineCertificateRecords

post/api/vaccine-certificate-records/{id}/revoke

Path parameters

idstring required

Request body

reasonstring required

Response

idstring

vaccinationRecordIdstring

patientIdstring

clientIdstring

rabiesTagIdstring nullable

rabiesTagNumberstring nullable

statusstring

issuedAtstring date-time

supersededByCertificateIdstring nullable

revokedAtstring date-time nullable

revocationReasonstring nullable

createdAtstring date-time

updatedAtstring date-time

warningsstring[]

Non-blocking warnings computed at issuance for recommended-but-missing certificate fields (vial expiration, rabies tag, DVM signature, license number). Surfaced to the UI so staff can backfill; the certificate still issues. Empty when nothing is missing or on read-back.

isStaleboolean

True when the underlying vaccination record was edited AFTER this certificate froze its snapshot (ITE-281) — the printed values may no longer match the record. Prompt a reissue; never reissue silently. Computed on read for the current-certificate endpoint only.