POST ShortTerm/CancelCoveredItem

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedCancelItemCoverRequest
NameDescriptionTypeAdditional information
EntityId

integer

None.

CovertTypeId

integer

None.

CancelledDate

date

None.

SecurityKey

string

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "EntityId": 1,
  "CovertTypeId": 2,
  "CancelledDate": "2025-05-14T01:04:42.0858731+02:00",
  "SecurityKey": "sample string 4",
  "PolicyId": 5
}

application/xml, text/xml

Sample:
<SecurityTokenVerifiedCancelItemCoverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>5</PolicyId>
  <SecurityKey>sample string 4</SecurityKey>
  <CancelledDate>2025-05-14T01:04:42.0858731+02:00</CancelledDate>
  <CovertTypeId>2</CovertTypeId>
  <EntityId>1</EntityId>
</SecurityTokenVerifiedCancelItemCoverRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfException
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

Exception

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<ResponseOfException5F2dSckg 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/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfException5F2dSckg>