PUT api/benefit-plan/{benefitPlanId}/header

Request Information

URI Parameters

Name	Description	Type	Additional information
benefitPlanId		integer	Required

Body Parameters

BenefitPlanModel

Name	Type	Additional information
BenefitPlanId	integer	None.
BenefitPlanToReplicateId	integer	None.
CorporateCompanyId	integer	None.
CorporateId	integer	None.
LocalCompanyName	string	None.
BenefitPlanName	string	None.
BenefitPlanEffectiveDate	date	None.
PlanYear	integer	None.
BenefitPlanBasisId	integer	None.
BenefitPlanBasis	string	None.
GoverningDocument	string	None.
MultiEmployerPlan	boolean	None.
SponsoringOrganizationName	string	None.
GeographicalScopeId	integer	None.
GeographicalScope	string	None.
PlanDesignChanges	boolean	None.
DescribeChanges	string	None.
CountryPresentId	integer	None.
CountryId	integer	None.
CountryName	string	None.
InternationallyMobileEmployees	boolean	None.
FlexBenefitProgramModelId	integer	None.
FlexBenefitProgramModel	string	None.
FlexProgramOtherBenefitsIncluded	string	None.
SelectionProcessBenefitItems	string	None.
FlexBudgetCreditMechanism	string	None.
UnusedBudgetCredits	string	None.
EmployerCost	string	None.
EmployerRole	string	None.
VoluntaryProgramOtherBenefitsIncluded	string	None.
FormBenefitPurchase	string	None.
ComplianceMinumumRequirement	boolean	None.
DescriptionNonCompliance	string	None.
BenefitsLargerMinimumRequirement	boolean	None.
DescriptionExcess	string	None.
OptingOutAallowed	boolean	None.
PlanIntroducedOptOutDefaultRequirement	boolean	None.
PlanComplyOptingOutRequirement	boolean	None.
PlanComplyDescriptionNonCompliance	string	None.
TaxAdvantage	boolean	None.
PlanTaxQualified	boolean	None.
DescriptionNonQualificationItems	string	None.
CoordinationSocialProgram	boolean	None.
IndependentCollectiveBargaining	boolean	None.
DateNextCollectiveBargainingAgreement	date	None.
PeriodicRegulatoryFilings	boolean	None.
EmployeeCommunicationRequirement	boolean	None.
IntegrationWithWorkersCompensation	boolean	None.
EmployerRoleInProgramAdministration	boolean	None.
Remarks	string	None.
StatusId	integer	None.
Status	string	None.
StatusReasonsId	integer	None.
Active	boolean	None.
BenefitCoverage	Collection of BenefitCoverageModel	None.
BenefitCoverageTier	Collection of BenefitCoverageTierModel	None.
BenefitPlanEntities	Collection of BenefitPlanEntitiesResult	None.

Request Formats

application/json, text/json

Sample:

{
  "BenefitPlanId": 1,
  "BenefitPlanToReplicateId": 2,
  "CorporateCompanyId": 3,
  "CorporateId": 4,
  "LocalCompanyName": "sample string 5",
  "BenefitPlanName": "sample string 6",
  "BenefitPlanEffectiveDate": "2024-12-14T22:51:05.9592581+00:00",
  "PlanYear": 8,
  "BenefitPlanBasisId": 1,
  "BenefitPlanBasis": "sample string 9",
  "GoverningDocument": "sample string 10",
  "MultiEmployerPlan": true,
  "SponsoringOrganizationName": "sample string 12",
  "GeographicalScopeId": 13,
  "GeographicalScope": "sample string 14",
  "PlanDesignChanges": true,
  "DescribeChanges": "sample string 16",
  "CountryPresentId": 17,
  "CountryId": 18,
  "CountryName": "sample string 19",
  "InternationallyMobileEmployees": true,
  "FlexBenefitProgramModelId": 21,
  "FlexBenefitProgramModel": "sample string 22",
  "FlexProgramOtherBenefitsIncluded": "sample string 23",
  "SelectionProcessBenefitItems": "sample string 24",
  "FlexBudgetCreditMechanism": "sample string 25",
  "UnusedBudgetCredits": "sample string 26",
  "EmployerCost": "sample string 27",
  "EmployerRole": "sample string 28",
  "VoluntaryProgramOtherBenefitsIncluded": "sample string 29",
  "FormBenefitPurchase": "sample string 30",
  "ComplianceMinumumRequirement": true,
  "DescriptionNonCompliance": "sample string 32",
  "BenefitsLargerMinimumRequirement": true,
  "DescriptionExcess": "sample string 34",
  "OptingOutAallowed": true,
  "PlanIntroducedOptOutDefaultRequirement": true,
  "PlanComplyOptingOutRequirement": true,
  "PlanComplyDescriptionNonCompliance": "sample string 38",
  "TaxAdvantage": true,
  "PlanTaxQualified": true,
  "DescriptionNonQualificationItems": "sample string 41",
  "CoordinationSocialProgram": true,
  "IndependentCollectiveBargaining": true,
  "DateNextCollectiveBargainingAgreement": "2024-12-14T22:51:05.9592581+00:00",
  "PeriodicRegulatoryFilings": true,
  "EmployeeCommunicationRequirement": true,
  "IntegrationWithWorkersCompensation": true,
  "EmployerRoleInProgramAdministration": true,
  "Remarks": "sample string 44",
  "StatusId": 45,
  "Status": "sample string 46",
  "StatusReasonsId": 1,
  "Active": true,
  "BenefitCoverage": [
    {
      "BenefitCoverageId": 1,
      "BenefitPlanId": 2,
      "BenefitProgramAssignId": 3,
      "FlexibleBenefitsProgramIntegration": true,
      "PrimaryBenefitType": true,
      "Active": true
    },
    {
      "BenefitCoverageId": 1,
      "BenefitPlanId": 2,
      "BenefitProgramAssignId": 3,
      "FlexibleBenefitsProgramIntegration": true,
      "PrimaryBenefitType": true,
      "Active": true
    }
  ],
  "BenefitCoverageTier": [
    {
      "BenefitCoverageTierId": 1,
      "BenefitPlanId": 2,
      "TierName": "sample string 3",
      "Active": true
    },
    {
      "BenefitCoverageTierId": 1,
      "BenefitPlanId": 2,
      "TierName": "sample string 3",
      "Active": true
    }
  ],
  "BenefitPlanEntities": [
    {
      "BenefitPlanEntitiesId": 1,
      "BenefitPlanId": 2,
      "CompanyLegalEntityId": 3,
      "CompanyId": 4,
      "EntityName": "sample string 5",
      "CorporateBusinessId": 1,
      "CorporateBusiness": "sample string 6",
      "CorporateLegalEntitiesId": 1,
      "CorporateLegalEntities": "sample string 7",
      "StatusCompany": "sample string 8",
      "Active": true
    },
    {
      "BenefitPlanEntitiesId": 1,
      "BenefitPlanId": 2,
      "CompanyLegalEntityId": 3,
      "CompanyId": 4,
      "EntityName": "sample string 5",
      "CorporateBusinessId": 1,
      "CorporateBusiness": "sample string 6",
      "CorporateLegalEntitiesId": 1,
      "CorporateLegalEntities": "sample string 7",
      "StatusCompany": "sample string 8",
      "Active": true
    }
  ]
}

application/xml, text/xml

Sample:

<BenefitPlanModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALTAMBS.Business.Entities.Models">
  <Active>true</Active>
  <BenefitCoverage>
    <BenefitCoverageModel>
      <Active>true</Active>
      <BenefitCoverageId>1</BenefitCoverageId>
      <BenefitPlanId>2</BenefitPlanId>
      <BenefitProgramAssignId>3</BenefitProgramAssignId>
      <FlexibleBenefitsProgramIntegration>true</FlexibleBenefitsProgramIntegration>
      <PrimaryBenefitType>true</PrimaryBenefitType>
    </BenefitCoverageModel>
    <BenefitCoverageModel>
      <Active>true</Active>
      <BenefitCoverageId>1</BenefitCoverageId>
      <BenefitPlanId>2</BenefitPlanId>
      <BenefitProgramAssignId>3</BenefitProgramAssignId>
      <FlexibleBenefitsProgramIntegration>true</FlexibleBenefitsProgramIntegration>
      <PrimaryBenefitType>true</PrimaryBenefitType>
    </BenefitCoverageModel>
  </BenefitCoverage>
  <BenefitCoverageTier>
    <BenefitCoverageTierModel>
      <Active>true</Active>
      <BenefitCoverageTierId>1</BenefitCoverageTierId>
      <BenefitPlanId>2</BenefitPlanId>
      <TierName>sample string 3</TierName>
    </BenefitCoverageTierModel>
    <BenefitCoverageTierModel>
      <Active>true</Active>
      <BenefitCoverageTierId>1</BenefitCoverageTierId>
      <BenefitPlanId>2</BenefitPlanId>
      <TierName>sample string 3</TierName>
    </BenefitCoverageTierModel>
  </BenefitCoverageTier>
  <BenefitPlanBasis>sample string 9</BenefitPlanBasis>
  <BenefitPlanBasisId>1</BenefitPlanBasisId>
  <BenefitPlanEffectiveDate>2024-12-14T22:51:05.9592581+00:00</BenefitPlanEffectiveDate>
  <BenefitPlanEntities>
    <BenefitPlanEntitiesResult>
      <Active>true</Active>
      <BenefitPlanEntitiesId>1</BenefitPlanEntitiesId>
      <BenefitPlanId>2</BenefitPlanId>
      <CompanyId>4</CompanyId>
      <CompanyLegalEntityId>3</CompanyLegalEntityId>
      <CorporateBusiness>sample string 6</CorporateBusiness>
      <CorporateBusinessId>1</CorporateBusinessId>
      <CorporateLegalEntities>sample string 7</CorporateLegalEntities>
      <CorporateLegalEntitiesId>1</CorporateLegalEntitiesId>
      <EntityName>sample string 5</EntityName>
      <StatusCompany>sample string 8</StatusCompany>
    </BenefitPlanEntitiesResult>
    <BenefitPlanEntitiesResult>
      <Active>true</Active>
      <BenefitPlanEntitiesId>1</BenefitPlanEntitiesId>
      <BenefitPlanId>2</BenefitPlanId>
      <CompanyId>4</CompanyId>
      <CompanyLegalEntityId>3</CompanyLegalEntityId>
      <CorporateBusiness>sample string 6</CorporateBusiness>
      <CorporateBusinessId>1</CorporateBusinessId>
      <CorporateLegalEntities>sample string 7</CorporateLegalEntities>
      <CorporateLegalEntitiesId>1</CorporateLegalEntitiesId>
      <EntityName>sample string 5</EntityName>
      <StatusCompany>sample string 8</StatusCompany>
    </BenefitPlanEntitiesResult>
  </BenefitPlanEntities>
  <BenefitPlanId>1</BenefitPlanId>
  <BenefitPlanName>sample string 6</BenefitPlanName>
  <BenefitPlanToReplicateId>2</BenefitPlanToReplicateId>
  <BenefitsLargerMinimumRequirement>true</BenefitsLargerMinimumRequirement>
  <ComplianceMinumumRequirement>true</ComplianceMinumumRequirement>
  <CoordinationSocialProgram>true</CoordinationSocialProgram>
  <CorporateCompanyId>3</CorporateCompanyId>
  <CorporateId>4</CorporateId>
  <CountryId>18</CountryId>
  <CountryName>sample string 19</CountryName>
  <CountryPresentId>17</CountryPresentId>
  <DateNextCollectiveBargainingAgreement>2024-12-14T22:51:05.9592581+00:00</DateNextCollectiveBargainingAgreement>
  <DescribeChanges>sample string 16</DescribeChanges>
  <DescriptionExcess>sample string 34</DescriptionExcess>
  <DescriptionNonCompliance>sample string 32</DescriptionNonCompliance>
  <DescriptionNonQualificationItems>sample string 41</DescriptionNonQualificationItems>
  <EmployeeCommunicationRequirement>true</EmployeeCommunicationRequirement>
  <EmployerCost>sample string 27</EmployerCost>
  <EmployerRole>sample string 28</EmployerRole>
  <EmployerRoleInProgramAdministration>true</EmployerRoleInProgramAdministration>
  <FlexBenefitProgramModel>sample string 22</FlexBenefitProgramModel>
  <FlexBenefitProgramModelId>21</FlexBenefitProgramModelId>
  <FlexBudgetCreditMechanism>sample string 25</FlexBudgetCreditMechanism>
  <FlexProgramOtherBenefitsIncluded>sample string 23</FlexProgramOtherBenefitsIncluded>
  <FormBenefitPurchase>sample string 30</FormBenefitPurchase>
  <GeographicalScope>sample string 14</GeographicalScope>
  <GeographicalScopeId>13</GeographicalScopeId>
  <GoverningDocument>sample string 10</GoverningDocument>
  <IndependentCollectiveBargaining>true</IndependentCollectiveBargaining>
  <IntegrationWithWorkersCompensation>true</IntegrationWithWorkersCompensation>
  <InternationallyMobileEmployees>true</InternationallyMobileEmployees>
  <LocalCompanyName>sample string 5</LocalCompanyName>
  <MultiEmployerPlan>true</MultiEmployerPlan>
  <OptingOutAallowed>true</OptingOutAallowed>
  <PeriodicRegulatoryFilings>true</PeriodicRegulatoryFilings>
  <PlanComplyDescriptionNonCompliance>sample string 38</PlanComplyDescriptionNonCompliance>
  <PlanComplyOptingOutRequirement>true</PlanComplyOptingOutRequirement>
  <PlanDesignChanges>true</PlanDesignChanges>
  <PlanIntroducedOptOutDefaultRequirement>true</PlanIntroducedOptOutDefaultRequirement>
  <PlanTaxQualified>true</PlanTaxQualified>
  <PlanYear>8</PlanYear>
  <Remarks>sample string 44</Remarks>
  <SelectionProcessBenefitItems>sample string 24</SelectionProcessBenefitItems>
  <SponsoringOrganizationName>sample string 12</SponsoringOrganizationName>
  <Status>sample string 46</Status>
  <StatusId>45</StatusId>
  <StatusReasonsId>1</StatusReasonsId>
  <TaxAdvantage>true</TaxAdvantage>
  <UnusedBudgetCredits>sample string 26</UnusedBudgetCredits>
  <VoluntaryProgramOtherBenefitsIncluded>sample string 29</VoluntaryProgramOtherBenefitsIncluded>
</BenefitPlanModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BenefitPlanModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.