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

Insert a new endorsement reason

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

Endorsement reason to be inserted

ListEndorsementReasonDTO
NameDescriptionTypeAdditional information
ReasonID

Id of the reason

integer

None.

Reason

Reason

string

None.

SystemDefined

Signifies whether the endorsement reason is system defined

boolean

None.

LocationId

Id of the location

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ReasonID": 1,
  "Reason": "sample string 2",
  "SystemDefined": true,
  "LocationId": 1
}

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 'ListEndorsementReasonDTO'.

application/xml, text/xml

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

Response Information

Resource Description

Inserted endorsement reason

ActionResultDTOOfListEndorsementReasonDTO
NameDescriptionTypeAdditional information
Result

ListEndorsementReasonDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

Signifies whether action is successful

boolean

None.

ErrorCode

Error code

string

None.

ErrorMessage

Error message

string

None.

InfoMessage

Information message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "ReasonID": 1,
    "Reason": "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:
<ActionResultOfListEndorsementReasonDTO 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:LocationId>1</d2p1:LocationId>
    <d2p1:Reason>sample string 2</d2p1:Reason>
    <d2p1:ReasonID>1</d2p1:ReasonID>
    <d2p1:SystemDefined>true</d2p1:SystemDefined>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfListEndorsementReasonDTO>