POST api/policies/getpolicyendorsementmappings

Request Information

URI Parameters

None.

Body Parameters

GetPolicyEndorsementMappingsRequest
NameDescriptionTypeAdditional information
PolicyID

integer

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<GetPolicyEndorsementMappingsRequest 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>
  <PolicyID>1</PolicyID>
</GetPolicyEndorsementMappingsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyEndorsementMappingsResponse
NameDescriptionTypeAdditional information
EmployeeMappings

Collection of PolicyEndorsementEmployeeMapping

None.

DependentMappings

Collection of PolicyEndorsementEmployeeDependentMapping

None.

HasTrackedEndorsements

boolean

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeMappings": [
    {
      "PolicyEndorsementID": 1,
      "PolicyFirmEmployeeID": 2,
      "ActionValue": "sample string 3",
      "EndorsementType": "sample string 4",
      "AddedOn": "2026-10-17T05:35:25.9733833+00:00"
    },
    {
      "PolicyEndorsementID": 1,
      "PolicyFirmEmployeeID": 2,
      "ActionValue": "sample string 3",
      "EndorsementType": "sample string 4",
      "AddedOn": "2026-10-17T05:35:25.9733833+00:00"
    }
  ],
  "DependentMappings": [
    {
      "PolicyEndorsementID": 1,
      "PolicyFirmEmployeeID": 2,
      "PolicyFirmEmployeeDependentID": 3,
      "ActionValue": "sample string 4",
      "EndorsementType": "sample string 5",
      "AddedOn": "2026-10-17T05:35:25.9733833+00:00"
    },
    {
      "PolicyEndorsementID": 1,
      "PolicyFirmEmployeeID": 2,
      "PolicyFirmEmployeeDependentID": 3,
      "ActionValue": "sample string 4",
      "EndorsementType": "sample string 5",
      "AddedOn": "2026-10-17T05:35:25.9733833+00:00"
    }
  ],
  "HasTrackedEndorsements": true,
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyEndorsementMappingsResponse 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>
  <DependentMappings>
    <PolicyEndorsementEmployeeDependentMapping>
      <ActionValue>sample string 4</ActionValue>
      <AddedOn>2026-10-17T05:35:25.9733833+00:00</AddedOn>
      <EndorsementType>sample string 5</EndorsementType>
      <PolicyEndorsementID>1</PolicyEndorsementID>
      <PolicyFirmEmployeeDependentID>3</PolicyFirmEmployeeDependentID>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
    </PolicyEndorsementEmployeeDependentMapping>
    <PolicyEndorsementEmployeeDependentMapping>
      <ActionValue>sample string 4</ActionValue>
      <AddedOn>2026-10-17T05:35:25.9733833+00:00</AddedOn>
      <EndorsementType>sample string 5</EndorsementType>
      <PolicyEndorsementID>1</PolicyEndorsementID>
      <PolicyFirmEmployeeDependentID>3</PolicyFirmEmployeeDependentID>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
    </PolicyEndorsementEmployeeDependentMapping>
  </DependentMappings>
  <EmployeeMappings>
    <PolicyEndorsementEmployeeMapping>
      <ActionValue>sample string 3</ActionValue>
      <AddedOn>2026-10-17T05:35:25.9733833+00:00</AddedOn>
      <EndorsementType>sample string 4</EndorsementType>
      <PolicyEndorsementID>1</PolicyEndorsementID>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
    </PolicyEndorsementEmployeeMapping>
    <PolicyEndorsementEmployeeMapping>
      <ActionValue>sample string 3</ActionValue>
      <AddedOn>2026-10-17T05:35:25.9733833+00:00</AddedOn>
      <EndorsementType>sample string 4</EndorsementType>
      <PolicyEndorsementID>1</PolicyEndorsementID>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
    </PolicyEndorsementEmployeeMapping>
  </EmployeeMappings>
  <HasTrackedEndorsements>true</HasTrackedEndorsements>
</GetPolicyEndorsementMappingsResponse>