POST ShortTerm/GetItemsCovered

Request Information

URI Parameters

None.

Body Parameters

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

ResponseOfListOfItemCovered

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	Collection of ItemCovered	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "Id": 1,
      "PolicyId": 2,
      "PolicyNumber": "sample string 3",
      "Description": "sample string 4",
      "CoverTypeId": 5,
      "CoverType": "sample string 6",
      "CoverStartDate": "2025-05-13T22:33:17.0730019+02:00",
      "CoverEndDate": "2025-05-13T22:33:17.0730019+02:00",
      "MonthlyPremium": 8.0,
      "StatusId": 9,
      "Status": "sample string 10"
    },
    {
      "Id": 1,
      "PolicyId": 2,
      "PolicyNumber": "sample string 3",
      "Description": "sample string 4",
      "CoverTypeId": 5,
      "CoverType": "sample string 6",
      "CoverStartDate": "2025-05-13T22:33:17.0730019+02:00",
      "CoverEndDate": "2025-05-13T22:33:17.0730019+02:00",
      "MonthlyPremium": 8.0,
      "StatusId": 9,
      "Status": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfItemCoveredlP_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:ItemCovered>
      <d2p1:CoverEndDate>2025-05-13T22:33:17.0730019+02:00</d2p1:CoverEndDate>
      <d2p1:CoverStartDate>2025-05-13T22:33:17.0730019+02:00</d2p1:CoverStartDate>
      <d2p1:CoverType>sample string 6</d2p1:CoverType>
      <d2p1:CoverTypeId>5</d2p1:CoverTypeId>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:MonthlyPremium>8</d2p1:MonthlyPremium>
      <d2p1:PolicyId>2</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 3</d2p1:PolicyNumber>
      <d2p1:Status>sample string 10</d2p1:Status>
      <d2p1:StatusId>9</d2p1:StatusId>
    </d2p1:ItemCovered>
    <d2p1:ItemCovered>
      <d2p1:CoverEndDate>2025-05-13T22:33:17.0730019+02:00</d2p1:CoverEndDate>
      <d2p1:CoverStartDate>2025-05-13T22:33:17.0730019+02:00</d2p1:CoverStartDate>
      <d2p1:CoverType>sample string 6</d2p1:CoverType>
      <d2p1:CoverTypeId>5</d2p1:CoverTypeId>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:MonthlyPremium>8</d2p1:MonthlyPremium>
      <d2p1:PolicyId>2</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 3</d2p1:PolicyNumber>
      <d2p1:Status>sample string 10</d2p1:Status>
      <d2p1:StatusId>9</d2p1:StatusId>
    </d2p1:ItemCovered>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfItemCoveredlP_S41WJs>