GET v1/clientPolicyTransactions/getPolicyetails?policyNo={policyNo}&businessTypeCode={businessTypeCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
policyNo		string	Required
businessTypeCode		string	Required

Body Parameters

None.

Response Information

Resource Description

getPolicyetailsResult

Name	Type	Additional information
success	boolean	None.
message	string	None.
errorMsg	string	None.
policydetailGB	policy_details_GB	None.
policydetailLF		None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "policydetailGB": {
    "startDate": "sample string 1",
    "endDate": "sample string 2",
    "paymentFrequency": "sample string 3",
    "benefitAmount": 4.0,
    "clientCode": 5,
    "PremiumAmount": 6.0,
    "number_month_covered": 7,
    "policyCode": "sample string 8",
    "coverType": "sample string 9",
    "PolicyNo": "sample string 10",
    "coverDaysLeft": "sample string 11",
    "riskItems": [
      {
        "riskDesc": "sample string 1",
        "riskID": "sample string 2",
        "coverStartDate": "sample string 3",
        "coverEndDate": "sample string 4",
        "coverType": "sample string 5"
      },
      {
        "riskDesc": "sample string 1",
        "riskID": "sample string 2",
        "coverStartDate": "sample string 3",
        "coverEndDate": "sample string 4",
        "coverType": "sample string 5"
      }
    ],
    "policyDocument": [
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      },
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      }
    ],
    "certificateDocument": [
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      },
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      }
    ],
    "manager": {
      "picture_url": "sample string 1",
      "fullname": "sample string 2",
      "emailAddress": "sample string 3",
      "mobileNo": "sample string 4"
    },
    "expectedPayment": {
      "amount": 1.0,
      "dueDate": "sample string 2",
      "payableNow": true,
      "allowAmountEdit": true
    }
  },
  "policydetailLF": {
    "startDate": "sample string 1",
    "endDate": "sample string 2",
    "paymentFrequency": "sample string 3",
    "benefitAmount": 4.0,
    "companyName": "sample string 5",
    "policyNo": "sample string 6",
    "maturityDate": "sample string 7",
    "contributionAmount": 8.0,
    "targetAmount": 9.0,
    "percentage": 10.0,
    "myPremium": 11.0,
    "nextPremium": "sample string 12",
    "PremiumAmount": 13.0,
    "policyDocument": [
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      },
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      }
    ],
    "certificateDocument": [
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      },
      {
        "documentName": "sample string 1",
        "document_url": "sample string 2"
      }
    ],
    "beneficiary": [
      {
        "name": "sample string 1",
        "percentage": 2.0,
        "relationship": "sample string 3"
      },
      {
        "name": "sample string 1",
        "percentage": 2.0,
        "relationship": "sample string 3"
      }
    ],
    "number_month_covered": 14,
    "manager": {
      "picture_url": "sample string 1",
      "fullname": "sample string 2",
      "emailAddress": "sample string 3",
      "mobileNo": "sample string 4"
    },
    "expectedPayment": {
      "amount": 1.0,
      "dueDate": "sample string 2",
      "payableNow": true,
      "allowAmountEdit": true
    }
  }
}

application/xml, text/xml

Sample:

<getPolicyetailsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.getPolicyetails">
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <policydetailGB>
    <PolicyNo>sample string 10</PolicyNo>
    <PremiumAmount>6</PremiumAmount>
    <benefitAmount>4</benefitAmount>
    <certificateDocument>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
    </certificateDocument>
    <clientCode>5</clientCode>
    <coverDaysLeft>sample string 11</coverDaysLeft>
    <coverType>sample string 9</coverType>
    <endDate>sample string 2</endDate>
    <expectedPayment>
      <allowAmountEdit>true</allowAmountEdit>
      <amount>1</amount>
      <dueDate>sample string 2</dueDate>
      <payableNow>true</payableNow>
    </expectedPayment>
    <manager>
      <emailAddress>sample string 3</emailAddress>
      <fullname>sample string 2</fullname>
      <mobileNo>sample string 4</mobileNo>
      <picture_url>sample string 1</picture_url>
    </manager>
    <number_month_covered>7</number_month_covered>
    <paymentFrequency>sample string 3</paymentFrequency>
    <policyCode>sample string 8</policyCode>
    <policyDocument>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
    </policyDocument>
    <riskItems>
      <getPolicyetailsResult.policy_risk>
        <coverEndDate>sample string 4</coverEndDate>
        <coverStartDate>sample string 3</coverStartDate>
        <coverType>sample string 5</coverType>
        <riskDesc>sample string 1</riskDesc>
        <riskID>sample string 2</riskID>
      </getPolicyetailsResult.policy_risk>
      <getPolicyetailsResult.policy_risk>
        <coverEndDate>sample string 4</coverEndDate>
        <coverStartDate>sample string 3</coverStartDate>
        <coverType>sample string 5</coverType>
        <riskDesc>sample string 1</riskDesc>
        <riskID>sample string 2</riskID>
      </getPolicyetailsResult.policy_risk>
    </riskItems>
    <startDate>sample string 1</startDate>
  </policydetailGB>
  <policydetailLF>
    <PremiumAmount>13</PremiumAmount>
    <beneficiary>
      <getPolicyetailsResult.beneficiaryDataItem>
        <name>sample string 1</name>
        <percentage>2</percentage>
        <relationship>sample string 3</relationship>
      </getPolicyetailsResult.beneficiaryDataItem>
      <getPolicyetailsResult.beneficiaryDataItem>
        <name>sample string 1</name>
        <percentage>2</percentage>
        <relationship>sample string 3</relationship>
      </getPolicyetailsResult.beneficiaryDataItem>
    </beneficiary>
    <benefitAmount>4</benefitAmount>
    <certificateDocument>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
    </certificateDocument>
    <companyName>sample string 5</companyName>
    <contributionAmount>8</contributionAmount>
    <endDate>sample string 2</endDate>
    <expectedPayment>
      <allowAmountEdit>true</allowAmountEdit>
      <amount>1</amount>
      <dueDate>sample string 2</dueDate>
      <payableNow>true</payableNow>
    </expectedPayment>
    <manager>
      <emailAddress>sample string 3</emailAddress>
      <fullname>sample string 2</fullname>
      <mobileNo>sample string 4</mobileNo>
      <picture_url>sample string 1</picture_url>
    </manager>
    <maturityDate>sample string 7</maturityDate>
    <myPremium>11</myPremium>
    <nextPremium>sample string 12</nextPremium>
    <number_month_covered>14</number_month_covered>
    <paymentFrequency>sample string 3</paymentFrequency>
    <percentage>10</percentage>
    <policyDocument>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
      <getPolicyetailsResult.policy_document>
        <documentName>sample string 1</documentName>
        <document_url>sample string 2</document_url>
      </getPolicyetailsResult.policy_document>
    </policyDocument>
    <policyNo>sample string 6</policyNo>
    <startDate>sample string 1</startDate>
    <targetAmount>9</targetAmount>
  </policydetailLF>
  <success>true</success>
</getPolicyetailsResult>

text/html

Sample:

{"success":true,"message":"sample string 2","errorMsg":"sample string 3","policydetailGB":{"startDate":"sample string 1","endDate":"sample string 2","paymentFrequency":"sample string 3","benefitAmount":4.0,"clientCode":5,"PremiumAmount":6.0,"number_month_covered":7,"policyCode":"sample string 8","coverType":"sample string 9","PolicyNo":"sample string 10","coverDaysLeft":"sample string 11","riskItems":[{"riskDesc":"sample string 1","riskID":"sample string 2","coverStartDate":"sample string 3","coverEndDate":"sample string 4","coverType":"sample string 5"},{"riskDesc":"sample string 1","riskID":"sample string 2","coverStartDate":"sample string 3","coverEndDate":"sample string 4","coverType":"sample string 5"}],"policyDocument":[{"documentName":"sample string 1","document_url":"sample string 2"},{"documentName":"sample string 1","document_url":"sample string 2"}],"certificateDocument":[{"documentName":"sample string 1","document_url":"sample string 2"},{"documentName":"sample string 1","document_url":"sample string 2"}],"manager":{"picture_url":"sample string 1","fullname":"sample string 2","emailAddress":"sample string 3","mobileNo":"sample string 4"},"expectedPayment":{"amount":1.0,"dueDate":"sample string 2","payableNow":true,"allowAmountEdit":true}},"policydetailLF":{"startDate":"sample string 1","endDate":"sample string 2","paymentFrequency":"sample string 3","benefitAmount":4.0,"companyName":"sample string 5","policyNo":"sample string 6","maturityDate":"sample string 7","contributionAmount":8.0,"targetAmount":9.0,"percentage":10.0,"myPremium":11.0,"nextPremium":"sample string 12","PremiumAmount":13.0,"policyDocument":[{"documentName":"sample string 1","document_url":"sample string 2"},{"documentName":"sample string 1","document_url":"sample string 2"}],"certificateDocument":[{"documentName":"sample string 1","document_url":"sample string 2"},{"documentName":"sample string 1","document_url":"sample string 2"}],"beneficiary":[{"name":"sample string 1","percentage":2.0,"relationship":"sample string 3"},{"name":"sample string 1","percentage":2.0,"relationship":"sample string 3"}],"number_month_covered":14,"manager":{"picture_url":"sample string 1","fullname":"sample string 2","emailAddress":"sample string 3","mobileNo":"sample string 4"},"expectedPayment":{"amount":1.0,"dueDate":"sample string 2","payableNow":true,"allowAmountEdit":true}}}