Proposal Documents Download¶

ID: UC-WFP-PROPSL-D001
Complexity: Basic
Description: Download proposal documents using the WFP proposal API
Scenario: A user needs to retrieve proposal documents for review, analysis, or archival purposes
Business Value: Enables efficient document retrieval and management for proposal review processes and compliance requirements

Prerequisites¶

Valid API key for WFP proposal API
Proposal ID for an existing proposal
Access to WFP proposal API environment

Steps¶

1. Get All Proposal Documents¶

Retrieve all documents associated with a proposal in ZIP format

Endpoint: GET /api/v1/ext/proposals/{proposal-id}/documents

HTTP Request

curl -X GET 'https://{base-url}/data/api/v1/ext/proposals/{proposal-id}/documents' 
  -H 'x-api-key: YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  --output proposal_documents.zip

Expected Response: HTTP 200 with ZIP file containing proposal documents

Notes: Replace {proposal-id} with the actual proposal ID. The response will be a ZIP file containing all proposal documents

Error Scenarios¶

Invalid Proposal ID (400): Verify that the proposal ID is valid Recovery: Contact Nakisa Support team to verify the proposal ID

Unauthorized Access (403): Verify that your API key has document access permissions Recovery: Contact Nakisa Support team to grant access permissions

Large File Download Timeout (408): Implement timeout handling and retry logic for large document downloads Recovery: Use streaming downloads or implement chunked download for large files

Best Practices¶

Implement proper error handling for file download operations
Use appropriate timeout settings for large document downloads
Store downloaded documents securely and implement proper cleanup
Log document access for audit and compliance purposes
Implement retry logic for failed downloads