GET PlanCare2Api/Projects?contractId={contractId}&referenceDate={referenceDate}
Fetch projects that are available to a contract at a certain date
Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contractId |
The contract id |
integer |
Required |
| referenceDate |
The reference date |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of projects available to the contract and date
Collection of Project| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The id of the project |
string |
None |
| Name |
The name of the project |
string |
None |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<Project>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
</Project>
<Project>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
</Project>
</ArrayOfProject>