GET PlanCare2Api/ClientAgreements?clientId={clientId}

Retrieves all agreements for the specified client that have no related clientplan. Also retrieves all agreements for the selected client that occur in clientplans with the status 'in progress'.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The clientId for whom to fetch the agreements.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of agreements for the specified client.

Collection of ClientAgreement

Name	Description	Type	Additional information
Id	The internal id of the client agreement	integer	-
Name	The name of the client agreement	string	-
Description	The description of the client agreement	string	-
ClientPlanName	The name of the related clientplan, empty when no clientplan related	string	-
ClientplanAgreementId	The internal id of the clientplan agreement	integer	Nullable
ClientId	The internal id of the client the agreement is for	integer	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ClientPlanName": "sample string 4",
    "ClientplanAgreementId": 1,
    "ClientId": 5
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ClientAgreement>
    <ClientId>5</ClientId>
    <ClientPlanName>sample string 4</ClientPlanName>
    <ClientplanAgreementId>1</ClientplanAgreementId>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ClientAgreement>
  <ClientAgreement>
    <ClientId>5</ClientId>
    <ClientPlanName>sample string 4</ClientPlanName>
    <ClientplanAgreementId>1</ClientplanAgreementId>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ClientAgreement>
</ArrayOfClientAgreement>