Batch PDF
The Batch PDF API generates consolidated PDFs from multiple Unified Command Platform board views and records, offering asynchronous processing with status tracking and file retrieval.
The batch PDF process flow involves three endpoints.
To generate consolidated PDFs using these endpoints:
-
Submit a batch PDF request via POST /pdf
-
Receive a batchPdfId in the response
-
Poll the status using GET /pdf/{batchId}/status until completedTs is populated
-
Download the completed PDF using GET /pdf/{batchId}
Error Handling
| Status Code | Description |
|---|---|
| 200 OK | Request successful |
| 400 Bad Request | Invalid request parameters or validation failure |
| 401 Unauthorized | Authentication required or session expired |
| 403 Forbidden | User lacks permission to access specified boards/views |
| 404 Not Found | Batch ID not found |
| 500 Internal Server Error | Server processing error |
Error responses include error details:
-
User has been logged out
-
The board 'board' does not exist
-
Asynchronous Processing: PDF generation is asynchronous. Large batches may take several minutes to complete.
-
Concurrency: The system processes up to 2 batch items concurrently
-
Permissions: Users must have appropriate permissions to access the boards and views specified in the request.
-
File Storage: Generated PDFs are stored in the configured file storage (AWS S3) and retrieved on demand.
-
Session Management: All requests require a valid WebEOC session.