POST Policy/GetPolicyInformation
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
ResponseOfPolicyInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Entity | PolicyInformation |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"Entity": {
"PolicyId": 1,
"PolicyNumber": "sample string 2",
"InceptionDate": "2025-12-01T08:51:35.3903034+02:00",
"IdNumber": "sample string 4",
"PassportNumber": "sample string 5",
"FirstName": "sample string 6",
"Surname": "sample string 7",
"MobileNumber": "sample string 8",
"TelephoneNumber": "sample string 9",
"EmailAddress": "sample string 10",
"PlanId": 11,
"Plan": "sample string 12",
"UnitId": 13,
"Unit": "sample string 14",
"StatusId": 15,
"Status": "sample string 16"
}
}
application/xml, text/xml
Sample:
<ResponseOfPolicyInformationlP_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:EmailAddress>sample string 10</d2p1:EmailAddress>
<d2p1:FirstName>sample string 6</d2p1:FirstName>
<d2p1:IdNumber>sample string 4</d2p1:IdNumber>
<d2p1:InceptionDate>2025-12-01T08:51:35.3903034+02:00</d2p1:InceptionDate>
<d2p1:MobileNumber>sample string 8</d2p1:MobileNumber>
<d2p1:PassportNumber>sample string 5</d2p1:PassportNumber>
<d2p1:Plan>sample string 12</d2p1:Plan>
<d2p1:PlanId>11</d2p1:PlanId>
<d2p1:PolicyId>1</d2p1:PolicyId>
<d2p1:PolicyNumber>sample string 2</d2p1:PolicyNumber>
<d2p1:Status>sample string 16</d2p1:Status>
<d2p1:StatusId>15</d2p1:StatusId>
<d2p1:Surname>sample string 7</d2p1:Surname>
<d2p1:TelephoneNumber>sample string 9</d2p1:TelephoneNumber>
<d2p1:Unit>sample string 14</d2p1:Unit>
<d2p1:UnitId>13</d2p1:UnitId>
</Entity>
<Message>sample string 2</Message>
<Success>true</Success>
</ResponseOfPolicyInformationlP_S41WJs>