Skip to navigation

Vaccine by Code

View as Markdown
What are the details of this vaccine?

That is the question this endpoint answers, for one AIR vaccine code, in the same shape as the Vaccines list.

Look up a single vaccine by its AIR code. Returns the same shape as the Vaccines list endpoint, scoped to one entry.

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring

Your Minor ID is three uppercase letters followed by five digits, such as MDE00001. Send the Minor ID exactly as issued. A malformed value gets a 400 with “The Minor ID is not valid.” on every endpoint.

Path parameters

vaccineCodestringRequired

AIR vaccine code (e.g. BCG, BEXO, BOOST).

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
vaccineslist of objectsOptional
correlationIdstringOptional