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	-
TypeName	TypeName	string	-
CustomMessage	CustomMessage	string	-
DescriptionForCreator	DescriptionForCreator	string	-
ImportantAllowed	Important allowed	boolean	-
AnonymousAllowed	Anonymous allowed	boolean	-
MinimumClients	MinimumClients	integer	-
MaximumClients	MaximumClients	integer	Nullable
MinimumEmployees	MinimumEmployees	integer	-
MaximumEmployees	MaximumEmployees	integer	Nullable
OrganizationEntityRequired	OrganizationEntityRequired	boolean	-
QuestionnaireGuid	QuestionnaireGuid	globally unique identifier	Nullable
DescriptionForSuccessors	DescriptionForSuccessors	string	Added: 20.07.1P
DisciplineSuccessors	DisciplineSuccessors	Collection of CallOptionsDisciplineSuccessor	Added: 20.07.1P

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,
  "OrganizationEntityRequired": true,
  "QuestionnaireGuid": "3c25dcf9-0e1b-4aa3-977f-dceda7c52de6",
  "DescriptionForSuccessors": "sample string 10",
  "DisciplineSuccessors": [
    {
      "$id": "2",
      "Rank": 1,
      "AccessDisciplineId": 2,
      "AccessDisciplineName": "sample string 3",
      "SuccessorAmountType": 0,
      "SuccessorAmountTypeDescription": "sample string 4",
      "SuccessionType": 0,
      "SuccessionTypeDescription": "sample string 5",
      "OnlyInformImportantCalls": true
    },
    {
      "$ref": "2"
    }
  ]
}

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>
  <DescriptionForSuccessors>sample string 10</DescriptionForSuccessors>
  <DisciplineSuccessors>
    <CallOptionsDisciplineSuccessor>
      <AccessDisciplineId>2</AccessDisciplineId>
      <AccessDisciplineName>sample string 3</AccessDisciplineName>
      <OnlyInformImportantCalls>true</OnlyInformImportantCalls>
      <Rank>1</Rank>
      <SuccessionType>Read</SuccessionType>
      <SuccessionTypeDescription>sample string 5</SuccessionTypeDescription>
      <SuccessorAmountType>One</SuccessorAmountType>
      <SuccessorAmountTypeDescription>sample string 4</SuccessorAmountTypeDescription>
    </CallOptionsDisciplineSuccessor>
    <CallOptionsDisciplineSuccessor>
      <AccessDisciplineId>2</AccessDisciplineId>
      <AccessDisciplineName>sample string 3</AccessDisciplineName>
      <OnlyInformImportantCalls>true</OnlyInformImportantCalls>
      <Rank>1</Rank>
      <SuccessionType>Read</SuccessionType>
      <SuccessionTypeDescription>sample string 5</SuccessionTypeDescription>
      <SuccessorAmountType>One</SuccessorAmountType>
      <SuccessorAmountTypeDescription>sample string 4</SuccessorAmountTypeDescription>
    </CallOptionsDisciplineSuccessor>
  </DisciplineSuccessors>
  <ImportantAllowed>true</ImportantAllowed>
  <MaximumClients>1</MaximumClients>
  <MaximumEmployees>1</MaximumEmployees>
  <MinimumClients>7</MinimumClients>
  <MinimumEmployees>8</MinimumEmployees>
  <OrganizationEntityRequired>true</OrganizationEntityRequired>
  <QuestionnaireGuid>3c25dcf9-0e1b-4aa3-977f-dceda7c52de6</QuestionnaireGuid>
  <TypeName>sample string 2</TypeName>
</CallOptions>