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

Get Plan step plan

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

PlanStepRequestDto

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

Request Formats

application/json

Sample:


REQUEST
{
  "PlanId":"FELD01",
  "ClassId":null
}

application/xml

Sample:


REQUEST
<PlanStepRequestDto 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>FELD01</PlanId>
</PlanStepRequestDto>

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": null,
  "PlanStepData": [
    {
      "PlanId": "FELD01",
      "EffectiveDate": "2019-01-01T00:00:00",
      "ClassId": "NONE",
      "StepPlanId": "FEGD01",
      "StepClassId": "NONE",
      "BestWorst": ""
    }
  ]
}

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 i:nil="true" />
  <PlanStepData>
    <PlanStepDataDto>
      <BestWorst></BestWorst>
      <ClassId>NONE</ClassId>
      <EffectiveDate>2019-01-01T00:00:00</EffectiveDate>
      <PlanId>FELD01</PlanId>
      <StepClassId>NONE</StepClassId>
      <StepPlanId>FEGD01</StepPlanId>
    </PlanStepDataDto>
  </PlanStepData>
</PlanStepResponseDto>