GET api/BenefitReport?Company={Company}&Year={Year}&EffectiveDateFrom={EffectiveDateFrom}&EffectiveDateTo={EffectiveDateTo}&Status={Status}

Request Information

URI Parameters

Name	Type	Additional information
Company	string	Required
Year	string	Required
EffectiveDateFrom	string	Required
EffectiveDateTo	string	Required
Status	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of BenefitReportVm

Name	Type	Additional information
Company	string	None.
EmployeeID	string	None.
EmployeeName	string	None.
OrgLevel1	string	None.
Level2	string	None.
Level3	string	None.
DateHire	date	None.
DateHireDisplay	string	None.
PositionTitle	string	None.
JobGrade	string	None.
Year	string	None.
Status	string	None.
EffectiveDate	date	None.
EffectiveDateDisplay	string	None.
EffectiveDateFrom	string	None.
EffectiveDateTo	string	None.
BenefitOptionPlan	string	None.
Type	string	None.
AcknowledgedBy	string	None.
AcknowledgmentDate	date	None.
AcknowledgmentDateDisplay	string	None.
BenefitItems	Collection of EmployeeBenefitItemVm	None.
Token	string	None.
Id	string	None.
IsActive	boolean	None.
Search	string	None.
CurrentPage	integer	None.
TotalPage	integer	None.
SizePerPage	integer	None.
SortBy	string	None.
searchFilter	Collection of ColFilter	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Company": "sample string 1",
    "EmployeeID": "sample string 2",
    "EmployeeName": "sample string 3",
    "OrgLevel1": "sample string 4",
    "Level2": "sample string 5",
    "Level3": "sample string 6",
    "DateHire": "2025-12-22T19:02:28.9076424+08:00",
    "DateHireDisplay": "22/12/2025",
    "PositionTitle": "sample string 7",
    "JobGrade": "sample string 8",
    "Year": "sample string 9",
    "Status": "sample string 10",
    "EffectiveDate": "2025-12-22T19:02:28.9076424+08:00",
    "EffectiveDateDisplay": "22 December 2025",
    "EffectiveDateFrom": "sample string 11",
    "EffectiveDateTo": "sample string 12",
    "BenefitOptionPlan": "sample string 13",
    "Type": "sample string 14",
    "AcknowledgedBy": "sample string 15",
    "AcknowledgmentDate": "2025-12-22T19:02:28.9076424+08:00",
    "AcknowledgmentDateDisplay": "22 December 2025 19:02:28",
    "BenefitItems": [
      {
        "BenefitItem": "sample string 1",
        "DataType": "sample string 2",
        "Value": "sample string 3",
        "Sequence": 4
      },
      {
        "BenefitItem": "sample string 1",
        "DataType": "sample string 2",
        "Value": "sample string 3",
        "Sequence": 4
      }
    ],
    "Token": "sample string 16",
    "Id": "sample string 17",
    "IsActive": true,
    "Search": "sample string 19",
    "CurrentPage": 20,
    "TotalPage": 21,
    "SizePerPage": 22,
    "SortBy": "sample string 23",
    "searchFilter": [
      {
        "name": "sample string 1",
        "val": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "name": "sample string 1",
        "val": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  {
    "Company": "sample string 1",
    "EmployeeID": "sample string 2",
    "EmployeeName": "sample string 3",
    "OrgLevel1": "sample string 4",
    "Level2": "sample string 5",
    "Level3": "sample string 6",
    "DateHire": "2025-12-22T19:02:28.9076424+08:00",
    "DateHireDisplay": "22/12/2025",
    "PositionTitle": "sample string 7",
    "JobGrade": "sample string 8",
    "Year": "sample string 9",
    "Status": "sample string 10",
    "EffectiveDate": "2025-12-22T19:02:28.9076424+08:00",
    "EffectiveDateDisplay": "22 December 2025",
    "EffectiveDateFrom": "sample string 11",
    "EffectiveDateTo": "sample string 12",
    "BenefitOptionPlan": "sample string 13",
    "Type": "sample string 14",
    "AcknowledgedBy": "sample string 15",
    "AcknowledgmentDate": "2025-12-22T19:02:28.9076424+08:00",
    "AcknowledgmentDateDisplay": "22 December 2025 19:02:28",
    "BenefitItems": [
      {
        "BenefitItem": "sample string 1",
        "DataType": "sample string 2",
        "Value": "sample string 3",
        "Sequence": 4
      },
      {
        "BenefitItem": "sample string 1",
        "DataType": "sample string 2",
        "Value": "sample string 3",
        "Sequence": 4
      }
    ],
    "Token": "sample string 16",
    "Id": "sample string 17",
    "IsActive": true,
    "Search": "sample string 19",
    "CurrentPage": 20,
    "TotalPage": 21,
    "SizePerPage": 22,
    "SortBy": "sample string 23",
    "searchFilter": [
      {
        "name": "sample string 1",
        "val": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "name": "sample string 1",
        "val": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfBenefitReportVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BoardRoom.ViewModels">
  <BenefitReportVm>
    <Company i:nil="true" />
    <CurrentPage>20</CurrentPage>
    <Id>sample string 17</Id>
    <IsActive>true</IsActive>
    <Search>sample string 19</Search>
    <SizePerPage>22</SizePerPage>
    <SortBy>sample string 23</SortBy>
    <Token>sample string 16</Token>
    <TotalPage>21</TotalPage>
    <searchFilter>
      <ColFilter>
        <name>sample string 1</name>
        <val xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </val>
      </ColFilter>
      <ColFilter>
        <name>sample string 1</name>
        <val xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </val>
      </ColFilter>
    </searchFilter>
    <AcknowledgedBy>sample string 15</AcknowledgedBy>
    <AcknowledgmentDate>2025-12-22T19:02:28.9076424+08:00</AcknowledgmentDate>
    <BenefitItems>
      <EmployeeBenefitItemVm>
        <BenefitItem>sample string 1</BenefitItem>
        <DataType>sample string 2</DataType>
        <Sequence>4</Sequence>
        <Value>sample string 3</Value>
      </EmployeeBenefitItemVm>
      <EmployeeBenefitItemVm>
        <BenefitItem>sample string 1</BenefitItem>
        <DataType>sample string 2</DataType>
        <Sequence>4</Sequence>
        <Value>sample string 3</Value>
      </EmployeeBenefitItemVm>
    </BenefitItems>
    <BenefitOptionPlan>sample string 13</BenefitOptionPlan>
    <Company>sample string 1</Company>
    <DateHire>2025-12-22T19:02:28.9076424+08:00</DateHire>
    <EffectiveDate>2025-12-22T19:02:28.9076424+08:00</EffectiveDate>
    <EffectiveDateFrom>sample string 11</EffectiveDateFrom>
    <EffectiveDateTo>sample string 12</EffectiveDateTo>
    <EmployeeID>sample string 2</EmployeeID>
    <EmployeeName>sample string 3</EmployeeName>
    <JobGrade>sample string 8</JobGrade>
    <Level2>sample string 5</Level2>
    <Level3>sample string 6</Level3>
    <OrgLevel1>sample string 4</OrgLevel1>
    <PositionTitle>sample string 7</PositionTitle>
    <Status>sample string 10</Status>
    <Type>sample string 14</Type>
    <Year>sample string 9</Year>
  </BenefitReportVm>
  <BenefitReportVm>
    <Company i:nil="true" />
    <CurrentPage>20</CurrentPage>
    <Id>sample string 17</Id>
    <IsActive>true</IsActive>
    <Search>sample string 19</Search>
    <SizePerPage>22</SizePerPage>
    <SortBy>sample string 23</SortBy>
    <Token>sample string 16</Token>
    <TotalPage>21</TotalPage>
    <searchFilter>
      <ColFilter>
        <name>sample string 1</name>
        <val xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </val>
      </ColFilter>
      <ColFilter>
        <name>sample string 1</name>
        <val xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </val>
      </ColFilter>
    </searchFilter>
    <AcknowledgedBy>sample string 15</AcknowledgedBy>
    <AcknowledgmentDate>2025-12-22T19:02:28.9076424+08:00</AcknowledgmentDate>
    <BenefitItems>
      <EmployeeBenefitItemVm>
        <BenefitItem>sample string 1</BenefitItem>
        <DataType>sample string 2</DataType>
        <Sequence>4</Sequence>
        <Value>sample string 3</Value>
      </EmployeeBenefitItemVm>
      <EmployeeBenefitItemVm>
        <BenefitItem>sample string 1</BenefitItem>
        <DataType>sample string 2</DataType>
        <Sequence>4</Sequence>
        <Value>sample string 3</Value>
      </EmployeeBenefitItemVm>
    </BenefitItems>
    <BenefitOptionPlan>sample string 13</BenefitOptionPlan>
    <Company>sample string 1</Company>
    <DateHire>2025-12-22T19:02:28.9076424+08:00</DateHire>
    <EffectiveDate>2025-12-22T19:02:28.9076424+08:00</EffectiveDate>
    <EffectiveDateFrom>sample string 11</EffectiveDateFrom>
    <EffectiveDateTo>sample string 12</EffectiveDateTo>
    <EmployeeID>sample string 2</EmployeeID>
    <EmployeeName>sample string 3</EmployeeName>
    <JobGrade>sample string 8</JobGrade>
    <Level2>sample string 5</Level2>
    <Level3>sample string 6</Level3>
    <OrgLevel1>sample string 4</OrgLevel1>
    <PositionTitle>sample string 7</PositionTitle>
    <Status>sample string 10</Status>
    <Type>sample string 14</Type>
    <Year>sample string 9</Year>
  </BenefitReportVm>
</ArrayOfBenefitReportVm>