Jump to

• Request
• Response

Asynchronous - Delete records using CVRS data in a zipped text file

delete

/v0/async/cvrs/jobs

Asynchronous upload of delete requests for CVRS immunization records in a zipped batch (text) file. The Async API reduces the initial latency of the response time for uploading files. It provides a separate call to quickly check the status of the upload (/async/cvrs/{job-id}). This API requires CVRS payload types in a zip file with a file size less than 150 MB. This API does not replace the HL7 uploads or the unzipped file uploads of the synchronous APIs.

Request

There are no request parameters for this operation.

Supported Media Types

• application/zip
• text/plain

Request Body - application/zip ()

Root Schema : schema

Type: object

Request Body - text/plain ()

Root Schema : schema

Type: object

Security

• Authorization(required): apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

Default Response

The default response is similar to the response of the synchronous upload calls, except that the content is dynamic and contains an additional status of the asynchronous upload call. For this call, a successful status is QUEUED and the other properties will have null values. Subsequent calls to GET /v0/async/cvrs/jobs/{job-id} adds status data as it becomes available.

Body ()

Root Schema : InitialUploadStatusResponseAsync

Type: object

Show Source

• id: string (uuid)
  The unique identifier (UUID) of the transaction. This is the job-id required to make subsequent calls to ""Asynchronous - Get status for an asynchronous CVRS upload (GET /v0/async/cvrs/jobs/{job-id})" to obtain status information on the asynchronous upload.
• status: string
  Allowed Values: [ "QUEUED", "DE-QUEUED", "VALIDATING", "PROCESSING", "COMPLETED" ]

  Contains the status of the asynchronous upload call. Statuses include QUEUED (successfully received), DE-QUEUED (moved to processing), VALIDATING (validation processing phase), PROCESSING (data processing; the longest phase), COMPLETED.
• storageResult: object storageResult
  The UploadStorageResult object contains the processing response from the database on the results of the transaction.
• totalRecords: integer (int32)
  The number of immunization records contained in the transaction.
• validationErrors: array validationErrors
  The list of immunization records containing formatting or other errors that make the record invalid.
• validationErrorsCount: integer (int32)
  The number of validation errors in the transaction.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "description":"The unique identifier (UUID) of the transaction. This is the job-id required to make subsequent calls to \"\"Asynchronous - Get status for an asynchronous CVRS upload (GET /v0/async/cvrs/jobs/{job-id})\" to obtain status information on the asynchronous upload."
        },
        "status":{
            "type":"string",
            "description":"Contains the status of the asynchronous upload call. Statuses include QUEUED (successfully received), DE-QUEUED (moved to processing), VALIDATING (validation processing phase), PROCESSING (data processing; the longest phase), COMPLETED.",
            "enum":[
                "QUEUED",
                "DE-QUEUED",
                "VALIDATING",
                "PROCESSING",
                "COMPLETED"
            ]
        },
        "totalRecords":{
            "type":"integer",
            "description":"The number of immunization records contained in the transaction.",
            "format":"int32"
        },
        "validationErrors":{
            "type":"array",
            "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
            "items":{
                "type":"string",
                "description":"Contains information identifying the invalid record and the validation error message."
            }
        },
        "validationErrorsCount":{
            "type":"integer",
            "description":"The number of validation errors in the transaction.",
            "format":"int32"
        },
        "storageResult":{
            "description":"The UploadStorageResult object contains the processing response from the database on the results of the transaction.",
            "type":"object"
        }
    }
}

Nested Schema : storageResult

Type: object

The UploadStorageResult object contains the processing response from the database on the results of the transaction.

Nested Schema : validationErrors

Type: array

The list of immunization records containing formatting or other errors that make the record invalid.

Show Source

• Array of: string
  Contains information identifying the invalid record and the validation error message.

{
    "type":"array",
    "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
    "items":{
        "type":"string",
        "description":"Contains information identifying the invalid record and the validation error message."
    }
}

Back to Top