GET PlanCare2Api/Clients/{clientId}/StartPage

Gets a start page by clientId. The start page contains: The calendar appointments of today, The reports of previous week, The client plans of this week and the medical information.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Identifier of client	integer	Required

Body Parameters

None.

Response Information

Resource Description

Client

StartPage

Name	Description	Type	Additional information
StartPageCalendar	The start page calendar object.	StartPageCalendar	None
StartPageReport	The start page report object.	StartPageReport	None
StartPageClientplan	The start page client plan object.	StartPageClientplan	None
StartPageMedical	The start page medical object.	StartPageMedical	None
ValidationResults	The start page validation results.	Collection of Object	None

Response Formats

application/json, text/json

Sample:

{
  "StartPageCalendar": {
    "$id": "2",
    "CountTotalAppointments": 1,
    "CountAppointmentsCompleted": 1,
    "CountOpenAppointments": 1,
    "UpcomingAppointmentId": 1,
    "UpcomingAppointmentStartDate": "2026-05-26T23:12:59.2451443+02:00",
    "UpcomingAppointmentEndDate": "2026-05-26T23:12:59.2451443+02:00",
    "UpcomingAppointmentIsAllDay": true,
    "UpcomingAppointmentName": "sample string 2"
  },
  "StartPageReport": {
    "$id": "3",
    "CountTotalReportsDaily": 1,
    "CountTotalReportsWeekly": 1,
    "CountTotalReportsPriorityWeekly": 1,
    "LastReportId": 1,
    "LastReportDateTime": "2026-05-26T23:12:59.2451443+02:00",
    "LastReportName": "sample string 1"
  },
  "StartPageClientplan": {
    "$id": "4",
    "CountTotalGoals": 1,
    "CountTotalGoalAgreements": 1,
    "CountTotalAttentionsPoints": 1
  },
  "StartPageMedical": {
    "$id": "5",
    "Resuscitation": {
      "$id": "6",
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3"
    },
    "HasAllergies": true,
    "CountTotalAdls": 1,
    "CountTotalRisks": 1,
    "HasADLCard": true,
    "HasRiskCard": true
  },
  "ValidationResults": []
}

application/xml, text/xml

Sample:

<StartPage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <StartPageCalendar>
    <CountAppointmentsCompleted>1</CountAppointmentsCompleted>
    <CountOpenAppointments>1</CountOpenAppointments>
    <CountTotalAppointments>1</CountTotalAppointments>
    <UpcomingAppointmentEndDate>2026-05-26T23:12:59.2451443+02:00</UpcomingAppointmentEndDate>
    <UpcomingAppointmentId>1</UpcomingAppointmentId>
    <UpcomingAppointmentIsAllDay>true</UpcomingAppointmentIsAllDay>
    <UpcomingAppointmentName>sample string 2</UpcomingAppointmentName>
    <UpcomingAppointmentStartDate>2026-05-26T23:12:59.2451443+02:00</UpcomingAppointmentStartDate>
  </StartPageCalendar>
  <StartPageClientplan>
    <CountTotalAttentionsPoints>1</CountTotalAttentionsPoints>
    <CountTotalGoalAgreements>1</CountTotalGoalAgreements>
    <CountTotalGoals>1</CountTotalGoals>
  </StartPageClientplan>
  <StartPageMedical>
    <CountTotalAdls>1</CountTotalAdls>
    <CountTotalRisks>1</CountTotalRisks>
    <HasADLCard>true</HasADLCard>
    <HasAllergies>true</HasAllergies>
    <HasRiskCard>true</HasRiskCard>
    <Resuscitation>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Name>sample string 2</Name>
    </Resuscitation>
  </StartPageMedical>
  <StartPageReport>
    <CountTotalReportsDaily>1</CountTotalReportsDaily>
    <CountTotalReportsPriorityWeekly>1</CountTotalReportsPriorityWeekly>
    <CountTotalReportsWeekly>1</CountTotalReportsWeekly>
    <LastReportDateTime>2026-05-26T23:12:59.2451443+02:00</LastReportDateTime>
    <LastReportId>1</LastReportId>
    <LastReportName>sample string 1</LastReportName>
  </StartPageReport>
  <ValidationResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Microsoft.Practices.EnterpriseLibrary.Validation">
    <d2p1:validationResults />
  </ValidationResults>
</StartPage>