POST v1/api/GetRulebasePlans?caseId={caseId}

Get Rulebase plans

Request Information

URI Parameters

Name	Description	Type	Additional information
caseId	(optional - but recommended) a unique identifier to both group calls, and to tie a case to an Agency.	string	None.

Body Parameters

RulebasePlanRequestDto

Name	Type	Additional information
RulebaseId	string	None.
PlanId	string	None.
ClassId	string	None.

Request Formats

application/json

Sample:


REQUEST
{
  "RulebaseId":"FinalExpense",
  "PlanId":null,
  "ClassId":null
}

application/xml

Sample:


REQUEST
<RulebasePlanRequestDto xmlns="http://schemas.datacontract.org/2004/07/SAM.BusinessDto.Platform.Request" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ClassId i:nil="true"/>
  <PlanId i:nil="true"/>
  <RulebaseId>FinalExpense</RulebaseId>
</RulebasePlanRequestDto>

Response Information

Resource Description

PlanStepResponseDto

Name	Description	Type	Additional information
PlanData		Collection of RulebasePlanDataDto	None.
PlanStepData		Collection of PlanStepDataDto	None.

Response Formats

application/json

Sample:

RESPONSE
{
  "PlanData": [
    {
      "PlanId": "CRFE01",
      "EffectiveDate": "2019-01-01T00:00:00"
    },
    {
      "PlanId": "FEGD01",
      "EffectiveDate": "2019-01-01T00:00:00"
    },
    {
      "PlanId": "FELD01",
      "EffectiveDate": "2019-01-01T00:00:00"
    },
    {
      "PlanId": "FERP01",
      "EffectiveDate": "2019-01-01T00:00:00"
    }
  ],
  "PlanStepData": [
    {
      "PlanId": "CRFE01",
      "EffectiveDate": "2019-01-01T00:00:00",
      "ClassId": "",
      "StepPlanId": "",
      "StepClassId": "",
      "BestWorst": ""
    },
    {
      "PlanId": "FEGD01",
      "EffectiveDate": "2019-01-01T00:00:00",
      "ClassId": "NONE",
      "StepPlanId": "FERP01",
      "StepClassId": "NONE",
      "BestWorst": ""
    },
    {
      "PlanId": "FELD01",
      "EffectiveDate": "2019-01-01T00:00:00",
      "ClassId": "NONE",
      "StepPlanId": "FEGD01",
      "StepClassId": "NONE",
      "BestWorst": "B"
    },
    {
      "PlanId": "FERP01",
      "EffectiveDate": "2019-01-01T00:00:00",
      "ClassId": "NONE",
      "StepPlanId": "DECLN",
      "StepClassId": "NONE",
      "BestWorst": "W"
    }
  ]
}

application/xml

Sample:

RESPONSE
<PlanStepResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAM.BusinessDto.Platform.Response">
  <PlanData>
    <RulebasePlanDataDto>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>CRFE01</PlanId>
    </RulebasePlanDataDto>
    <RulebasePlanDataDto>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FEGD01</PlanId>
    </RulebasePlanDataDto>
    <RulebasePlanDataDto>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FELD01</PlanId>
    </RulebasePlanDataDto>
    <RulebasePlanDataDto>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FERP01</PlanId>
    </RulebasePlanDataDto>
  </PlanData>
  <PlanStepData>
    <PlanStepDataDto>
      <BestWorst></BestWorst>
      <ClassId></ClassId>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>CRFE01</PlanId>
      <StepClassId></StepClassId>
      <StepPlanId></StepPlanId>
    </PlanStepDataDto>
    <PlanStepDataDto>
      <BestWorst></BestWorst>
      <ClassId>NONE</ClassId>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FEGD01</PlanId>
      <StepClassId>NONE</StepClassId>
      <StepPlanId>FERP01</StepPlanId>
    </PlanStepDataDto>
    <PlanStepDataDto>
      <BestWorst>B</BestWorst>
      <ClassId>NONE</ClassId>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FELD01</PlanId>
      <StepClassId>NONE</StepClassId>
      <StepPlanId>FEGD01</StepPlanId>
    </PlanStepDataDto>
    <PlanStepDataDto>
      <BestWorst>W</BestWorst>
      <ClassId>NONE</ClassId>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FERP01</PlanId>
      <StepClassId>NONE</StepClassId>
      <StepPlanId>DECLN</StepPlanId>
    </PlanStepDataDto>
  </PlanStepData>
</PlanStepResponseDto>