POST api/policies/getpolicyendorsements

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PolicyID	integer	None.
EndorsementStatusID	integer	None.
Header	RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "PolicyID": 1,
  "EndorsementStatusID": 2,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GetPolicyEndorsementsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <EndorsementStatusID>2</EndorsementStatusID>
  <PolicyID>1</PolicyID>
</GetPolicyEndorsementsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyEndorsementsResponse

Name	Description	Type	Additional information
Endorsements		Collection of PolicyEndorsement	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Endorsements": [
    {
      "PolicyEndorsementID": 1,
      "PolicyEndorsementStatusID": 2,
      "PolicyEndorsementStatusName": "sample string 3",
      "AddedBy": 4,
      "AddedByName": "sample string 5",
      "AddedOn": "2025-12-05T20:27:42.6982417-08:00",
      "ModifiedBy": 7,
      "ModifiedByName": "sample string 8",
      "ModifiedOn": "2025-12-05T20:27:42.6982417-08:00",
      "DocumentPath": "sample string 10",
      "FirmID": 11,
      "PolicyID": 12,
      "FileName": "sample string 13",
      "EndorsementType": "sample string 14",
      "CalculationDocumentPath": "sample string 15",
      "PremiumCalculated": 16.0,
      "PolicyNumber": "sample string 17",
      "PaymentDate": "2025-12-05T20:27:42.6982417-08:00",
      "FirmName": "sample string 18",
      "PolicyTypeName": "sample string 19"
    },
    {
      "PolicyEndorsementID": 1,
      "PolicyEndorsementStatusID": 2,
      "PolicyEndorsementStatusName": "sample string 3",
      "AddedBy": 4,
      "AddedByName": "sample string 5",
      "AddedOn": "2025-12-05T20:27:42.6982417-08:00",
      "ModifiedBy": 7,
      "ModifiedByName": "sample string 8",
      "ModifiedOn": "2025-12-05T20:27:42.6982417-08:00",
      "DocumentPath": "sample string 10",
      "FirmID": 11,
      "PolicyID": 12,
      "FileName": "sample string 13",
      "EndorsementType": "sample string 14",
      "CalculationDocumentPath": "sample string 15",
      "PremiumCalculated": 16.0,
      "PolicyNumber": "sample string 17",
      "PaymentDate": "2025-12-05T20:27:42.6982417-08:00",
      "FirmName": "sample string 18",
      "PolicyTypeName": "sample string 19"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyEndorsementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
  <Endorsements xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:PolicyEndorsement>
      <d2p1:AddedBy>4</d2p1:AddedBy>
      <d2p1:AddedByName>sample string 5</d2p1:AddedByName>
      <d2p1:AddedOn>2025-12-05T20:27:42.6982417-08:00</d2p1:AddedOn>
      <d2p1:CalculationDocumentPath>sample string 15</d2p1:CalculationDocumentPath>
      <d2p1:DocumentPath>sample string 10</d2p1:DocumentPath>
      <d2p1:EndorsementType>sample string 14</d2p1:EndorsementType>
      <d2p1:FileName>sample string 13</d2p1:FileName>
      <d2p1:FirmID>11</d2p1:FirmID>
      <d2p1:FirmName>sample string 18</d2p1:FirmName>
      <d2p1:ModifiedBy>7</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 8</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:27:42.6982417-08:00</d2p1:ModifiedOn>
      <d2p1:PaymentDate>2025-12-05T20:27:42.6982417-08:00</d2p1:PaymentDate>
      <d2p1:PolicyEndorsementID>1</d2p1:PolicyEndorsementID>
      <d2p1:PolicyEndorsementStatusID>2</d2p1:PolicyEndorsementStatusID>
      <d2p1:PolicyEndorsementStatusName>sample string 3</d2p1:PolicyEndorsementStatusName>
      <d2p1:PolicyID>12</d2p1:PolicyID>
      <d2p1:PolicyNumber>sample string 17</d2p1:PolicyNumber>
      <d2p1:PolicyTypeName>sample string 19</d2p1:PolicyTypeName>
      <d2p1:PremiumCalculated>16</d2p1:PremiumCalculated>
    </d2p1:PolicyEndorsement>
    <d2p1:PolicyEndorsement>
      <d2p1:AddedBy>4</d2p1:AddedBy>
      <d2p1:AddedByName>sample string 5</d2p1:AddedByName>
      <d2p1:AddedOn>2025-12-05T20:27:42.6982417-08:00</d2p1:AddedOn>
      <d2p1:CalculationDocumentPath>sample string 15</d2p1:CalculationDocumentPath>
      <d2p1:DocumentPath>sample string 10</d2p1:DocumentPath>
      <d2p1:EndorsementType>sample string 14</d2p1:EndorsementType>
      <d2p1:FileName>sample string 13</d2p1:FileName>
      <d2p1:FirmID>11</d2p1:FirmID>
      <d2p1:FirmName>sample string 18</d2p1:FirmName>
      <d2p1:ModifiedBy>7</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 8</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:27:42.6982417-08:00</d2p1:ModifiedOn>
      <d2p1:PaymentDate>2025-12-05T20:27:42.6982417-08:00</d2p1:PaymentDate>
      <d2p1:PolicyEndorsementID>1</d2p1:PolicyEndorsementID>
      <d2p1:PolicyEndorsementStatusID>2</d2p1:PolicyEndorsementStatusID>
      <d2p1:PolicyEndorsementStatusName>sample string 3</d2p1:PolicyEndorsementStatusName>
      <d2p1:PolicyID>12</d2p1:PolicyID>
      <d2p1:PolicyNumber>sample string 17</d2p1:PolicyNumber>
      <d2p1:PolicyTypeName>sample string 19</d2p1:PolicyTypeName>
      <d2p1:PremiumCalculated>16</d2p1:PremiumCalculated>
    </d2p1:PolicyEndorsement>
  </Endorsements>
</GetPolicyEndorsementsResponse>