GET api/Reports/Family?companyId={companyId}&remainOption={remainOption}&isExport={isExport}

Family Report

Request Information

URI Parameters

Name	Type	Additional information
companyId	integer	Required
remainOption	integer	Required
isExport	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ServiceResultTypedOfListOfReportFamily

Name	Type	Additional information
Code	integer	None.
Errors	Collection of string	None.
Data	Collection of ReportFamily	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "EmployeeId": 1,
      "EmployeeNo": "sample string 2",
      "EmployeeName": "sample string 3",
      "EmployeeSurname": "sample string 4",
      "EmployeeFullName": "sample string 5",
      "GradeName": "sample string 6",
      "EmployeeCostCenter": "sample string 7",
      "WorkLocationName": "sample string 8",
      "FamilyName": "sample string 9",
      "FamilySurname": "sample string 10",
      "FamilyCitizenId": "sample string 11",
      "FamilyBirthDate": "2026-04-01T16:51:21.3922246+07:00",
      "FamilyGender": "sample string 13",
      "BankNo": "sample string 14",
      "BankName": "sample string 15",
      "TypeOfFamily": "sample string 16",
      "EffectiveDate": "2026-04-01T16:51:21.3922246+07:00",
      "EffectiveEndDate": "2026-04-01T16:51:21.3922246+07:00",
      "Relation": "sample string 19",
      "Flag": "sample string 20",
      "FamilyBasePlanName": "sample string 21",
      "FamilyTopUpPlanName": "sample string 22",
      "EmployeeBasePlanName": "sample string 23",
      "CompanyCode": "sample string 24",
      "EmailAddress": "sample string 25",
      "RemainAmount": 26.0,
      "EmployeeCoverages": [
        {
          "CoverageId": 1,
          "CoverageName": "sample string 2",
          "CoverageHospitalId": 1,
          "CoverageHospitalName": "sample string 3"
        },
        {
          "CoverageId": 1,
          "CoverageName": "sample string 2",
          "CoverageHospitalId": 1,
          "CoverageHospitalName": "sample string 3"
        }
      ],
      "MeClaimNo": "sample string 27",
      "MemberNo": "sample string 28",
      "DependentNo": "sample string 29",
      "SystemNo": "sample string 30",
      "PolicyNo": "sample string 31",
      "PolicyYear": "sample string 32"
    },
    {
      "EmployeeId": 1,
      "EmployeeNo": "sample string 2",
      "EmployeeName": "sample string 3",
      "EmployeeSurname": "sample string 4",
      "EmployeeFullName": "sample string 5",
      "GradeName": "sample string 6",
      "EmployeeCostCenter": "sample string 7",
      "WorkLocationName": "sample string 8",
      "FamilyName": "sample string 9",
      "FamilySurname": "sample string 10",
      "FamilyCitizenId": "sample string 11",
      "FamilyBirthDate": "2026-04-01T16:51:21.3922246+07:00",
      "FamilyGender": "sample string 13",
      "BankNo": "sample string 14",
      "BankName": "sample string 15",
      "TypeOfFamily": "sample string 16",
      "EffectiveDate": "2026-04-01T16:51:21.3922246+07:00",
      "EffectiveEndDate": "2026-04-01T16:51:21.3922246+07:00",
      "Relation": "sample string 19",
      "Flag": "sample string 20",
      "FamilyBasePlanName": "sample string 21",
      "FamilyTopUpPlanName": "sample string 22",
      "EmployeeBasePlanName": "sample string 23",
      "CompanyCode": "sample string 24",
      "EmailAddress": "sample string 25",
      "RemainAmount": 26.0,
      "EmployeeCoverages": [
        {
          "CoverageId": 1,
          "CoverageName": "sample string 2",
          "CoverageHospitalId": 1,
          "CoverageHospitalName": "sample string 3"
        },
        {
          "CoverageId": 1,
          "CoverageName": "sample string 2",
          "CoverageHospitalId": 1,
          "CoverageHospitalName": "sample string 3"
        }
      ],
      "MeClaimNo": "sample string 27",
      "MemberNo": "sample string 28",
      "DependentNo": "sample string 29",
      "SystemNo": "sample string 30",
      "PolicyNo": "sample string 31",
      "PolicyYear": "sample string 32"
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"EmployeeId":1,"EmployeeNo":"sample string 2","EmployeeName":"sample string 3","EmployeeSurname":"sample string 4","EmployeeFullName":"sample string 5","GradeName":"sample string 6","EmployeeCostCenter":"sample string 7","WorkLocationName":"sample string 8","FamilyName":"sample string 9","FamilySurname":"sample string 10","FamilyCitizenId":"sample string 11","FamilyBirthDate":"2026-04-01T16:51:21.3922246+07:00","FamilyGender":"sample string 13","BankNo":"sample string 14","BankName":"sample string 15","TypeOfFamily":"sample string 16","EffectiveDate":"2026-04-01T16:51:21.3922246+07:00","EffectiveEndDate":"2026-04-01T16:51:21.3922246+07:00","Relation":"sample string 19","Flag":"sample string 20","FamilyBasePlanName":"sample string 21","FamilyTopUpPlanName":"sample string 22","EmployeeBasePlanName":"sample string 23","CompanyCode":"sample string 24","EmailAddress":"sample string 25","RemainAmount":26.0,"EmployeeCoverages":[{"CoverageId":1,"CoverageName":"sample string 2","CoverageHospitalId":1,"CoverageHospitalName":"sample string 3"},{"CoverageId":1,"CoverageName":"sample string 2","CoverageHospitalId":1,"CoverageHospitalName":"sample string 3"}],"MeClaimNo":"sample string 27","MemberNo":"sample string 28","DependentNo":"sample string 29","SystemNo":"sample string 30","PolicyNo":"sample string 31","PolicyYear":"sample string 32"},{"EmployeeId":1,"EmployeeNo":"sample string 2","EmployeeName":"sample string 3","EmployeeSurname":"sample string 4","EmployeeFullName":"sample string 5","GradeName":"sample string 6","EmployeeCostCenter":"sample string 7","WorkLocationName":"sample string 8","FamilyName":"sample string 9","FamilySurname":"sample string 10","FamilyCitizenId":"sample string 11","FamilyBirthDate":"2026-04-01T16:51:21.3922246+07:00","FamilyGender":"sample string 13","BankNo":"sample string 14","BankName":"sample string 15","TypeOfFamily":"sample string 16","EffectiveDate":"2026-04-01T16:51:21.3922246+07:00","EffectiveEndDate":"2026-04-01T16:51:21.3922246+07:00","Relation":"sample string 19","Flag":"sample string 20","FamilyBasePlanName":"sample string 21","FamilyTopUpPlanName":"sample string 22","EmployeeBasePlanName":"sample string 23","CompanyCode":"sample string 24","EmailAddress":"sample string 25","RemainAmount":26.0,"EmployeeCoverages":[{"CoverageId":1,"CoverageName":"sample string 2","CoverageHospitalId":1,"CoverageHospitalName":"sample string 3"},{"CoverageId":1,"CoverageName":"sample string 2","CoverageHospitalId":1,"CoverageHospitalName":"sample string 3"}],"MeClaimNo":"sample string 27","MemberNo":"sample string 28","DependentNo":"sample string 29","SystemNo":"sample string 30","PolicyNo":"sample string 31","PolicyYear":"sample string 32"}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfReportFamilyYj8O1tFc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSW.Common.Models">
  <Code>1</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TTMWM_MECLAIM_API.ViewModels">
    <d2p1:ReportFamily>
      <d2p1:BankName>sample string 15</d2p1:BankName>
      <d2p1:BankNo>sample string 14</d2p1:BankNo>
      <d2p1:CompanyCode>sample string 24</d2p1:CompanyCode>
      <d2p1:DependentNo>sample string 29</d2p1:DependentNo>
      <d2p1:EffectiveDate>2026-04-01T16:51:21.3922246+07:00</d2p1:EffectiveDate>
      <d2p1:EffectiveEndDate>2026-04-01T16:51:21.3922246+07:00</d2p1:EffectiveEndDate>
      <d2p1:EmailAddress>sample string 25</d2p1:EmailAddress>
      <d2p1:EmployeeBasePlanName>sample string 23</d2p1:EmployeeBasePlanName>
      <d2p1:EmployeeCostCenter>sample string 7</d2p1:EmployeeCostCenter>
      <d2p1:EmployeeCoverages>
        <d2p1:EmployeeCoverageDetail>
          <d2p1:CoverageHospitalId>1</d2p1:CoverageHospitalId>
          <d2p1:CoverageHospitalName>sample string 3</d2p1:CoverageHospitalName>
          <d2p1:CoverageId>1</d2p1:CoverageId>
          <d2p1:CoverageName>sample string 2</d2p1:CoverageName>
        </d2p1:EmployeeCoverageDetail>
        <d2p1:EmployeeCoverageDetail>
          <d2p1:CoverageHospitalId>1</d2p1:CoverageHospitalId>
          <d2p1:CoverageHospitalName>sample string 3</d2p1:CoverageHospitalName>
          <d2p1:CoverageId>1</d2p1:CoverageId>
          <d2p1:CoverageName>sample string 2</d2p1:CoverageName>
        </d2p1:EmployeeCoverageDetail>
      </d2p1:EmployeeCoverages>
      <d2p1:EmployeeFullName>sample string 5</d2p1:EmployeeFullName>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
      <d2p1:EmployeeName>sample string 3</d2p1:EmployeeName>
      <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
      <d2p1:EmployeeSurname>sample string 4</d2p1:EmployeeSurname>
      <d2p1:FamilyBasePlanName>sample string 21</d2p1:FamilyBasePlanName>
      <d2p1:FamilyBirthDate>2026-04-01T16:51:21.3922246+07:00</d2p1:FamilyBirthDate>
      <d2p1:FamilyCitizenId>sample string 11</d2p1:FamilyCitizenId>
      <d2p1:FamilyGender>sample string 13</d2p1:FamilyGender>
      <d2p1:FamilyName>sample string 9</d2p1:FamilyName>
      <d2p1:FamilySurname>sample string 10</d2p1:FamilySurname>
      <d2p1:FamilyTopUpPlanName>sample string 22</d2p1:FamilyTopUpPlanName>
      <d2p1:Flag>sample string 20</d2p1:Flag>
      <d2p1:GradeName>sample string 6</d2p1:GradeName>
      <d2p1:MeClaimNo>sample string 27</d2p1:MeClaimNo>
      <d2p1:MemberNo>sample string 28</d2p1:MemberNo>
      <d2p1:PolicyNo>sample string 31</d2p1:PolicyNo>
      <d2p1:PolicyYear>sample string 32</d2p1:PolicyYear>
      <d2p1:Relation>sample string 19</d2p1:Relation>
      <d2p1:RemainAmount>26</d2p1:RemainAmount>
      <d2p1:SystemNo>sample string 30</d2p1:SystemNo>
      <d2p1:TypeOfFamily>sample string 16</d2p1:TypeOfFamily>
      <d2p1:WorkLocationName>sample string 8</d2p1:WorkLocationName>
    </d2p1:ReportFamily>
    <d2p1:ReportFamily>
      <d2p1:BankName>sample string 15</d2p1:BankName>
      <d2p1:BankNo>sample string 14</d2p1:BankNo>
      <d2p1:CompanyCode>sample string 24</d2p1:CompanyCode>
      <d2p1:DependentNo>sample string 29</d2p1:DependentNo>
      <d2p1:EffectiveDate>2026-04-01T16:51:21.3922246+07:00</d2p1:EffectiveDate>
      <d2p1:EffectiveEndDate>2026-04-01T16:51:21.3922246+07:00</d2p1:EffectiveEndDate>
      <d2p1:EmailAddress>sample string 25</d2p1:EmailAddress>
      <d2p1:EmployeeBasePlanName>sample string 23</d2p1:EmployeeBasePlanName>
      <d2p1:EmployeeCostCenter>sample string 7</d2p1:EmployeeCostCenter>
      <d2p1:EmployeeCoverages>
        <d2p1:EmployeeCoverageDetail>
          <d2p1:CoverageHospitalId>1</d2p1:CoverageHospitalId>
          <d2p1:CoverageHospitalName>sample string 3</d2p1:CoverageHospitalName>
          <d2p1:CoverageId>1</d2p1:CoverageId>
          <d2p1:CoverageName>sample string 2</d2p1:CoverageName>
        </d2p1:EmployeeCoverageDetail>
        <d2p1:EmployeeCoverageDetail>
          <d2p1:CoverageHospitalId>1</d2p1:CoverageHospitalId>
          <d2p1:CoverageHospitalName>sample string 3</d2p1:CoverageHospitalName>
          <d2p1:CoverageId>1</d2p1:CoverageId>
          <d2p1:CoverageName>sample string 2</d2p1:CoverageName>
        </d2p1:EmployeeCoverageDetail>
      </d2p1:EmployeeCoverages>
      <d2p1:EmployeeFullName>sample string 5</d2p1:EmployeeFullName>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
      <d2p1:EmployeeName>sample string 3</d2p1:EmployeeName>
      <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
      <d2p1:EmployeeSurname>sample string 4</d2p1:EmployeeSurname>
      <d2p1:FamilyBasePlanName>sample string 21</d2p1:FamilyBasePlanName>
      <d2p1:FamilyBirthDate>2026-04-01T16:51:21.3922246+07:00</d2p1:FamilyBirthDate>
      <d2p1:FamilyCitizenId>sample string 11</d2p1:FamilyCitizenId>
      <d2p1:FamilyGender>sample string 13</d2p1:FamilyGender>
      <d2p1:FamilyName>sample string 9</d2p1:FamilyName>
      <d2p1:FamilySurname>sample string 10</d2p1:FamilySurname>
      <d2p1:FamilyTopUpPlanName>sample string 22</d2p1:FamilyTopUpPlanName>
      <d2p1:Flag>sample string 20</d2p1:Flag>
      <d2p1:GradeName>sample string 6</d2p1:GradeName>
      <d2p1:MeClaimNo>sample string 27</d2p1:MeClaimNo>
      <d2p1:MemberNo>sample string 28</d2p1:MemberNo>
      <d2p1:PolicyNo>sample string 31</d2p1:PolicyNo>
      <d2p1:PolicyYear>sample string 32</d2p1:PolicyYear>
      <d2p1:Relation>sample string 19</d2p1:Relation>
      <d2p1:RemainAmount>26</d2p1:RemainAmount>
      <d2p1:SystemNo>sample string 30</d2p1:SystemNo>
      <d2p1:TypeOfFamily>sample string 16</d2p1:TypeOfFamily>
      <d2p1:WorkLocationName>sample string 8</d2p1:WorkLocationName>
    </d2p1:ReportFamily>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ServiceResultTypedOfArrayOfReportFamilyYj8O1tFc>