PUT api/benefit-plan/update-overview

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BenefitPlanId	integer	None.
CorporateCompanyId	integer	None.
CorporateId	integer	None.
GoverningDocument	string	None.
MultiEmployerPlan	boolean	None.
SponsoringOrganizationName	string	None.
GeographicalScopeId	integer	None.
GeographicalScope	string	None.
PlanDesignChanges	boolean	None.
DescribeChanges	string	None.
Active	boolean	None.
BenefitPlanEntities	Collection of BenefitPlanEntitiesModel	None.
BenefitPlanBasis	Collection of BenefitPlanBasisModel	None.

Request Formats

application/json, text/json

Sample:

{
  "BenefitPlanId": 1,
  "CorporateCompanyId": 2,
  "CorporateId": 3,
  "GoverningDocument": "sample string 4",
  "MultiEmployerPlan": true,
  "SponsoringOrganizationName": "sample string 6",
  "GeographicalScopeId": 7,
  "GeographicalScope": "sample string 8",
  "PlanDesignChanges": true,
  "DescribeChanges": "sample string 10",
  "Active": true,
  "BenefitPlanEntities": [
    {
      "BenefitPlanEntitiesId": 1,
      "BenefitPlanId": 2,
      "CompanyLegalEntityId": 3,
      "CompanyId": 4,
      "EntityName": "sample string 5",
      "CorporateBusinessId": 6,
      "CorporateBusiness": "sample string 7",
      "CorporateLegalEntitiesId": 8,
      "CorporateLegalEntities": "sample string 9",
      "StatusCompany": "sample string 10",
      "Active": true
    },
    {
      "BenefitPlanEntitiesId": 1,
      "BenefitPlanId": 2,
      "CompanyLegalEntityId": 3,
      "CompanyId": 4,
      "EntityName": "sample string 5",
      "CorporateBusinessId": 6,
      "CorporateBusiness": "sample string 7",
      "CorporateLegalEntitiesId": 8,
      "CorporateLegalEntities": "sample string 9",
      "StatusCompany": "sample string 10",
      "Active": true
    }
  ],
  "BenefitPlanBasis": [
    {
      "BenefitPlanBasisId": 1,
      "BenefitPlanId": 2,
      "CatalogValueId": 3,
      "Active": true
    },
    {
      "BenefitPlanBasisId": 1,
      "BenefitPlanId": 2,
      "CatalogValueId": 3,
      "Active": true
    }
  ]
}

application/xml, text/xml

Sample:

<BenefitPlanOverviewSubModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALTAMBS.Business.Entities.Models">
  <Active>true</Active>
  <BenefitPlanBasis>
    <BenefitPlanBasisModel>
      <Active>true</Active>
      <BenefitPlanBasisId>1</BenefitPlanBasisId>
      <BenefitPlanId>2</BenefitPlanId>
      <CatalogValueId>3</CatalogValueId>
    </BenefitPlanBasisModel>
    <BenefitPlanBasisModel>
      <Active>true</Active>
      <BenefitPlanBasisId>1</BenefitPlanBasisId>
      <BenefitPlanId>2</BenefitPlanId>
      <CatalogValueId>3</CatalogValueId>
    </BenefitPlanBasisModel>
  </BenefitPlanBasis>
  <BenefitPlanEntities>
    <BenefitPlanEntitiesModel>
      <Active>true</Active>
      <BenefitPlanEntitiesId>1</BenefitPlanEntitiesId>
      <BenefitPlanId>2</BenefitPlanId>
      <CompanyId>4</CompanyId>
      <CompanyLegalEntityId>3</CompanyLegalEntityId>
      <CorporateBusiness>sample string 7</CorporateBusiness>
      <CorporateBusinessId>6</CorporateBusinessId>
      <CorporateLegalEntities>sample string 9</CorporateLegalEntities>
      <CorporateLegalEntitiesId>8</CorporateLegalEntitiesId>
      <EntityName>sample string 5</EntityName>
      <StatusCompany>sample string 10</StatusCompany>
    </BenefitPlanEntitiesModel>
    <BenefitPlanEntitiesModel>
      <Active>true</Active>
      <BenefitPlanEntitiesId>1</BenefitPlanEntitiesId>
      <BenefitPlanId>2</BenefitPlanId>
      <CompanyId>4</CompanyId>
      <CompanyLegalEntityId>3</CompanyLegalEntityId>
      <CorporateBusiness>sample string 7</CorporateBusiness>
      <CorporateBusinessId>6</CorporateBusinessId>
      <CorporateLegalEntities>sample string 9</CorporateLegalEntities>
      <CorporateLegalEntitiesId>8</CorporateLegalEntitiesId>
      <EntityName>sample string 5</EntityName>
      <StatusCompany>sample string 10</StatusCompany>
    </BenefitPlanEntitiesModel>
  </BenefitPlanEntities>
  <BenefitPlanId>1</BenefitPlanId>
  <CorporateCompanyId>2</CorporateCompanyId>
  <CorporateId>3</CorporateId>
  <DescribeChanges>sample string 10</DescribeChanges>
  <GeographicalScope>sample string 8</GeographicalScope>
  <GeographicalScopeId>7</GeographicalScopeId>
  <GoverningDocument>sample string 4</GoverningDocument>
  <MultiEmployerPlan>true</MultiEmployerPlan>
  <PlanDesignChanges>true</PlanDesignChanges>
  <SponsoringOrganizationName>sample string 6</SponsoringOrganizationName>
</BenefitPlanOverviewSubModel>

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 'BenefitPlanOverviewSubModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.