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

Fetches the products for the contract valid at a certain point in time filtered by employment.

Request Information

URI Parameters

Name	Description	Type	Additional information
contractId	The id of the contract.	integer	Required
employmentId	The id of the employment	integer	Required
referenceDate	The requested date.	date	Required

Body Parameters

None.

Response Information

Resource Description

List of products valid for the contract.

Collection of ContractProduct

Name	Description	Type	Additional information
Id	The product Id	integer	-
Code	Product Code	string	-
Name	Product Name	string	-
Description	Product Description	string	-
StartDate	First date the product is valid	date	-
EndDate	Last date the product is valid	date	Nullable
DefaultMinutes	Number of minutes the product takes by default	integer	-
DeclarationCodes	The declaration codes of the contract product	Collection of ContractProductDeclarationCode	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "StartDate": "2026-05-26T22:10:24.111179+02:00",
    "EndDate": "2026-05-26T22:10:24.111179+02:00",
    "DefaultMinutes": 6,
    "DeclarationCodes": [
      {
        "$id": "2",
        "Id": 1,
        "Code": "sample string 2",
        "Description": "sample string 3",
        "Rate": 1.0,
        "Factor": 4.0,
        "ClientSpecificRateAllowed": true
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContractProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ContractProduct>
    <Code>sample string 2</Code>
    <DeclarationCodes>
      <ContractProductDeclarationCode>
        <ClientSpecificRateAllowed>true</ClientSpecificRateAllowed>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Factor>4</Factor>
        <Id>1</Id>
        <Rate>1</Rate>
      </ContractProductDeclarationCode>
      <ContractProductDeclarationCode>
        <ClientSpecificRateAllowed>true</ClientSpecificRateAllowed>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Factor>4</Factor>
        <Id>1</Id>
        <Rate>1</Rate>
      </ContractProductDeclarationCode>
    </DeclarationCodes>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T22:10:24.111179+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <StartDate>2026-05-26T22:10:24.111179+02:00</StartDate>
  </ContractProduct>
  <ContractProduct>
    <Code>sample string 2</Code>
    <DeclarationCodes>
      <ContractProductDeclarationCode>
        <ClientSpecificRateAllowed>true</ClientSpecificRateAllowed>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Factor>4</Factor>
        <Id>1</Id>
        <Rate>1</Rate>
      </ContractProductDeclarationCode>
      <ContractProductDeclarationCode>
        <ClientSpecificRateAllowed>true</ClientSpecificRateAllowed>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Factor>4</Factor>
        <Id>1</Id>
        <Rate>1</Rate>
      </ContractProductDeclarationCode>
    </DeclarationCodes>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T22:10:24.111179+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <StartDate>2026-05-26T22:10:24.111179+02:00</StartDate>
  </ContractProduct>
</ArrayOfContractProduct>