GET PlanCare2Api/Intakes/IntakePeriods/Active?referenceDate={referenceDate}

Fetch active intake periods.

Deprecated (unavailable from 21.01.1P): use PlanCare2Api/Intakes/IntakePeriods/ActiveV2 instead

Request Information

URI Parameters

NameDescriptionTypeAdditional information
referenceDate

The reference date

date

Required

Body Parameters

None.

Response Information

Resource Description

Returns a valid list of active intake periods.

Collection of IntakePeriod
NameDescriptionTypeAdditional information
ClientId

The internal id of the client

integer

None

StartDate

Startdate of intakeperiod or DateTime.MinValue if period doesn't exist

date

None

EndDate

Possible enddate of intakeperiod

date

None

ContractId

Id of contract

integer

None

ContractDescription

Description of contract

string

None

ContractType

Type of contract

string

None

ContractStartDate

Startdate of contract

date

None

ContractEndDate

Possible enddate of contract

date

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "ClientId": 1,
    "StartDate": "2026-05-26T21:57:43.3847978+02:00",
    "EndDate": "2026-05-26T21:57:43.3847978+02:00",
    "ContractId": 3,
    "ContractDescription": "sample string 4",
    "ContractType": "sample string 5",
    "ContractStartDate": "2026-05-26T21:57:43.3847978+02:00",
    "ContractEndDate": "2026-05-26T21:57:43.3847978+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfIntakePeriod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.TimeSheet">
  <IntakePeriod>
    <ClientId>1</ClientId>
    <ContractDescription>sample string 4</ContractDescription>
    <ContractEndDate>2026-05-26T21:57:43.3847978+02:00</ContractEndDate>
    <ContractId>3</ContractId>
    <ContractStartDate>2026-05-26T21:57:43.3847978+02:00</ContractStartDate>
    <ContractType>sample string 5</ContractType>
    <EndDate>2026-05-26T21:57:43.3847978+02:00</EndDate>
    <StartDate>2026-05-26T21:57:43.3847978+02:00</StartDate>
  </IntakePeriod>
  <IntakePeriod>
    <ClientId>1</ClientId>
    <ContractDescription>sample string 4</ContractDescription>
    <ContractEndDate>2026-05-26T21:57:43.3847978+02:00</ContractEndDate>
    <ContractId>3</ContractId>
    <ContractStartDate>2026-05-26T21:57:43.3847978+02:00</ContractStartDate>
    <ContractType>sample string 5</ContractType>
    <EndDate>2026-05-26T21:57:43.3847978+02:00</EndDate>
    <StartDate>2026-05-26T21:57:43.3847978+02:00</StartDate>
  </IntakePeriod>
</ArrayOfIntakePeriod>