GET PlanCare2Api/DynamicData/AgreementProductDescription?clientID={clientID}&referenceDate={referenceDate}

Fetch products based on the product information on the agreement. This function does apply to the PCD contracttype

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	The identifier of the client to obtain the product information for	integer	Required
referenceDate	The date to obtain product agreement information for	date	Required

Body Parameters

None.

Response Information

Resource Description

Displays a list of productcodes and productdescriptions based on the agreement

Collection of AgreementProductDescriptionResult

Name	Description	Type	Additional information
Productid	The identifier of the product	integer	Nullable
Productcode	The code of the product based on the agreement	string	-
Productdescription	The description of the product based on the agreement	string	-
Declarationunit	The unit in which the product is declared	string	-
Projectid	The identifier of the project	string	-
Contractid	The identifier of the contract	integer	Nullable
Clientid	The identifier of the client	integer	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Productid": 1,
    "Productcode": "sample string 1",
    "Productdescription": "sample string 2",
    "Declarationunit": "sample string 3",
    "Projectid": "sample string 4",
    "Contractid": 1,
    "Clientid": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDynamicDataController.AgreementProductDescriptionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.AgreementProductDescriptionResult>
    <Clientid>1</Clientid>
    <Contractid>1</Contractid>
    <Declarationunit>sample string 3</Declarationunit>
    <Productcode>sample string 1</Productcode>
    <Productdescription>sample string 2</Productdescription>
    <Productid>1</Productid>
    <Projectid>sample string 4</Projectid>
  </DynamicDataController.AgreementProductDescriptionResult>
  <DynamicDataController.AgreementProductDescriptionResult>
    <Clientid>1</Clientid>
    <Contractid>1</Contractid>
    <Declarationunit>sample string 3</Declarationunit>
    <Productcode>sample string 1</Productcode>
    <Productdescription>sample string 2</Productdescription>
    <Productid>1</Productid>
    <Projectid>sample string 4</Projectid>
  </DynamicDataController.AgreementProductDescriptionResult>
</ArrayOfDynamicDataController.AgreementProductDescriptionResult>