POST Policy/GetPremumAccount001
Request Information
URI Parameters
None.
Body Parameters
SecurityTokenVerifiedRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SecurityKey | string |
None. |
|
| PolicyId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"SecurityKey": "sample string 1",
"PolicyId": 2
}
application/xml, text/xml
Sample:
<SecurityTokenVerifiedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models"> <PolicyId>2</PolicyId> <SecurityKey>sample string 1</SecurityKey> </SecurityTokenVerifiedRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfFinancialAccount| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Entity | FinancialAccount |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"Entity": {
"CustomerAccountId": 1,
"LeftTotal": 2.0,
"RightTotal": 3.0,
"FinancialPeriods": [
{
"Period": "2025-12-01T08:53:18.359443+02:00",
"LeftTotal": 2.0,
"RightTotal": 3.0,
"Transactions": [
{
"DocumentId": 1,
"FinancialDate": "2025-12-01T08:53:18.359443+02:00",
"DocumentType": "sample string 3",
"Amount": 4.0,
"Position": "sample string 5"
},
{
"DocumentId": 1,
"FinancialDate": "2025-12-01T08:53:18.359443+02:00",
"DocumentType": "sample string 3",
"Amount": 4.0,
"Position": "sample string 5"
}
]
},
{
"Period": "2025-12-01T08:53:18.359443+02:00",
"LeftTotal": 2.0,
"RightTotal": 3.0,
"Transactions": [
{
"DocumentId": 1,
"FinancialDate": "2025-12-01T08:53:18.359443+02:00",
"DocumentType": "sample string 3",
"Amount": 4.0,
"Position": "sample string 5"
},
{
"DocumentId": 1,
"FinancialDate": "2025-12-01T08:53:18.359443+02:00",
"DocumentType": "sample string 3",
"Amount": 4.0,
"Position": "sample string 5"
}
]
}
]
}
}
application/xml, text/xml
Sample:
<ResponseOfPolicyRepo.FinancialAccount4wuehCtw xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
<Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models.Repositories">
<d2p1:CustomerAccountId>1</d2p1:CustomerAccountId>
<d2p1:FinancialPeriods>
<d2p1:PolicyRepo.FinancialPeriod>
<d2p1:LeftTotal>2</d2p1:LeftTotal>
<d2p1:Period>2025-12-01T08:53:18.359443+02:00</d2p1:Period>
<d2p1:RightTotal>3</d2p1:RightTotal>
<d2p1:Transactions>
<d2p1:PolicyRepo.FinancialTransaction>
<d2p1:Amount>4</d2p1:Amount>
<d2p1:DocumentId>1</d2p1:DocumentId>
<d2p1:DocumentType>sample string 3</d2p1:DocumentType>
<d2p1:FinancialDate>2025-12-01T08:53:18.359443+02:00</d2p1:FinancialDate>
<d2p1:Position>sample string 5</d2p1:Position>
</d2p1:PolicyRepo.FinancialTransaction>
<d2p1:PolicyRepo.FinancialTransaction>
<d2p1:Amount>4</d2p1:Amount>
<d2p1:DocumentId>1</d2p1:DocumentId>
<d2p1:DocumentType>sample string 3</d2p1:DocumentType>
<d2p1:FinancialDate>2025-12-01T08:53:18.359443+02:00</d2p1:FinancialDate>
<d2p1:Position>sample string 5</d2p1:Position>
</d2p1:PolicyRepo.FinancialTransaction>
</d2p1:Transactions>
</d2p1:PolicyRepo.FinancialPeriod>
<d2p1:PolicyRepo.FinancialPeriod>
<d2p1:LeftTotal>2</d2p1:LeftTotal>
<d2p1:Period>2025-12-01T08:53:18.359443+02:00</d2p1:Period>
<d2p1:RightTotal>3</d2p1:RightTotal>
<d2p1:Transactions>
<d2p1:PolicyRepo.FinancialTransaction>
<d2p1:Amount>4</d2p1:Amount>
<d2p1:DocumentId>1</d2p1:DocumentId>
<d2p1:DocumentType>sample string 3</d2p1:DocumentType>
<d2p1:FinancialDate>2025-12-01T08:53:18.359443+02:00</d2p1:FinancialDate>
<d2p1:Position>sample string 5</d2p1:Position>
</d2p1:PolicyRepo.FinancialTransaction>
<d2p1:PolicyRepo.FinancialTransaction>
<d2p1:Amount>4</d2p1:Amount>
<d2p1:DocumentId>1</d2p1:DocumentId>
<d2p1:DocumentType>sample string 3</d2p1:DocumentType>
<d2p1:FinancialDate>2025-12-01T08:53:18.359443+02:00</d2p1:FinancialDate>
<d2p1:Position>sample string 5</d2p1:Position>
</d2p1:PolicyRepo.FinancialTransaction>
</d2p1:Transactions>
</d2p1:PolicyRepo.FinancialPeriod>
</d2p1:FinancialPeriods>
<d2p1:LeftTotal>2</d2p1:LeftTotal>
<d2p1:RightTotal>3</d2p1:RightTotal>
</Entity>
<Message>sample string 2</Message>
<Success>true</Success>
</ResponseOfPolicyRepo.FinancialAccount4wuehCtw>