GET PlanCare2Api/Covid19?dateFrom={dateFrom}&dateUntil={dateUntil}
Returns Covid19 vaccinations in the specified period.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| dateFrom |
Startdate of the period. |
date |
Required |
| dateUntil |
Enddate of the period. |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Vaccination information.
Vaccinations| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header |
VaccinationsHeader |
- |
| Details |
Details |
Collection of VaccinationDetails |
- |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"$id": "2",
"VersionNumber": "sample string 1",
"ReleaseNumber": "sample string 2",
"SupplierCode": "sample string 3",
"AGBCode": "sample string 4"
},
"Details": [
{
"$id": "3",
"HasObjectionTransferRIVM": true,
"SocialSecurityNumber": "sample string 2",
"DateOfBirth": "2026-05-26T21:10:26.9870758+02:00",
"FirstName": "sample string 3",
"BirthNamePrefix": "sample string 4",
"BirthName": "sample string 5",
"PostalCode": "sample string 6",
"HouseNumber": "sample string 7",
"HouseNumberAddon": "sample string 8",
"VaccinationDate": "2026-05-26T21:10:26.9870758+02:00",
"VaccineName": "sample string 10",
"HPKCode": "sample string 11",
"BatchNumber": "sample string 12",
"AGBCodePractitioner": "sample string 13",
"Shot": 0,
"ShotNumber": 14,
"SelectionCriterion": 1,
"UniqueIdentifier": "sample string 15"
},
{
"$ref": "3"
}
]
}
application/xml, text/xml
Sample:
<Vaccinations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Covid19">
<Details>
<VaccinationDetails>
<AGBCodePractitioner>sample string 13</AGBCodePractitioner>
<BatchNumber>sample string 12</BatchNumber>
<BirthName>sample string 5</BirthName>
<BirthNamePrefix>sample string 4</BirthNamePrefix>
<DateOfBirth>2026-05-26T21:10:26.9870758+02:00</DateOfBirth>
<FirstName>sample string 3</FirstName>
<HPKCode>sample string 11</HPKCode>
<HasObjectionTransferRIVM>true</HasObjectionTransferRIVM>
<HouseNumber>sample string 7</HouseNumber>
<HouseNumberAddon>sample string 8</HouseNumberAddon>
<PostalCode>sample string 6</PostalCode>
<SelectionCriterion>Medical</SelectionCriterion>
<Shot>First</Shot>
<ShotNumber>14</ShotNumber>
<SocialSecurityNumber>sample string 2</SocialSecurityNumber>
<UniqueIdentifier>sample string 15</UniqueIdentifier>
<VaccinationDate>2026-05-26T21:10:26.9870758+02:00</VaccinationDate>
<VaccineName>sample string 10</VaccineName>
</VaccinationDetails>
<VaccinationDetails>
<AGBCodePractitioner>sample string 13</AGBCodePractitioner>
<BatchNumber>sample string 12</BatchNumber>
<BirthName>sample string 5</BirthName>
<BirthNamePrefix>sample string 4</BirthNamePrefix>
<DateOfBirth>2026-05-26T21:10:26.9870758+02:00</DateOfBirth>
<FirstName>sample string 3</FirstName>
<HPKCode>sample string 11</HPKCode>
<HasObjectionTransferRIVM>true</HasObjectionTransferRIVM>
<HouseNumber>sample string 7</HouseNumber>
<HouseNumberAddon>sample string 8</HouseNumberAddon>
<PostalCode>sample string 6</PostalCode>
<SelectionCriterion>Medical</SelectionCriterion>
<Shot>First</Shot>
<ShotNumber>14</ShotNumber>
<SocialSecurityNumber>sample string 2</SocialSecurityNumber>
<UniqueIdentifier>sample string 15</UniqueIdentifier>
<VaccinationDate>2026-05-26T21:10:26.9870758+02:00</VaccinationDate>
<VaccineName>sample string 10</VaccineName>
</VaccinationDetails>
</Details>
<Header>
<AGBCode>sample string 4</AGBCode>
<ReleaseNumber>sample string 2</ReleaseNumber>
<SupplierCode>sample string 3</SupplierCode>
<VersionNumber>sample string 1</VersionNumber>
</Header>
</Vaccinations>