POST api/filters/benefit-plans

Request Information

URI Parameters

None.

Body Parameters

BenefitPlansParams
NameDescriptionTypeAdditional information
CorporateId

integer

None.

StatusId

integer

None.

Countries

Collection of integer

None.

BenefitTypes

Collection of integer

None.

PlanYears

Collection of integer

None.

CorporateCompanies

Collection of integer

None.

Regions

Collection of string

None.

AvailableInRCE

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CorporateId": 1,
  "StatusId": 1,
  "Countries": [
    1,
    2
  ],
  "BenefitTypes": [
    1,
    2
  ],
  "PlanYears": [
    1,
    2
  ],
  "CorporateCompanies": [
    1,
    2
  ],
  "Regions": [
    "sample string 1",
    "sample string 2"
  ],
  "AvailableInRCE": true
}

application/xml, text/xml

Sample:
<BenefitPlansParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALTABMS.API.Controllers">
  <AvailableInRCE>true</AvailableInRCE>
  <BenefitTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BenefitTypes>
  <CorporateCompanies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CorporateCompanies>
  <CorporateId>1</CorporateId>
  <Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Countries>
  <PlanYears xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PlanYears>
  <Regions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Regions>
  <StatusId>1</StatusId>
</BenefitPlansParams>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.