GET PlanCare2Api/Relations/{relationId}/CareProviders

Get the CareProviders by relation.

Requires 'Start' permission for function ClientCorrelationsCareProvider {E2878207-529D-44C8-8E99-8923CDBBCE82}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	Id of relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

CareProviders.

Collection of CareProvider

Name	Description	Type	Additional information
Id	The internal id of the careprovider	integer	-
Type	CareProvider Type Pharmacy = 1, Doctor = 2, Dentist = 3,	CareProviderType	-
StartDate	Startdate	date	Nullable
EndDate	Enddate	date	Nullable
Name	Name	string	-
LookupName	LookupName	string	-
Code	Code	string	-
PracticeName	Name of the Practice	string	-
Address	Address	string	-
Contacts	Contacts	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Type": 1,
    "StartDate": "2026-05-26T21:11:46.8981424+02:00",
    "EndDate": "2026-05-26T21:11:46.8981424+02:00",
    "Name": "sample string 2",
    "LookupName": "sample string 3",
    "Code": "sample string 4",
    "PracticeName": "sample string 5",
    "Address": "sample string 6",
    "Contacts": "sample string 7"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCareProvider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <CareProvider>
    <Address>sample string 6</Address>
    <Code>sample string 4</Code>
    <Contacts>sample string 7</Contacts>
    <EndDate>2026-05-26T21:11:46.8981424+02:00</EndDate>
    <Id>1</Id>
    <LookupName>sample string 3</LookupName>
    <Name>sample string 2</Name>
    <PracticeName>sample string 5</PracticeName>
    <StartDate>2026-05-26T21:11:46.8981424+02:00</StartDate>
    <Type>Pharmacy</Type>
  </CareProvider>
  <CareProvider>
    <Address>sample string 6</Address>
    <Code>sample string 4</Code>
    <Contacts>sample string 7</Contacts>
    <EndDate>2026-05-26T21:11:46.8981424+02:00</EndDate>
    <Id>1</Id>
    <LookupName>sample string 3</LookupName>
    <Name>sample string 2</Name>
    <PracticeName>sample string 5</PracticeName>
    <StartDate>2026-05-26T21:11:46.8981424+02:00</StartDate>
    <Type>Pharmacy</Type>
  </CareProvider>
</ArrayOfCareProvider>