GET api/BenefitPlans/{companyId}?includeInactive={includeInactive}

Return all BenefitPlans for a Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	Required
includeInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

List of BenefitPlan

ServiceResultTypedOfListOfBenefitPlan

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

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "Note": "sample string 1",
      "IsActive": true,
      "BenefitPlanId": 1,
      "CompanyId": 2,
      "BenefitPlanTypeId": 3,
      "BenefitPlanTypeName": "sample string 4",
      "BenefitPlanName": "sample string 5",
      "BenefitAmount": 6.0,
      "InsuranceProviderId": 7,
      "InsuranceProviderName": "sample string 8",
      "HasPlanDocument": true,
      "DocumentFileName": "sample string 10",
      "DocumentURL": "sample string 11",
      "FamilyId": 1,
      "InsuranceFileName": "sample string 12",
      "InsuranceURL": "sample string 13",
      "IPDAmount": 1.0,
      "OPDAmount": 1.0,
      "DentalAmount": 1.0,
      "Over65Amount": 1.0,
      "RoomAmount": 1.0,
      "IsNewcomer": true,
      "IsOver65": true,
      "IsRetire": true
    },
    {
      "Note": "sample string 1",
      "IsActive": true,
      "BenefitPlanId": 1,
      "CompanyId": 2,
      "BenefitPlanTypeId": 3,
      "BenefitPlanTypeName": "sample string 4",
      "BenefitPlanName": "sample string 5",
      "BenefitAmount": 6.0,
      "InsuranceProviderId": 7,
      "InsuranceProviderName": "sample string 8",
      "HasPlanDocument": true,
      "DocumentFileName": "sample string 10",
      "DocumentURL": "sample string 11",
      "FamilyId": 1,
      "InsuranceFileName": "sample string 12",
      "InsuranceURL": "sample string 13",
      "IPDAmount": 1.0,
      "OPDAmount": 1.0,
      "DentalAmount": 1.0,
      "Over65Amount": 1.0,
      "RoomAmount": 1.0,
      "IsNewcomer": true,
      "IsOver65": true,
      "IsRetire": true
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"Note":"sample string 1","IsActive":true,"BenefitPlanId":1,"CompanyId":2,"BenefitPlanTypeId":3,"BenefitPlanTypeName":"sample string 4","BenefitPlanName":"sample string 5","BenefitAmount":6.0,"InsuranceProviderId":7,"InsuranceProviderName":"sample string 8","HasPlanDocument":true,"DocumentFileName":"sample string 10","DocumentURL":"sample string 11","FamilyId":1,"InsuranceFileName":"sample string 12","InsuranceURL":"sample string 13","IPDAmount":1.0,"OPDAmount":1.0,"DentalAmount":1.0,"Over65Amount":1.0,"RoomAmount":1.0,"IsNewcomer":true,"IsOver65":true,"IsRetire":true},{"Note":"sample string 1","IsActive":true,"BenefitPlanId":1,"CompanyId":2,"BenefitPlanTypeId":3,"BenefitPlanTypeName":"sample string 4","BenefitPlanName":"sample string 5","BenefitAmount":6.0,"InsuranceProviderId":7,"InsuranceProviderName":"sample string 8","HasPlanDocument":true,"DocumentFileName":"sample string 10","DocumentURL":"sample string 11","FamilyId":1,"InsuranceFileName":"sample string 12","InsuranceURL":"sample string 13","IPDAmount":1.0,"OPDAmount":1.0,"DentalAmount":1.0,"Over65Amount":1.0,"RoomAmount":1.0,"IsNewcomer":true,"IsOver65":true,"IsRetire":true}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfBenefitPlanYj8O1tFc 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:BenefitPlan>
      <d2p1:BenefitAmount>6</d2p1:BenefitAmount>
      <d2p1:BenefitPlanId>1</d2p1:BenefitPlanId>
      <d2p1:BenefitPlanName>sample string 5</d2p1:BenefitPlanName>
      <d2p1:BenefitPlanTypeId>3</d2p1:BenefitPlanTypeId>
      <d2p1:BenefitPlanTypeName>sample string 4</d2p1:BenefitPlanTypeName>
      <d2p1:CompanyId>2</d2p1:CompanyId>
      <d2p1:DentalAmount>1</d2p1:DentalAmount>
      <d2p1:DocumentFileName>sample string 10</d2p1:DocumentFileName>
      <d2p1:DocumentURL>sample string 11</d2p1:DocumentURL>
      <d2p1:FamilyId>1</d2p1:FamilyId>
      <d2p1:HasPlanDocument>true</d2p1:HasPlanDocument>
      <d2p1:IPDAmount>1</d2p1:IPDAmount>
      <d2p1:InsuranceFileName>sample string 12</d2p1:InsuranceFileName>
      <d2p1:InsuranceProviderId>7</d2p1:InsuranceProviderId>
      <d2p1:InsuranceProviderName>sample string 8</d2p1:InsuranceProviderName>
      <d2p1:InsuranceURL>sample string 13</d2p1:InsuranceURL>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsNewcomer>true</d2p1:IsNewcomer>
      <d2p1:IsOver65>true</d2p1:IsOver65>
      <d2p1:IsRetire>true</d2p1:IsRetire>
      <d2p1:Note>sample string 1</d2p1:Note>
      <d2p1:OPDAmount>1</d2p1:OPDAmount>
      <d2p1:Over65Amount>1</d2p1:Over65Amount>
      <d2p1:RoomAmount>1</d2p1:RoomAmount>
    </d2p1:BenefitPlan>
    <d2p1:BenefitPlan>
      <d2p1:BenefitAmount>6</d2p1:BenefitAmount>
      <d2p1:BenefitPlanId>1</d2p1:BenefitPlanId>
      <d2p1:BenefitPlanName>sample string 5</d2p1:BenefitPlanName>
      <d2p1:BenefitPlanTypeId>3</d2p1:BenefitPlanTypeId>
      <d2p1:BenefitPlanTypeName>sample string 4</d2p1:BenefitPlanTypeName>
      <d2p1:CompanyId>2</d2p1:CompanyId>
      <d2p1:DentalAmount>1</d2p1:DentalAmount>
      <d2p1:DocumentFileName>sample string 10</d2p1:DocumentFileName>
      <d2p1:DocumentURL>sample string 11</d2p1:DocumentURL>
      <d2p1:FamilyId>1</d2p1:FamilyId>
      <d2p1:HasPlanDocument>true</d2p1:HasPlanDocument>
      <d2p1:IPDAmount>1</d2p1:IPDAmount>
      <d2p1:InsuranceFileName>sample string 12</d2p1:InsuranceFileName>
      <d2p1:InsuranceProviderId>7</d2p1:InsuranceProviderId>
      <d2p1:InsuranceProviderName>sample string 8</d2p1:InsuranceProviderName>
      <d2p1:InsuranceURL>sample string 13</d2p1:InsuranceURL>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsNewcomer>true</d2p1:IsNewcomer>
      <d2p1:IsOver65>true</d2p1:IsOver65>
      <d2p1:IsRetire>true</d2p1:IsRetire>
      <d2p1:Note>sample string 1</d2p1:Note>
      <d2p1:OPDAmount>1</d2p1:OPDAmount>
      <d2p1:Over65Amount>1</d2p1:Over65Amount>
      <d2p1:RoomAmount>1</d2p1:RoomAmount>
    </d2p1:BenefitPlan>
  </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>
</ServiceResultTypedOfArrayOfBenefitPlanYj8O1tFc>