All REST Endpoints
Authorize
Generate and refresh authorization tokens for API access.
- Generate an authorization token
- Method: postPath:
/v0/token/gen
- Refresh an authorization token
- Method: postPath:
/v0/token/refresh
Export
Export immunization records as original unprocessed data or as processed data from either the redacted or non-redacted database.
- Export records uploaded in a date range
- Method: postPath:
/v0/export
Get Export History
Return a list of files exported to the CDC IZ Data Lake (IZDL).
- Get a list of exports to IZDL
- Method: postPath:
/v0/izdlexport/history
Upload
Upload create, update, and delete immunization record requests using either CRVS or HL7 data formats. Upload files can be text, JSON, or a zipped text or JSON file.
- Asynchronous - Create records using CVRS data in a zipped text file
- Method: postPath:
/v0/async/cvrs/jobs
- Asynchronous - Delete records using CVRS data in a zipped text file
- Method: deletePath:
/v0/async/cvrs/jobs
- Asynchronous - Get status for an asynchronous CVRS upload
- Method: getPath:
/v0/async/cvrs/jobs/{job-id}
- Asynchronous - Update records using CVRS data in a zipped text file
- Method: putPath:
/v0/async/cvrs/jobs
- Create records using CVRS data in a text file
- Method: postPath:
/v0/upload/cvrs/batch
- Create records using HL7 data in a JSON file
- Method: postPath:
/v0/upload/hl7/json
- Create records using HL7 data in a text file
- Method: postPath:
/v0/upload/hl7/batch
- Delete records using CVRS data in a text file
- Method: deletePath:
/v0/upload/cvrs/batch
- Delete records using HL7 data in a JSON file
- Method: deletePath:
/v0/upload/hl7/json
- Delete records using HL7 data in a text file
- Method: deletePath:
/v0/upload/hl7/batch
- Get previously uploaded records
- Method: getPath:
/v0/upload/file/{fileId}
- Update records using CVRS data in a text file
- Method: putPath:
/v0/upload/cvrs/batch
- Update records using HL7 data in a JSON file
- Method: putPath:
/v0/upload/hl7/json
- Update records using HL7 data in a text file
- Method: putPath:
/v0/upload/hl7/batch