Skip to navigation
RebateRight APIAIRIndividual Details

Vaccine Trial History

View as Markdown
Is this person in a vaccine trial?

That is the question this endpoint answers: each trial they are in or have been in, with the antigen, dose and trial period.

Retrieve the vaccine trials the individual is in or has been in, with the antigen code, dose and trial period.

Send the individualIdentifier that Identify Individual returned. When the Identify Individual response has vaccineTrialIndicator: false, this endpoint returns AIR-I-1100 and omits vaccineTrialList.

For shared response patterns and the full status-code list, see AIR Integration. For what your software must show, see Display requirements.

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Top-level outcomes for this endpoint:

CodeMeaning
AIR-I-1100Request was successfully processed. vaccineTrialList returned when vaccine trials are recorded.
AIR-E-1005Validation errors, most often AIR-E-1061 (invalid or expired identifier).
AIR-E-1058Individual’s record cannot be viewed or updated.

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.

Request

This endpoint expects an object.
individualIdentifierstringRequired
Opaque token that Identify Individual returned.
individualDateOfBirthstringRequired

DDMMYYYY format. Must be the date of birth of the individual that individualIdentifier identifies.

informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
vaccineTrialListlist of objectsOptional
Recorded vaccine trials. AIR omits the field when no vaccine trial is recorded.
errorslist of objects or nullOptional

Field-level validation problems. See Validation codes.

correlationIdstringOptional
Unique request identifier.