GET PlanCare2Api/Projects/{projectId}/Products?contractId={contractId}&referenceDate={referenceDate}

Fetch products that are available to a project at a certain date and contract Note: This endpoint is obsolete and will be deleted in a future version of the API. Use the endpoint PlanCare2Api/Projects/pcd/{projectId}/Products instead.

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
projectId

The identifier of the project

string

Required

contractId

The contract id

integer

Required

referenceDate

The reference date

date

Required

Body Parameters

None.

Response Information

Resource Description

A list of products available to the project at a certain date and contract

Collection of Product
NameDescriptionTypeAdditional information
Id

Id of the product

integer

None

ParentId

Id of the parent product

integer

None

Name

Name of the product

string

None

Description

Description of the product

string

None

StartDate

StartDate of the product

date

None

EndDate

Possible enddate of the product

date

None

DefaultMinutes

Default minutes of the product, used for registration purposes

integer

None

TypeId

Id of the producttype

integer

None

TypeCode

Code for the type of the product, based on the codelist

string

None

TypeName

Name of the producttype

string

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "ParentId": 2,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "StartDate": "2026-05-26T21:10:47.7364659+02:00",
    "EndDate": "2026-05-26T21:10:47.7364659+02:00",
    "DefaultMinutes": 6,
    "TypeId": 7,
    "TypeCode": "sample string 8",
    "TypeName": "sample string 9"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <Product>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T21:10:47.7364659+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <ParentId>2</ParentId>
    <StartDate>2026-05-26T21:10:47.7364659+02:00</StartDate>
    <TypeCode>sample string 8</TypeCode>
    <TypeId>7</TypeId>
    <TypeName>sample string 9</TypeName>
  </Product>
  <Product>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T21:10:47.7364659+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <ParentId>2</ParentId>
    <StartDate>2026-05-26T21:10:47.7364659+02:00</StartDate>
    <TypeCode>sample string 8</TypeCode>
    <TypeId>7</TypeId>
    <TypeName>sample string 9</TypeName>
  </Product>
</ArrayOfProduct>