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

Name Description Type Additional 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
Name Description Type Additional information
Id

Id of the product

integer

-

ParentId

Id of the parent product

integer

-

Name

Name of the product

string

-

Description

Description of the product

string

-

StartDate

StartDate of the product

date

-

EndDate

Possible enddate of the product

date

Nullable

DefaultMinutes

Default minutes of the product, used for registration purposes

integer

-

TypeId

Id of the producttype

integer

-

TypeCode

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

string

-

TypeName

Name of the producttype

string

-

RegistrationTypeId

Id of the registrationtype

integer

-

RegistrationType

Name of the registrationtype

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "ParentId": 2,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "StartDate": "2026-05-26T22:08:39.0490932+02:00",
    "EndDate": "2026-05-26T22:08:39.0490932+02:00",
    "DefaultMinutes": 6,
    "TypeId": 7,
    "TypeCode": "sample string 8",
    "TypeName": "sample string 9",
    "RegistrationTypeId": 10,
    "RegistrationType": "sample string 11"
  },
  {
    "$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-26T22:08:39.0490932+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <ParentId>2</ParentId>
    <RegistrationType>sample string 11</RegistrationType>
    <RegistrationTypeId>10</RegistrationTypeId>
    <StartDate>2026-05-26T22:08:39.0490932+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-26T22:08:39.0490932+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <ParentId>2</ParentId>
    <RegistrationType>sample string 11</RegistrationType>
    <RegistrationTypeId>10</RegistrationTypeId>
    <StartDate>2026-05-26T22:08:39.0490932+02:00</StartDate>
    <TypeCode>sample string 8</TypeCode>
    <TypeId>7</TypeId>
    <TypeName>sample string 9</TypeName>
  </Product>
</ArrayOfProduct>