POST ShortTerm/GetProRataItems
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
ResponseOfListOfProRataItem| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Entity | Collection of ProRataItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"Entity": [
{
"Id": 1,
"Description": "sample string 2",
"Type": "sample string 3",
"InceptionDate": "2025-12-01T08:48:02.6239853+02:00",
"MonthlyPremium": 5.0,
"ProRataPremium": 6.0,
"InvoiceTypeId": 7
},
{
"Id": 1,
"Description": "sample string 2",
"Type": "sample string 3",
"InceptionDate": "2025-12-01T08:48:02.6239853+02:00",
"MonthlyPremium": 5.0,
"ProRataPremium": 6.0,
"InvoiceTypeId": 7
}
]
}
application/xml, text/xml
Sample:
<ResponseOfArrayOfProRataItemlP_S41WJs 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">
<d2p1:ProRataItem>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:Id>1</d2p1:Id>
<d2p1:InceptionDate>2025-12-01T08:48:02.6239853+02:00</d2p1:InceptionDate>
<d2p1:InvoiceTypeId>7</d2p1:InvoiceTypeId>
<d2p1:MonthlyPremium>5</d2p1:MonthlyPremium>
<d2p1:ProRataPremium>6</d2p1:ProRataPremium>
<d2p1:Type>sample string 3</d2p1:Type>
</d2p1:ProRataItem>
<d2p1:ProRataItem>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:Id>1</d2p1:Id>
<d2p1:InceptionDate>2025-12-01T08:48:02.6239853+02:00</d2p1:InceptionDate>
<d2p1:InvoiceTypeId>7</d2p1:InvoiceTypeId>
<d2p1:MonthlyPremium>5</d2p1:MonthlyPremium>
<d2p1:ProRataPremium>6</d2p1:ProRataPremium>
<d2p1:Type>sample string 3</d2p1:Type>
</d2p1:ProRataItem>
</Entity>
<Message>sample string 2</Message>
<Success>true</Success>
</ResponseOfArrayOfProRataItemlP_S41WJs>