GET PlanCare2Api/CareRegistration/RiskCards?clientId={clientId}&cardStatus={cardStatus}

Gets RiskCards for the specified client based on a status

Requires 'Read' permission for function ClientCardRiskCard {8FCB802F-C125-4B15-B953-5F577E76CC7B}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The clientId to obtain the RiskCards for.	integer	Required
cardStatus	The status of the RiskCards.	CardStatus	Required

Body Parameters

None.

Response Information

Resource Description

The requested RiskCards

Collection of RiskCard

Name	Description	Type	Additional information
Id	The id of the Riskcard	integer	None
ActualDate	The date the status of the Riskcard is set to Actual	date	None
HistoricalDate	The date the status of the Riskcard is set to Historical	date	None
StatusDescription	The status of the Riskcard as text	string	None
Categories	The Riskcard categories	Collection of RiskCardCategory	None
TemplateName	The name of the Riskcard template	string	None
MadeToDateByUsername	The name of the person who set the status of the Riskcard to Actual	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "ActualDate": "2026-05-26T21:09:18.71694+02:00",
    "HistoricalDate": "2026-05-26T21:09:18.71694+02:00",
    "StatusDescription": "sample string 2",
    "Categories": [
      {
        "$id": "2",
        "CategoryName": "sample string 1",
        "Rank": 2,
        "Risks": [
          {
            "$id": "3",
            "RiskName": "sample string 1",
            "RiskValue": "sample string 2",
            "Rank": 3,
            "Agreement": "sample string 4",
            "Remarks": "sample string 5",
            "Enabled": true,
            "References": [
              {
                "$id": "4",
                "TextValue": "sample string 1",
                "Type": 1,
                "Id": 2
              },
              {
                "$ref": "4"
              }
            ]
          },
          {
            "$ref": "3"
          }
        ]
      },
      {
        "$ref": "2"
      }
    ],
    "TemplateName": "sample string 3",
    "MadeToDateByUsername": "sample string 4"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRiskCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <RiskCard>
    <ActualDate>2026-05-26T21:09:18.71694+02:00</ActualDate>
    <Categories>
      <RiskCardCategory>
        <CategoryName>sample string 1</CategoryName>
        <Rank>2</Rank>
        <Risks>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
        </Risks>
      </RiskCardCategory>
      <RiskCardCategory>
        <CategoryName>sample string 1</CategoryName>
        <Rank>2</Rank>
        <Risks>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
        </Risks>
      </RiskCardCategory>
    </Categories>
    <HistoricalDate>2026-05-26T21:09:18.71694+02:00</HistoricalDate>
    <Id>1</Id>
    <MadeToDateByUsername>sample string 4</MadeToDateByUsername>
    <StatusDescription>sample string 2</StatusDescription>
    <TemplateName>sample string 3</TemplateName>
  </RiskCard>
  <RiskCard>
    <ActualDate>2026-05-26T21:09:18.71694+02:00</ActualDate>
    <Categories>
      <RiskCardCategory>
        <CategoryName>sample string 1</CategoryName>
        <Rank>2</Rank>
        <Risks>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
        </Risks>
      </RiskCardCategory>
      <RiskCardCategory>
        <CategoryName>sample string 1</CategoryName>
        <Rank>2</Rank>
        <Risks>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
          <RiskCardRisk>
            <Agreement>sample string 4</Agreement>
            <Enabled>true</Enabled>
            <Rank>3</Rank>
            <References>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
              <RiskCardRiskReference>
                <Id>2</Id>
                <TextValue>sample string 1</TextValue>
                <Type>ClientplanPartGoal</Type>
              </RiskCardRiskReference>
            </References>
            <Remarks>sample string 5</Remarks>
            <RiskName>sample string 1</RiskName>
            <RiskValue>sample string 2</RiskValue>
          </RiskCardRisk>
        </Risks>
      </RiskCardCategory>
    </Categories>
    <HistoricalDate>2026-05-26T21:09:18.71694+02:00</HistoricalDate>
    <Id>1</Id>
    <MadeToDateByUsername>sample string 4</MadeToDateByUsername>
    <StatusDescription>sample string 2</StatusDescription>
    <TemplateName>sample string 3</TemplateName>
  </RiskCard>
</ArrayOfRiskCard>