Consent Submissions

Get consent submission export status

Returns the status of a consent submission export job.

When the status is COMPLETED, the response includes a downloadUrl which is a pre-signed S3 URL that can be used to download the ZIP file directly via a GET request.

When the status is PARTIAL, the export finished but some consent submission PDFs could not be included. The response still includes a downloadUrl, along with failedCount, failedConsentSubmissionIds and a message, and the ZIP file contains a manifest.csv listing each consent submission as included or missing. Requesting a new export may include the missing PDFs.

The URL expires after 5 minutes. Request a new export status to get a fresh URL if needed.

get/studies/{studyId}/consent-submissions/export/{exportId}

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/{studyId}/consent-submissions/export/{exportId}
  • Auth: HTTP bearer

Path parameters

studyIdstring required

The study ID

exportIdstring required

The export ID

Response

Export status retrieved successfully

exportIdstring required

The export ID

status'NOT_STARTED' | 'EXPORTING' | 'COMPLETED' | 'PARTIAL' | 'ERROR' required

The current status of the export. PARTIAL means the export finished but some consent submission PDFs could not be included in the ZIP file; see failedCount and failedConsentSubmissionIds.

processedCountnumber required

Number of consent submission PDFs added to the ZIP file so far

totalCountnumber required

Total number of consent submissions to export

failedCountnumber required

Number of consent submissions whose PDF could not be included in the ZIP file

failedConsentSubmissionIdsstring[] required

IDs of the consent submissions whose PDF could not be included in the ZIP file. Populated once the export finishes.

messagestring

A human-readable explanation of the result. Present when status is PARTIAL.

downloadUrlstring

Pre-signed S3 URL to download the ZIP file. Expires after 5 minutes. Only present when status is COMPLETED or PARTIAL. A PARTIAL export also contains a manifest.csv listing each consent submission as included or missing.

createdAtstring required

When the export was created

updatedAtstring required

When the export was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.