GET PlanCare2Api/RootData/DisciplineGroups?groupId={groupId}&showDisciplines={showDisciplines}

Returns a list of all discipline groups.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

integer

None

showDisciplines

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

List of all discipline groups.

Collection of DisciplineGroup
NameDescriptionTypeAdditional information
Id

Id of the discipline group.

integer

None

Name

Name of the discipline group.

string

None

Description

Description of the discipline group.

string

None

Disciplines

All disciplines in the discipline group

Collection of Discipline

None

Response Formats

application/json, text/json

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

application/xml, text/xml

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