GET PlanCare2Api/ClientplansV2/Disciplines

Retrieve the disciplines available for clientplans.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of disciplines available for clientplans

Collection of Discipline
NameDescriptionTypeAdditional information
Id

Id of the discipline.

integer

None.

Name

Name of the discipline.

string

None.

Description

Description of the discipline.

string

None.

SpecialismCode

PlanCare 2 specialism code attached to the discipline.

string

None.

IsActual

Describes whether the discipline is currently in use.

boolean

None.

DisciplineGroupId

Id of the discipline group.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "SpecialismCode": "sample string 4",
    "IsActual": true,
    "DisciplineGroupId": 6
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDiscipline xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <Discipline>
    <Description>sample string 3</Description>
    <DisciplineGroupId>6</DisciplineGroupId>
    <Id>1</Id>
    <IsActual>true</IsActual>
    <Name>sample string 2</Name>
    <SpecialismCode>sample string 4</SpecialismCode>
  </Discipline>
  <Discipline>
    <Description>sample string 3</Description>
    <DisciplineGroupId>6</DisciplineGroupId>
    <Id>1</Id>
    <IsActual>true</IsActual>
    <Name>sample string 2</Name>
    <SpecialismCode>sample string 4</SpecialismCode>
  </Discipline>
</ArrayOfDiscipline>