POST ShortTermItems/GetItemsByPolicyId

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

ResponseOfListOfSummaryItem

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "EntityId": 1,
      "Entity": "sample string 2",
      "StartDate": "2025-05-13T23:35:03.8542849+02:00",
      "EndDate": "2025-05-13T23:35:03.8542849+02:00",
      "ItemDescription": "sample string 4",
      "SumInsured": 5.0,
      "Premium": 6.0,
      "Percentage": 7.0,
      "ItemStatusId": 8,
      "ItemStatus": "sample string 9",
      "PolicyId": 10,
      "PolicyNumber": "sample string 11"
    },
    {
      "EntityId": 1,
      "Entity": "sample string 2",
      "StartDate": "2025-05-13T23:35:03.8542849+02:00",
      "EndDate": "2025-05-13T23:35:03.8542849+02:00",
      "ItemDescription": "sample string 4",
      "SumInsured": 5.0,
      "Premium": 6.0,
      "Percentage": 7.0,
      "ItemStatusId": 8,
      "ItemStatus": "sample string 9",
      "PolicyId": 10,
      "PolicyNumber": "sample string 11"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfSummaryItempWKZCCvT 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.Generated">
    <d2p1:SummaryItem>
      <d2p1:EndDate>2025-05-13T23:35:03.8542849+02:00</d2p1:EndDate>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityId>1</d2p1:EntityId>
      <d2p1:ItemDescription>sample string 4</d2p1:ItemDescription>
      <d2p1:ItemStatus>sample string 9</d2p1:ItemStatus>
      <d2p1:ItemStatusId>8</d2p1:ItemStatusId>
      <d2p1:Percentage>7</d2p1:Percentage>
      <d2p1:PolicyId>10</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 11</d2p1:PolicyNumber>
      <d2p1:Premium>6</d2p1:Premium>
      <d2p1:StartDate>2025-05-13T23:35:03.8542849+02:00</d2p1:StartDate>
      <d2p1:SumInsured>5</d2p1:SumInsured>
    </d2p1:SummaryItem>
    <d2p1:SummaryItem>
      <d2p1:EndDate>2025-05-13T23:35:03.8542849+02:00</d2p1:EndDate>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityId>1</d2p1:EntityId>
      <d2p1:ItemDescription>sample string 4</d2p1:ItemDescription>
      <d2p1:ItemStatus>sample string 9</d2p1:ItemStatus>
      <d2p1:ItemStatusId>8</d2p1:ItemStatusId>
      <d2p1:Percentage>7</d2p1:Percentage>
      <d2p1:PolicyId>10</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 11</d2p1:PolicyNumber>
      <d2p1:Premium>6</d2p1:Premium>
      <d2p1:StartDate>2025-05-13T23:35:03.8542849+02:00</d2p1:StartDate>
      <d2p1:SumInsured>5</d2p1:SumInsured>
    </d2p1:SummaryItem>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfSummaryItempWKZCCvT>