POST api/policies/getpolicies

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IsActive	boolean	None.
FirmID	integer	None.
PolicyTypeID	integer	None.
Header	RequestHeader	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<GetPoliciesRequest 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>
  <FirmID>1</FirmID>
  <IsActive>true</IsActive>
  <PolicyTypeID>1</PolicyTypeID>
</GetPoliciesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPoliciesResponse

Name	Description	Type	Additional information
Policies		Collection of Policy	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Policies": [
    {
      "PolicyID": 1,
      "FirmID": 2,
      "FirmName": "sample string 3",
      "PolicyIssuerID": 4,
      "PolicyIssuerName": "sample string 5",
      "PolicyNumber": "sample string 6",
      "InceptionDate": "2025-12-05T20:25:39.9747911-08:00",
      "ExpiryDate": "2025-12-05T20:25:39.9747911-08:00",
      "CreatedBy": 9,
      "ModifiedBy": 10,
      "IsActive": true,
      "CreatedOn": "2025-12-05T20:25:39.9747911-08:00",
      "ModifiedOn": "2025-12-05T20:25:39.9747911-08:00",
      "CreatedByName": "sample string 14",
      "ModifiedByName": "sample string 15",
      "PolicyIssuerLogo": "sample string 16",
      "TotalEmployees": 17,
      "TotalDependents": 18,
      "TotalGrossPremium": 19.0,
      "PolicyTypeID": 20,
      "AdminID": 21,
      "PolicyTypeName": "sample string 22",
      "AdminName": "sample string 23",
      "PolicyStatusID": 1,
      "PolicyStatusName": "sample string 24",
      "GrossPremiumCalculated": 25.0,
      "GST": 26.0,
      "PolicyPremiumCalculationTypeID": 27,
      "BasePremiumPerThousandOfCTC": 28.0,
      "BasePremiumPerThousandOfSumInsured": 29.0,
      "MultiplesOfCTC": 30,
      "PolicyPremiumCalculationTypeName": "sample string 31",
      "PolicyIssuerNetworkHospitalUrl": "sample string 32",
      "MinimumCTC": 33.0,
      "ClaimsAdminID": 34,
      "ClaimsAdminName": "sample string 35"
    },
    {
      "PolicyID": 1,
      "FirmID": 2,
      "FirmName": "sample string 3",
      "PolicyIssuerID": 4,
      "PolicyIssuerName": "sample string 5",
      "PolicyNumber": "sample string 6",
      "InceptionDate": "2025-12-05T20:25:39.9747911-08:00",
      "ExpiryDate": "2025-12-05T20:25:39.9747911-08:00",
      "CreatedBy": 9,
      "ModifiedBy": 10,
      "IsActive": true,
      "CreatedOn": "2025-12-05T20:25:39.9747911-08:00",
      "ModifiedOn": "2025-12-05T20:25:39.9747911-08:00",
      "CreatedByName": "sample string 14",
      "ModifiedByName": "sample string 15",
      "PolicyIssuerLogo": "sample string 16",
      "TotalEmployees": 17,
      "TotalDependents": 18,
      "TotalGrossPremium": 19.0,
      "PolicyTypeID": 20,
      "AdminID": 21,
      "PolicyTypeName": "sample string 22",
      "AdminName": "sample string 23",
      "PolicyStatusID": 1,
      "PolicyStatusName": "sample string 24",
      "GrossPremiumCalculated": 25.0,
      "GST": 26.0,
      "PolicyPremiumCalculationTypeID": 27,
      "BasePremiumPerThousandOfCTC": 28.0,
      "BasePremiumPerThousandOfSumInsured": 29.0,
      "MultiplesOfCTC": 30,
      "PolicyPremiumCalculationTypeName": "sample string 31",
      "PolicyIssuerNetworkHospitalUrl": "sample string 32",
      "MinimumCTC": 33.0,
      "ClaimsAdminID": 34,
      "ClaimsAdminName": "sample string 35"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPoliciesResponse 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>
  <Policies xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:Policy>
      <d2p1:AdminID>21</d2p1:AdminID>
      <d2p1:AdminName>sample string 23</d2p1:AdminName>
      <d2p1:BasePremiumPerThousandOfCTC>28</d2p1:BasePremiumPerThousandOfCTC>
      <d2p1:BasePremiumPerThousandOfSumInsured>29</d2p1:BasePremiumPerThousandOfSumInsured>
      <d2p1:ClaimsAdminID>34</d2p1:ClaimsAdminID>
      <d2p1:ClaimsAdminName>sample string 35</d2p1:ClaimsAdminName>
      <d2p1:CreatedBy>9</d2p1:CreatedBy>
      <d2p1:CreatedByName>sample string 14</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:25:39.9747911-08:00</d2p1:CreatedOn>
      <d2p1:ExpiryDate>2025-12-05T20:25:39.9747911-08:00</d2p1:ExpiryDate>
      <d2p1:FirmID>2</d2p1:FirmID>
      <d2p1:FirmName>sample string 3</d2p1:FirmName>
      <d2p1:GST>26</d2p1:GST>
      <d2p1:GrossPremiumCalculated>25</d2p1:GrossPremiumCalculated>
      <d2p1:InceptionDate>2025-12-05T20:25:39.9747911-08:00</d2p1:InceptionDate>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MinimumCTC>33</d2p1:MinimumCTC>
      <d2p1:ModifiedBy>10</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 15</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:25:39.9747911-08:00</d2p1:ModifiedOn>
      <d2p1:MultiplesOfCTC>30</d2p1:MultiplesOfCTC>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:PolicyIssuerID>4</d2p1:PolicyIssuerID>
      <d2p1:PolicyIssuerLogo>sample string 16</d2p1:PolicyIssuerLogo>
      <d2p1:PolicyIssuerName>sample string 5</d2p1:PolicyIssuerName>
      <d2p1:PolicyIssuerNetworkHospitalUrl>sample string 32</d2p1:PolicyIssuerNetworkHospitalUrl>
      <d2p1:PolicyNumber>sample string 6</d2p1:PolicyNumber>
      <d2p1:PolicyPremiumCalculationTypeID>27</d2p1:PolicyPremiumCalculationTypeID>
      <d2p1:PolicyPremiumCalculationTypeName>sample string 31</d2p1:PolicyPremiumCalculationTypeName>
      <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
      <d2p1:PolicyStatusName>sample string 24</d2p1:PolicyStatusName>
      <d2p1:PolicyTypeID>20</d2p1:PolicyTypeID>
      <d2p1:PolicyTypeName>sample string 22</d2p1:PolicyTypeName>
      <d2p1:TotalDependents>18</d2p1:TotalDependents>
      <d2p1:TotalEmployees>17</d2p1:TotalEmployees>
      <d2p1:TotalGrossPremium>19</d2p1:TotalGrossPremium>
    </d2p1:Policy>
    <d2p1:Policy>
      <d2p1:AdminID>21</d2p1:AdminID>
      <d2p1:AdminName>sample string 23</d2p1:AdminName>
      <d2p1:BasePremiumPerThousandOfCTC>28</d2p1:BasePremiumPerThousandOfCTC>
      <d2p1:BasePremiumPerThousandOfSumInsured>29</d2p1:BasePremiumPerThousandOfSumInsured>
      <d2p1:ClaimsAdminID>34</d2p1:ClaimsAdminID>
      <d2p1:ClaimsAdminName>sample string 35</d2p1:ClaimsAdminName>
      <d2p1:CreatedBy>9</d2p1:CreatedBy>
      <d2p1:CreatedByName>sample string 14</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:25:39.9747911-08:00</d2p1:CreatedOn>
      <d2p1:ExpiryDate>2025-12-05T20:25:39.9747911-08:00</d2p1:ExpiryDate>
      <d2p1:FirmID>2</d2p1:FirmID>
      <d2p1:FirmName>sample string 3</d2p1:FirmName>
      <d2p1:GST>26</d2p1:GST>
      <d2p1:GrossPremiumCalculated>25</d2p1:GrossPremiumCalculated>
      <d2p1:InceptionDate>2025-12-05T20:25:39.9747911-08:00</d2p1:InceptionDate>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MinimumCTC>33</d2p1:MinimumCTC>
      <d2p1:ModifiedBy>10</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 15</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:25:39.9747911-08:00</d2p1:ModifiedOn>
      <d2p1:MultiplesOfCTC>30</d2p1:MultiplesOfCTC>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:PolicyIssuerID>4</d2p1:PolicyIssuerID>
      <d2p1:PolicyIssuerLogo>sample string 16</d2p1:PolicyIssuerLogo>
      <d2p1:PolicyIssuerName>sample string 5</d2p1:PolicyIssuerName>
      <d2p1:PolicyIssuerNetworkHospitalUrl>sample string 32</d2p1:PolicyIssuerNetworkHospitalUrl>
      <d2p1:PolicyNumber>sample string 6</d2p1:PolicyNumber>
      <d2p1:PolicyPremiumCalculationTypeID>27</d2p1:PolicyPremiumCalculationTypeID>
      <d2p1:PolicyPremiumCalculationTypeName>sample string 31</d2p1:PolicyPremiumCalculationTypeName>
      <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
      <d2p1:PolicyStatusName>sample string 24</d2p1:PolicyStatusName>
      <d2p1:PolicyTypeID>20</d2p1:PolicyTypeID>
      <d2p1:PolicyTypeName>sample string 22</d2p1:PolicyTypeName>
      <d2p1:TotalDependents>18</d2p1:TotalDependents>
      <d2p1:TotalEmployees>17</d2p1:TotalEmployees>
      <d2p1:TotalGrossPremium>19</d2p1:TotalGrossPremium>
    </d2p1:Policy>
  </Policies>
</GetPoliciesResponse>