GET PlanCare2Api/Products?employmentId={employmentId}&referenceDate={referenceDate}

Gets all products that are valid for the given employmentId and referenceDate

Request Information

URI Parameters

Name	Description	Type	Additional information
employmentId	Employment identifier	integer	Required
referenceDate	Date to validate on	date	Required

Body Parameters

None.

Response Information

Resource Description

The list of products valid by employment and referenceDate

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-26T21:12:10.0254826+02:00",
    "EndDate": "2026-05-26T21:12:10.0254826+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-26T21:12:10.0254826+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-26T21:12:10.0254826+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:12:10.0254826+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-26T21:12:10.0254826+02:00</StartDate>
    <TypeCode>sample string 8</TypeCode>
    <TypeId>7</TypeId>
    <TypeName>sample string 9</TypeName>
  </Product>
</ArrayOfProduct>