Vaccine Trial History | RebateRight

curl -X POST https://api.rebateright.com.au/AIR/v1/individual/vaccine-trial/history \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "individualIdentifier": "wXrN7bKidsrEkh89yldqZRw99uzP6WZJfEgIe4PEaEQ1TyUZsqOSEnqCM0BvbRF-FoHdgZgtg4iynmUuQamZdgGPH8QDag8rwFax7MI0zBpBaQnsaznfCA==",
  "individualDateOfBirth": "17042012",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}'

{
  "statusCode": "AIR-I-1100",
  "codeType": "AIRIBU",
  "message": "Your request was successfully processed.",
  "vaccineTrialList": [
    {
      "antigenCode": "CHL",
      "dose": "1",
      "startDate": "29092020",
      "endDate": ""
    },
    {
      "antigenCode": "DIP",
      "dose": "2",
      "startDate": "04012021",
      "endDate": ""
    }
  ],
  "correlationId": "urn:uuid:MDE000008cf529112a724e92"
}

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

Requires an individualIdentifier from a prior Identify Individual call. If vaccineTrialIndicator on that response is false, this endpoint returns success with no list field.

For shared response patterns and the full status-code list, see AIR Integration.

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Top-level outcomes for this endpoint:

Code	Meaning
`AIR-I-1100`	Request was successfully processed. `vaccineTrialList` returned (omitted entirely when no records exist).
`AIR-E-1005`	Validation errors (e.g. `AIR-E-1061` invalid or expired identifier).
`AIR-E-1058`	Individual’s record cannot be viewed or updated.

Retrieve vaccine trials the individual is participating in or has participated in, with the antigen code, dose, and trial period. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. If `vaccineTrialIndicator` on that response is `false`, this endpoint returns success with no list field. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Date format Date fields use **DDMMYYYY** with no separators. #### Status Codes Top-level outcomes for this endpoint: | Code | Meaning | |---|---| | `AIR-I-1100` | Request was successfully processed. `vaccineTrialList` returned (omitted entirely when no records exist). | | `AIR-E-1005` | Validation errors (e.g. `AIR-E-1061` invalid or expired identifier). | | `AIR-E-1058` | Individual's record cannot be viewed or updated. |

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

API Key authentication via header

Request

This endpoint expects an object.

individualIdentifierstringRequired

Opaque token from a prior Identify Individual call.

individualDateOfBirthstringRequired

DDMMYYYY format. Must match the individual matched by individualIdentifier.

informationProviderobjectRequired

Response

statusCodestring

codeTypestring

messagestring

vaccineTrialListlist of objects

Recorded vaccine trials. The whole field is omitted when no records exist.

errorslist of objects or null

Field-level validation problems. See Validation codes.

correlationIdstring

Unique request identifier.