GET PlanCare2Api/Questionnaires/Question/AvailableRelationCorrelations?questionGuid={questionGuid}&relationId={relationId}&answerId={answerId}

Gets correlations available for question.

Request Information

URI Parameters

Name Description Type Additional information
questionGuid

The id of question.

globally unique identifier

Required

relationId

The id of relation.

integer

Required

answerId

The id of answer, if given then the selected correlations that aren't provided are added to the result.

integer

Nullable

Body Parameters

None.

Response Information

Resource Description

List of correlations.

Collection of QuestionnaireQuestionAvailableRelationCorrelation
Name Description Type Additional information
RelationCorrelationId

RelationCorrelationId

integer

-

CorrelationTypeName

CorrelationTypeName

string

-

SourceName

SourceName

string

-

TargetName

TargetName

string

-

DisciplineName

DisciplineName

string

-

RoleName

RoleName

string

-

StartDate

StartDate

date

Nullable

EndDate

EndDate

date

Nullable

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "RelationCorrelationId": 1,
    "CorrelationTypeName": "sample string 2",
    "SourceName": "sample string 3",
    "TargetName": "sample string 4",
    "DisciplineName": "sample string 5",
    "RoleName": "sample string 6",
    "StartDate": "2026-05-26T23:13:15.0407462+02:00",
    "EndDate": "2026-05-26T23:13:15.0407462+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfQuestionnaireQuestionAvailableRelationCorrelation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Questionnaire">
  <QuestionnaireQuestionAvailableRelationCorrelation>
    <CorrelationTypeName>sample string 2</CorrelationTypeName>
    <DisciplineName>sample string 5</DisciplineName>
    <EndDate>2026-05-26T23:13:15.0407462+02:00</EndDate>
    <RelationCorrelationId>1</RelationCorrelationId>
    <RoleName>sample string 6</RoleName>
    <SourceName>sample string 3</SourceName>
    <StartDate>2026-05-26T23:13:15.0407462+02:00</StartDate>
    <TargetName>sample string 4</TargetName>
  </QuestionnaireQuestionAvailableRelationCorrelation>
  <QuestionnaireQuestionAvailableRelationCorrelation>
    <CorrelationTypeName>sample string 2</CorrelationTypeName>
    <DisciplineName>sample string 5</DisciplineName>
    <EndDate>2026-05-26T23:13:15.0407462+02:00</EndDate>
    <RelationCorrelationId>1</RelationCorrelationId>
    <RoleName>sample string 6</RoleName>
    <SourceName>sample string 3</SourceName>
    <StartDate>2026-05-26T23:13:15.0407462+02:00</StartDate>
    <TargetName>sample string 4</TargetName>
  </QuestionnaireQuestionAvailableRelationCorrelation>
</ArrayOfQuestionnaireQuestionAvailableRelationCorrelation>