POST v1/Locations/{locationID}/Policies/CancellationReasons

Insert a new cancellation reason

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

Cancellation reason to be inserted

PolicyCancellationReasonDTO
NameDescriptionTypeAdditional information
CancellationReasonID

integer

None.

CancellationReasonName

string

None.

SystemDefined

boolean

None.

LocationId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CancellationReasonID": 1,
  "CancellationReasonName": "sample string 2",
  "SystemDefined": true,
  "LocationId": 1
}

application/xml, text/xml

Sample:
<PolicyCancellationReasonDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <CancellationReasonID>1</CancellationReasonID>
  <CancellationReasonName>sample string 2</CancellationReasonName>
  <LocationId>1</LocationId>
  <SystemDefined>true</SystemDefined>
</PolicyCancellationReasonDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PolicyCancellationReasonDTO'.

Response Information

Resource Description

New cancellation reason

ActionResultDTOOfPolicyCancellationReasonDTO
NameDescriptionTypeAdditional information
Result

PolicyCancellationReasonDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "CancellationReasonID": 1,
    "CancellationReasonName": "sample string 2",
    "SystemDefined": true,
    "LocationId": 1
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfPolicyCancellationReasonDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
    <d2p1:CancellationReasonID>1</d2p1:CancellationReasonID>
    <d2p1:CancellationReasonName>sample string 2</d2p1:CancellationReasonName>
    <d2p1:LocationId>1</d2p1:LocationId>
    <d2p1:SystemDefined>true</d2p1:SystemDefined>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfPolicyCancellationReasonDTO>