POST Policy/GetShorttermPolicyExclusions

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedRequest
NameDescriptionTypeAdditional 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

ResponseOfListOfPolicyExclusionShortterm
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

Collection of PolicyExclusionShortterm

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "Id": 1,
      "CreatedDateTime": "2025-05-13T22:22:26.1823854+02:00",
      "CreatedBy": "sample string 3",
      "EntityId": 4,
      "Entity": "sample string 5",
      "ExclusionId": 6,
      "Category": "sample string 7",
      "Description": "sample string 8",
      "Active": true
    },
    {
      "Id": 1,
      "CreatedDateTime": "2025-05-13T22:22:26.1823854+02:00",
      "CreatedBy": "sample string 3",
      "EntityId": 4,
      "Entity": "sample string 5",
      "ExclusionId": 6,
      "Category": "sample string 7",
      "Description": "sample string 8",
      "Active": true
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfPolicyExclusionShorttermlP_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:PolicyExclusionShortterm>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Category>sample string 7</d2p1:Category>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2025-05-13T22:22:26.1823854+02:00</d2p1:CreatedDateTime>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:Entity>sample string 5</d2p1:Entity>
      <d2p1:EntityId>4</d2p1:EntityId>
      <d2p1:ExclusionId>6</d2p1:ExclusionId>
      <d2p1:Id>1</d2p1:Id>
    </d2p1:PolicyExclusionShortterm>
    <d2p1:PolicyExclusionShortterm>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Category>sample string 7</d2p1:Category>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2025-05-13T22:22:26.1823854+02:00</d2p1:CreatedDateTime>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:Entity>sample string 5</d2p1:Entity>
      <d2p1:EntityId>4</d2p1:EntityId>
      <d2p1:ExclusionId>6</d2p1:ExclusionId>
      <d2p1:Id>1</d2p1:Id>
    </d2p1:PolicyExclusionShortterm>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfPolicyExclusionShorttermlP_S41WJs>