GET PlanCare2Api/Contracts?clientId={clientId}&referenceDate={referenceDate}
Fetches active contracts based on client identifier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Client identifier |
integer |
Required |
| referenceDate |
Date to validate on |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
List of contracts
Collection of Contract| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id for the contract |
integer |
None. |
| StartDate |
Startdate of the contract |
date |
None. |
| EndDate |
Enddate of the contract |
date |
None. |
| ContractInfo |
ContractInfo specification returns the contract id, description, contracttype code, contract start date and end date |
string |
None. |
| ContractType |
Contracttype specification |
ContractType |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"StartDate": "2026-05-26T21:01:10.3521701+02:00",
"EndDate": "2026-05-26T21:01:10.3521701+02:00",
"ContractInfo": "sample string 3",
"ContractType": {
"$id": "2",
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"Source": "sample string 5"
}
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<Contract>
<ContractInfo>sample string 3</ContractInfo>
<ContractType>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<Id>1</Id>
<IsActive>true</IsActive>
<Source>sample string 5</Source>
</ContractType>
<EndDate>2026-05-26T21:01:10.3521701+02:00</EndDate>
<Id>1</Id>
<StartDate>2026-05-26T21:01:10.3521701+02:00</StartDate>
</Contract>
<Contract>
<ContractInfo>sample string 3</ContractInfo>
<ContractType>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<Id>1</Id>
<IsActive>true</IsActive>
<Source>sample string 5</Source>
</ContractType>
<EndDate>2026-05-26T21:01:10.3521701+02:00</EndDate>
<Id>1</Id>
<StartDate>2026-05-26T21:01:10.3521701+02:00</StartDate>
</Contract>
</ArrayOfContract>