POST Availability/SaveAvailability
Request Information
URI Parameters
None.
Body Parameters
ProductAvailabilityName | Description | Type | Additional information |
---|---|---|---|
PBProductAvailabilityKey | integer |
None. |
|
AvailabilityDesc | string |
None. |
|
InEffect | date |
None. |
|
Product | Product |
None. |
|
CoveredEntityDisplayType | CoveredEntityDisplayType |
None. |
|
CoveredEntityBitMask | integer |
None. |
|
EnabledInWebExpress | boolean |
None. |
|
OfferingOrgUnitName | string |
None. |
|
OfferingOrgUnitPBEntityKey | integer |
None. |
|
TerminationDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "PBProductAvailabilityKey": 1, "AvailabilityDesc": "sample string 2", "InEffect": "2025-01-09T14:03:06.7171631-06:00", "OutOfEffect": "2025-01-09T14:03:06.7171631-06:00", "WhenLastChanged": "2025-01-09T14:03:06.7171631-06:00", "BenefitMin": 4.0, "BenefitMax": 5.0, "OptionalAmountDesc": "sample string 6", "UseSalary": 7, "CalculationMethodValueId": 8, "UserDefinedRateCriteriaRecordID1": 9, "UserDefinedRateCriteriaRecordID2": 10, "UserDefinedRateCriteriaRecordID3": 11, "AvailableCoveragesBitMask": 12, "BenefitAmountLookupRecordID_G136": 13, "WebExpress_GuaranteeAmount": 14.0, "WebExpressDisplayText": "sample string 15", "WebExpressLink": "sample string 16", "AllowBeneficiaryDesignation": true, "MinRequiredBeneficiaries": 18, "Product": { "PBProductKey": 1, "PBProductLineKey": 2, "ProductLineDesc": "sample string 3", "TargetEntityTypeID": 4, "ProductFullDesc": "sample string 5", "ProductShortDesc": "sample string 6", "CompanyPBEntityKey": 7, "ParticipantEnrolleeTypeBitmask": 8, "WebExpressProductGroup_G10": 9, "WebExpressProductGroupDesc": "sample string 10", "WebExpressOEProcessingOrder": 11, "WebExpressMustParticipate": true }, "CoveredEntityDisplayType": 0, "CoveredEntityBitMask": 19, "EnabledInWebExpress": true, "OfferingOrgUnitName": "sample string 21", "OfferingOrgUnitPBEntityKey": 22, "TerminationDate": "1/8/2025" }
application/xml, text/xml
Sample:
<ProductAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models"> <AllowBeneficiaryDesignation>true</AllowBeneficiaryDesignation> <AvailabilityDesc>sample string 2</AvailabilityDesc> <AvailableCoveragesBitMask>12</AvailableCoveragesBitMask> <BenefitAmountLookupRecordID_G136>13</BenefitAmountLookupRecordID_G136> <BenefitMax>5</BenefitMax> <BenefitMin>4</BenefitMin> <CalculationMethodValueId>8</CalculationMethodValueId> <CoveredEntityBitMask>19</CoveredEntityBitMask> <CoveredEntityDisplayType>None</CoveredEntityDisplayType> <EnabledInWebExpress>true</EnabledInWebExpress> <InEffect>2025-01-09T14:03:06.7171631-06:00</InEffect> <MinRequiredBeneficiaries>18</MinRequiredBeneficiaries> <OfferingOrgUnitName>sample string 21</OfferingOrgUnitName> <OfferingOrgUnitPBEntityKey>22</OfferingOrgUnitPBEntityKey> <OptionalAmountDesc>sample string 6</OptionalAmountDesc> <OutOfEffect>2025-01-09T14:03:06.7171631-06:00</OutOfEffect> <PBProductAvailabilityKey>1</PBProductAvailabilityKey> <Product> <CompanyPBEntityKey>7</CompanyPBEntityKey> <PBProductKey>1</PBProductKey> <PBProductLineKey>2</PBProductLineKey> <ParticipantEnrolleeTypeBitmask>8</ParticipantEnrolleeTypeBitmask> <ProductFullDesc>sample string 5</ProductFullDesc> <ProductLineDesc>sample string 3</ProductLineDesc> <ProductShortDesc>sample string 6</ProductShortDesc> <TargetEntityTypeID>4</TargetEntityTypeID> <WebExpressMustParticipate>true</WebExpressMustParticipate> <WebExpressOEProcessingOrder>11</WebExpressOEProcessingOrder> <WebExpressProductGroupDesc>sample string 10</WebExpressProductGroupDesc> <WebExpressProductGroup_G10>9</WebExpressProductGroup_G10> </Product> <UseSalary>7</UseSalary> <UserDefinedRateCriteriaRecordID1>9</UserDefinedRateCriteriaRecordID1> <UserDefinedRateCriteriaRecordID2>10</UserDefinedRateCriteriaRecordID2> <UserDefinedRateCriteriaRecordID3>11</UserDefinedRateCriteriaRecordID3> <WebExpressDisplayText>sample string 15</WebExpressDisplayText> <WebExpressLink>sample string 16</WebExpressLink> <WebExpress_GuaranteeAmount>14</WebExpress_GuaranteeAmount> <WhenLastChanged>2025-01-09T14:03:06.7171631-06:00</WhenLastChanged> </ProductAvailability>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.