POST api/policies/getpolicybenefitstructures

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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:

<GetPolicyBenefitStructuresRequest 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>
</GetPolicyBenefitStructuresRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyBenefitStructuresResponse

Name	Description	Type	Additional information
PolicyBenefitStructures		Collection of PolicyBenefitStructure	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "PolicyBenefitStructures": [
    {
      "PolicyBenefitStructureID": 1,
      "PolicyID": 2,
      "PolicyBenefitStructureTypeID": 3,
      "PolicyBenefitStructureTypeTitle": "sample string 4",
      "ValueType": "sample string 5",
      "Answer": "sample string 6",
      "CustomBenefitTitle": "sample string 7",
      "IsCustom": true
    },
    {
      "PolicyBenefitStructureID": 1,
      "PolicyID": 2,
      "PolicyBenefitStructureTypeID": 3,
      "PolicyBenefitStructureTypeTitle": "sample string 4",
      "ValueType": "sample string 5",
      "Answer": "sample string 6",
      "CustomBenefitTitle": "sample string 7",
      "IsCustom": true
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyBenefitStructuresResponse 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>
  <PolicyBenefitStructures xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:PolicyBenefitStructure>
      <d2p1:Answer>sample string 6</d2p1:Answer>
      <d2p1:CustomBenefitTitle>sample string 7</d2p1:CustomBenefitTitle>
      <d2p1:IsCustom>true</d2p1:IsCustom>
      <d2p1:PolicyBenefitStructureID>1</d2p1:PolicyBenefitStructureID>
      <d2p1:PolicyBenefitStructureTypeID>3</d2p1:PolicyBenefitStructureTypeID>
      <d2p1:PolicyBenefitStructureTypeTitle>sample string 4</d2p1:PolicyBenefitStructureTypeTitle>
      <d2p1:PolicyID>2</d2p1:PolicyID>
      <d2p1:ValueType>sample string 5</d2p1:ValueType>
    </d2p1:PolicyBenefitStructure>
    <d2p1:PolicyBenefitStructure>
      <d2p1:Answer>sample string 6</d2p1:Answer>
      <d2p1:CustomBenefitTitle>sample string 7</d2p1:CustomBenefitTitle>
      <d2p1:IsCustom>true</d2p1:IsCustom>
      <d2p1:PolicyBenefitStructureID>1</d2p1:PolicyBenefitStructureID>
      <d2p1:PolicyBenefitStructureTypeID>3</d2p1:PolicyBenefitStructureTypeID>
      <d2p1:PolicyBenefitStructureTypeTitle>sample string 4</d2p1:PolicyBenefitStructureTypeTitle>
      <d2p1:PolicyID>2</d2p1:PolicyID>
      <d2p1:ValueType>sample string 5</d2p1:ValueType>
    </d2p1:PolicyBenefitStructure>
  </PolicyBenefitStructures>
</GetPolicyBenefitStructuresResponse>