GET PlanCare2Api/ClientReports/Disciplinesettings?disciplineId={disciplineId}

Retrieves all reportsettings for to given discipline.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

Request Information

URI Parameters

Name Description Type Additional information
disciplineId

The discipline to fetch reportsettings for.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Reportsettings for the given discipline.

ClientReportDisciplineSettings
Name Description Type Additional information
SubjectiveVisibleForOthers

Defines whether the subjective field of SOEP is visible to other disciplines.

boolean

-

ObjectiveVisibleForOthers

Defines whether the objective field of SOEP is visible to other disciplines.

boolean

-

EvaluationVisibleForOthers

Defines whether the evaluation field of SOEP is visible to other disciplines.

boolean

-

PlanVisibleForOthers

Defines whether the plan field of SOEP is visible to other disciplines.

boolean

-

AvailableForDisciplineIds

Defines the discipline ids when the report is available for specified disciplines only(AvailableFor).

Collection of integer

-

AvailableForDisciplineGroupIds

Defines the discipline group ids when the report is available for specified disciplines only(AvailableFor).

Collection of integer

-

AvailableFor

Defines to whom the clientreport is available, everyone or specific disciplines.

AvailableFor

-

DisplayShifts

Defines whether shifts can be selected.

boolean

-

Response Formats

application/json, text/json

Sample:
{
  "SubjectiveVisibleForOthers": true,
  "ObjectiveVisibleForOthers": true,
  "EvaluationVisibleForOthers": true,
  "PlanVisibleForOthers": true,
  "AvailableForDisciplineIds": [
    1,
    2
  ],
  "AvailableForDisciplineGroupIds": [
    1,
    2
  ],
  "AvailableFor": 0,
  "DisplayShifts": true
}

application/xml, text/xml

Sample:
<ClientReportDisciplineSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <AvailableFor>Everyone</AvailableFor>
  <AvailableForDisciplineGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AvailableForDisciplineGroupIds>
  <AvailableForDisciplineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AvailableForDisciplineIds>
  <DisplayShifts>true</DisplayShifts>
  <EvaluationVisibleForOthers>true</EvaluationVisibleForOthers>
  <ObjectiveVisibleForOthers>true</ObjectiveVisibleForOthers>
  <PlanVisibleForOthers>true</PlanVisibleForOthers>
  <SubjectiveVisibleForOthers>true</SubjectiveVisibleForOthers>
</ClientReportDisciplineSettings>