Skip to navigation

Antigen by Code

View as Markdown
What are the details of this antigen?

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

Look up a single antigen by its AIR code. Returns the same shape as the Antigens 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

antigenCodestringRequired

AIR antigen code (e.g. CAC, HEP, FLU).

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
antigenslist of objectsOptional
correlationIdstringOptional