POST api/masters/getpolicybenefitstructuretypes

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PolicyTypeID		integer	None.
Header		RequestHeader	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyBenefitStructureTypesResponse

Name	Description	Type	Additional information
PolicyBenefitStructureTypes		Collection of PolicyBenefitStructureType	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "PolicyBenefitStructureTypes": [
    {
      "PolicyBenefitStructureTypeID": 1,
      "PolicyBenefitStructureTypeTitle": "sample string 2",
      "PolicyTypeID": 3,
      "ValueType": "sample string 4",
      "IsCustom": true,
      "CustomBenefitTitle": "sample string 6"
    },
    {
      "PolicyBenefitStructureTypeID": 1,
      "PolicyBenefitStructureTypeTitle": "sample string 2",
      "PolicyTypeID": 3,
      "ValueType": "sample string 4",
      "IsCustom": true,
      "CustomBenefitTitle": "sample string 6"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyBenefitStructureTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Masters.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>
  <PolicyBenefitStructureTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Masters">
    <d2p1:PolicyBenefitStructureType>
      <d2p1:CustomBenefitTitle>sample string 6</d2p1:CustomBenefitTitle>
      <d2p1:IsCustom>true</d2p1:IsCustom>
      <d2p1:PolicyBenefitStructureTypeID>1</d2p1:PolicyBenefitStructureTypeID>
      <d2p1:PolicyBenefitStructureTypeTitle>sample string 2</d2p1:PolicyBenefitStructureTypeTitle>
      <d2p1:PolicyTypeID>3</d2p1:PolicyTypeID>
      <d2p1:ValueType>sample string 4</d2p1:ValueType>
    </d2p1:PolicyBenefitStructureType>
    <d2p1:PolicyBenefitStructureType>
      <d2p1:CustomBenefitTitle>sample string 6</d2p1:CustomBenefitTitle>
      <d2p1:IsCustom>true</d2p1:IsCustom>
      <d2p1:PolicyBenefitStructureTypeID>1</d2p1:PolicyBenefitStructureTypeID>
      <d2p1:PolicyBenefitStructureTypeTitle>sample string 2</d2p1:PolicyBenefitStructureTypeTitle>
      <d2p1:PolicyTypeID>3</d2p1:PolicyTypeID>
      <d2p1:ValueType>sample string 4</d2p1:ValueType>
    </d2p1:PolicyBenefitStructureType>
  </PolicyBenefitStructureTypes>
</GetPolicyBenefitStructureTypesResponse>