GET PlanCare2Api/ContactPersons/{relationId}

Gets a contactperson by relationId

Requires 'Read' permission for function ContactPersonPersonalData {1D8FABC7-C901-48B5-A6B3-3D47FE33810D}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Contactperson

ContactPersonLookup

Name	Description	Type	Additional information
RelationId	RelationId	integer	-
FirstName	FirstName	string	-
LastName	LastName	string	-
NickName	NickName	string	-
LookupName	LookupName	string	-
AllowAccessClientPortal	Indicates whether the contactperson is allowed to use the client-portal.	boolean	-
AllowAccessClientPortalStartDate	Optional begin of period when the contactperson is allowed to use the client-portal.	date	Nullable
AllowAccessClientPortalEndDate	Optional end of period when the contactperson is allowed to use the client-portal.	date	Nullable
PortalEmail	The contactperson's e-mail (username) within the client-portal.	string	-
AccessUserId	AccessUserId of the contactperson.	integer	Nullable

Response Formats

application/json, text/json

Sample:

{
  "RelationId": 1,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "NickName": "sample string 4",
  "LookupName": "sample string 5",
  "AllowAccessClientPortal": true,
  "AllowAccessClientPortalStartDate": "2026-05-26T21:10:09.401829+02:00",
  "AllowAccessClientPortalEndDate": "2026-05-26T21:10:09.401829+02:00",
  "PortalEmail": "sample string 7",
  "AccessUserId": 1
}

application/xml, text/xml

Sample:

<ContactPersonLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ContactPerson">
  <AccessUserId>1</AccessUserId>
  <AllowAccessClientPortal>true</AllowAccessClientPortal>
  <AllowAccessClientPortalEndDate>2026-05-26T21:10:09.401829+02:00</AllowAccessClientPortalEndDate>
  <AllowAccessClientPortalStartDate>2026-05-26T21:10:09.401829+02:00</AllowAccessClientPortalStartDate>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <LookupName>sample string 5</LookupName>
  <NickName>sample string 4</NickName>
  <PortalEmail>sample string 7</PortalEmail>
  <RelationId>1</RelationId>
</ContactPersonLookup>