GET PlanCare2Api/Contracts/{contractId}/ContractLines?contractOfServiceId={contractOfServiceId}&referenceDate={referenceDate}

Fetches the contract lines valid for the contract and contract of service on the give date.

Request Information

URI Parameters

Name	Description	Type	Additional information
contractId	The id of the contract. Note: On the given date the user must have access to the client of the contract.	integer	Required
contractOfServiceId	Contract of service of the user. Note: contract of service must be valid for the user on the given date.	integer	Required
referenceDate	The date the contract lines must be valid.	date	Required

Body Parameters

None.

Response Information

Resource Description

List of contract lines valid for the contract and contract of service on the give date.

Collection of ContractLine

Name	Description	Type	Additional information
Id	Contract line identifier	integer	None.
ProductId	Product identifier	integer	None.
ProductCode	Product Code	string	None.
ProductName	Product Name	string	None.
ProductDescription	Product Description	string	None.
StartDate	First date the product is valid	date	None.
EndDate	Last date the product is valid	date	None.
DefaultMinutes	Number of minutes the product takes by default	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "ProductId": 1,
    "ProductCode": "sample string 2",
    "ProductName": "sample string 3",
    "ProductDescription": "sample string 4",
    "StartDate": "2026-05-26T21:12:33.9492302+02:00",
    "EndDate": "2026-05-26T21:12:33.9492302+02:00",
    "DefaultMinutes": 6
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContractLine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ContractLine>
    <DefaultMinutes>6</DefaultMinutes>
    <EndDate>2026-05-26T21:12:33.9492302+02:00</EndDate>
    <Id>1</Id>
    <ProductCode>sample string 2</ProductCode>
    <ProductDescription>sample string 4</ProductDescription>
    <ProductId>1</ProductId>
    <ProductName>sample string 3</ProductName>
    <StartDate>2026-05-26T21:12:33.9492302+02:00</StartDate>
  </ContractLine>
  <ContractLine>
    <DefaultMinutes>6</DefaultMinutes>
    <EndDate>2026-05-26T21:12:33.9492302+02:00</EndDate>
    <Id>1</Id>
    <ProductCode>sample string 2</ProductCode>
    <ProductDescription>sample string 4</ProductDescription>
    <ProductId>1</ProductId>
    <ProductName>sample string 3</ProductName>
    <StartDate>2026-05-26T21:12:33.9492302+02:00</StartDate>
  </ContractLine>
</ArrayOfContractLine>