Skip to navigation

Remove Additional Vaccine Indicator

View as Markdown
How do I remove the Additional Vaccines Required indicator from a person's record?

Through this endpoint, the mirror of Add Additional Vaccine Indicator, after the same acknowledgement.

Remove the Additional Vaccines Required indicator from an individual’s AIR record. Mirror of Add Additional Vaccine Indicator — same request shape, same acknowledgement requirement, removes rather than adds.

Requires an individualIdentifier from a prior Identify Individual call.

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

Acknowledgement text

Display the same acknowledgement text as for Add, and pass acknowledgement: true only after the provider confirms. false returns AIR-E-1065.

Status Codes

CodeMeaning
AIR-I-1100Indicator successfully removed.
AIR-E-1005Validation errors (e.g. AIR-E-1065, AIR-E-1061).

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.

Request

This endpoint expects an object.
individualIdentifierstringRequired
Opaque token from a prior Identify Individual call.
individualDateOfBirthstringRequired
DDMMYYYY format.
acknowledgementbooleanRequired

Must be true. false returns AIR-E-1065.

informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
errorslist of objects or nullOptional
correlationIdstringOptional