GET PlanCare2Api/RootData/Disciplines

Returns a list of all PlanCare2 disciplines.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of all PlanCare2 disciplines.

Collection of Discipline
Name Description Type Additional information
Id

Id of the discipline.

integer

-

Name

Name of the discipline.

string

-

Description

Description of the discipline.

string

-

SpecialismCode

Specialism code attached to the discipline.

string

-

IsActual

Describes whether the discipline is currently in use.

boolean

-

DisciplineGroupId

Id of the discipline group.

integer

-

EvsFunction

EVS name of function.

string

-

EvsSpecialism

EVS name of specialism.

string

-

ReferralAllowed

Referral allowed

boolean

-

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,
    "EvsFunction": "sample string 7",
    "EvsSpecialism": "sample string 8",
    "ReferralAllowed": true
  },
  {
    "$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>
    <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>
</ArrayOfDiscipline>