GET PlanCare2Api/Call/CallOptions?callId={callId}

Gets options of call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

Request Information

URI Parameters

Name	Description	Type	Additional information
callId	The id of the call.	integer	Required

Body Parameters

None.

Response Information

Resource Description

CallOptions.

CallOptions

Name	Description	Type	Additional information
CategoryName	CategoryName	string	None
TypeName	TypeName	string	None
CustomMessage	CustomMessage	string	None
DescriptionForCreator	DescriptionForCreator	string	None
ImportantAllowed	Important allowed	boolean	None
AnonymousAllowed	Anonymous allowed	boolean	None
MinimumClients	MinimumClients	integer	None
MaximumClients	MaximumClients	integer	None
MinimumEmployees	MinimumEmployees	integer	None
MaximumEmployees	MaximumEmployees	integer	None

Response Formats

application/json, text/json

Sample:

{
  "CategoryName": "sample string 1",
  "TypeName": "sample string 2",
  "CustomMessage": "sample string 3",
  "DescriptionForCreator": "sample string 4",
  "ImportantAllowed": true,
  "AnonymousAllowed": true,
  "MinimumClients": 7,
  "MaximumClients": 1,
  "MinimumEmployees": 8,
  "MaximumEmployees": 1
}

application/xml, text/xml

Sample:

<CallOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Call">
  <AnonymousAllowed>true</AnonymousAllowed>
  <CategoryName>sample string 1</CategoryName>
  <CustomMessage>sample string 3</CustomMessage>
  <DescriptionForCreator>sample string 4</DescriptionForCreator>
  <ImportantAllowed>true</ImportantAllowed>
  <MaximumClients>1</MaximumClients>
  <MaximumEmployees>1</MaximumEmployees>
  <MinimumClients>7</MinimumClients>
  <MinimumEmployees>8</MinimumEmployees>
  <TypeName>sample string 2</TypeName>
</CallOptions>