GET PlanCare2Api/Contracts/{contractId}/Products

Fetches all products of a contract.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contractId

The id of the contract.

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of all products of a contract.

Collection of ContractProduct
NameDescriptionTypeAdditional information
Id

The product Id

integer

None.

Code

Product Code

string

None.

Name

Product Name

string

None.

Description

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,
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "StartDate": "2026-05-26T22:10:10.8231461+02:00",
    "EndDate": "2026-05-26T22:10:10.8231461+02:00",
    "DefaultMinutes": 6
  },
  {
    "$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>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T22:10:10.8231461+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <StartDate>2026-05-26T22:10:10.8231461+02:00</StartDate>
  </ContractProduct>
  <ContractProduct>
    <Code>sample string 2</Code>
    <DefaultMinutes>6</DefaultMinutes>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T22:10:10.8231461+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <StartDate>2026-05-26T22:10:10.8231461+02:00</StartDate>
  </ContractProduct>
</ArrayOfContractProduct>