Skip to navigation
RebateRight APIAIRReference Data

Antigens

View as Markdown
Which antigens does the AIR recognise?

That is the question this endpoint answers: every antigen, with its name, maximum dose and whether natural immunity can be recorded against it.

List every antigen AIR recognises, with its name, its maximum dose and whether a natural immunity can be recorded against it.

Authentication

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

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. See Required headers and hosts.

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
antigenslist of objectsOptional
correlationIdstringOptional