Retrieve Policy Documents
Retrieves all documents for a specific insurance policy.
Command Name
RetrievePolicyDocumentsListQuery
Endpoint
POST /api/core/cmd
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
policyId | long | Yes | Insurance policy ID |
documentType | integer | No | Filter by document type |
pageNumber | integer | No | Page number (default: 1) |
pageSize | integer | No | Items per page (default: 20) |
isExport | boolean | No | Export all results (default: false) |
Request Example
{
"Cmd": "RetrievePolicyDocumentsListQuery",
"Data": {
"policyId": 99887,
"pageNumber": 1,
"pageSize": 20
}
}
Response Structure
{
"IsSuccessful": true,
"StatusCode": "00",
"Message": "Policy documents retrieved successfully.",
"Data": {
"items": [
{
"Id": 654,
"EntityType": "Policy",
"EntityId": 99887,
"FileName": "policy_document.pdf",
"Title": "Life Insurance Policy",
"DocumentType": 6,
"DocumentTypeDescription": "Policy Document",
"UploadedAt": "2024-01-05T14:30:00"
}
],
"totalRows": 7,
"totalPages": 1,
"pageSize": 20,
"currentPage": 1
}
}
Typical Policy Documents
- Policy document
- Premium payment receipts
- Beneficiary designation forms
- Claims documentation
- Medical reports (for life insurance)
- Endorsement certificates
- Policy amendments
- Renewal notices
Use Case Example
Retrieve all insurance policy documents:
{
"Cmd": "RetrievePolicyDocumentsListQuery",
"Data": {
"policyId": 99887,
"isExport": true
}
}