POST api/policies/getpolicyendorsementdocuments

Request Information

URI Parameters

None.

Body Parameters

GetPolicyEndorsementDocumentsRequest
NameDescriptionTypeAdditional information
PolicyEndorsementID

integer

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyEndorsementID": 1,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<GetPolicyEndorsementDocumentsRequest 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>
  <PolicyEndorsementID>1</PolicyEndorsementID>
</GetPolicyEndorsementDocumentsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyEndorsementDocumentsResponse
NameDescriptionTypeAdditional information
Documents

Collection of PolicyEndorsementDocument

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "Documents": [
    {
      "DocumentPath": "sample string 1",
      "PolicyEndorsementDocumentID": 2,
      "PolicyEndorsementID": 3,
      "PolicyEndorsementDocumentTypeID": 4,
      "PolicyEndorsementDocumentTypeName": "sample string 5",
      "AddedBy": 6,
      "AddedOn": "2025-12-05T20:30:06.3589966-08:00",
      "AddedByName": "sample string 8"
    },
    {
      "DocumentPath": "sample string 1",
      "PolicyEndorsementDocumentID": 2,
      "PolicyEndorsementID": 3,
      "PolicyEndorsementDocumentTypeID": 4,
      "PolicyEndorsementDocumentTypeName": "sample string 5",
      "AddedBy": 6,
      "AddedOn": "2025-12-05T20:30:06.3589966-08:00",
      "AddedByName": "sample string 8"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyEndorsementDocumentsResponse 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>
</GetPolicyEndorsementDocumentsResponse>