GET PlanCare2Api/DynamicData/Arrangement?clientlist={clientlist}

Gets arrangements by a list of unique client identifiers

Request Information

URI Parameters

Name	Description	Type	Additional information
clientlist	The list of client identifiers seperated by comma to obtain the arrangements for	string	Required

Body Parameters

None.

Response Information

Resource Description

Client arrangements by ClientplanID, ClientID and relation to Protocols

Collection of ArrangementResult

Name	Description	Type	Additional information
Clientid	Identifier of the client	integer	Nullable
Clientplanid	Identifier of the clientplan	integer	Nullable
Arrangement	Name of the arrangement applied to the active clientplan	string	-
Productid	Identifier of the product	integer	Nullable
Product	Name of the product, products contains one or more activities beneath them	string	-
Activityid	Identifier of the activity	integer	Nullable
Activity	Name of the activity, activities are clustered under a product	string	-
Protocolid	Identifier of the protocol optionally applied to the activity	integer	Nullable
Clientprotocolid	Identifier of the clientprotocol optionally applied to the activity	integer	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Clientid": 1,
    "Clientplanid": 1,
    "Arrangement": "sample string 1",
    "Productid": 1,
    "Product": "sample string 2",
    "Activityid": 1,
    "Activity": "sample string 3",
    "Protocolid": 1,
    "Clientprotocolid": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDynamicDataController.ArrangementResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.ArrangementResult>
    <Activity>sample string 3</Activity>
    <Activityid>1</Activityid>
    <Arrangement>sample string 1</Arrangement>
    <Clientid>1</Clientid>
    <Clientplanid>1</Clientplanid>
    <Clientprotocolid>1</Clientprotocolid>
    <Product>sample string 2</Product>
    <Productid>1</Productid>
    <Protocolid>1</Protocolid>
  </DynamicDataController.ArrangementResult>
  <DynamicDataController.ArrangementResult>
    <Activity>sample string 3</Activity>
    <Activityid>1</Activityid>
    <Arrangement>sample string 1</Arrangement>
    <Clientid>1</Clientid>
    <Clientplanid>1</Clientplanid>
    <Clientprotocolid>1</Clientprotocolid>
    <Product>sample string 2</Product>
    <Productid>1</Productid>
    <Protocolid>1</Protocolid>
  </DynamicDataController.ArrangementResult>
</ArrayOfDynamicDataController.ArrangementResult>