GET PlanCare2Api/Employees?relationId={relationId}

Gets detail info of an employee

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Detail info of an employee

Employee

Name	Description	Type	Additional information
RelationId	Id of the relation	integer	None.
EmployeeId	Id of the employee	integer	None.
BSN	Socialsecuritynumber	string	None.
FirstName	Firstname of the employee	string	None.
LastName	Surname of the employee	string	None.
LookupName	Lookupname of the employee	string	None.
Prefix	Prefix of the employee	string	None.
Gender	Gender of the employee	GenderEnum	None.
GenderNumber	Gender number	integer	None.
DateOfBirth	Date of birth of the employee	date	None.
AccessUserId	Id for the employee to logon with	integer	None.
DateOfRemoval	Date of removal of the employee Which can be the date of death or the enddate of the last contract	date	None.
RegistrationNumber	External registrationnumber	string	None.
WindowsUsername	Single Sign On Username	string	None.
EmailAddresses	Email addresses of employee	Collection of string	None.
AccessUsername	Username of the employee	string	None.
MobilePhoneNumbers	Mobile phone numbers of the employee	Collection of PhoneNumber	None.
AutoLoginWithDefaultLoginEmployment	Enable automatic selection of employment during log on	boolean	None.
IsAuthorizedForTimeRegistration	Indicator that employee is central authorized for timeregistration	boolean	None.
IsServiceAccount	Indicator that employee is a service account	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "RelationId": 1,
  "EmployeeId": 2,
  "BSN": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "LookupName": "sample string 6",
  "Prefix": "sample string 7",
  "Gender": 8,
  "GenderNumber": 8,
  "DateOfBirth": "2026-05-26T22:09:23.310988+02:00",
  "AccessUserId": 10,
  "DateOfRemoval": "2026-05-26T22:09:23.310988+02:00",
  "RegistrationNumber": "sample string 11",
  "WindowsUsername": "sample string 12",
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "AccessUsername": "sample string 13",
  "MobilePhoneNumbers": [
    {
      "$id": "2",
      "Rank": 64,
      "Value": "sample string 1"
    },
    {
      "$ref": "2"
    }
  ],
  "AutoLoginWithDefaultLoginEmployment": true,
  "IsAuthorizedForTimeRegistration": true,
  "IsServiceAccount": true
}

application/xml, text/xml

Sample:

<Employee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Employee">
  <AccessUserId>10</AccessUserId>
  <AccessUsername>sample string 13</AccessUsername>
  <AutoLoginWithDefaultLoginEmployment>true</AutoLoginWithDefaultLoginEmployment>
  <BSN>sample string 3</BSN>
  <DateOfBirth>2026-05-26T22:09:23.310988+02:00</DateOfBirth>
  <DateOfRemoval>2026-05-26T22:09:23.310988+02:00</DateOfRemoval>
  <EmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAddresses>
  <EmployeeId>2</EmployeeId>
  <FirstName>sample string 4</FirstName>
  <GenderNumber>8</GenderNumber>
  <IsAuthorizedForTimeRegistration>true</IsAuthorizedForTimeRegistration>
  <IsServiceAccount>true</IsServiceAccount>
  <LastName>sample string 5</LastName>
  <LookupName>sample string 6</LookupName>
  <MobilePhoneNumbers>
    <PhoneNumber>
      <Rank>64</Rank>
      <Value>sample string 1</Value>
    </PhoneNumber>
    <PhoneNumber>
      <Rank>64</Rank>
      <Value>sample string 1</Value>
    </PhoneNumber>
  </MobilePhoneNumbers>
  <Prefix>sample string 7</Prefix>
  <RegistrationNumber>sample string 11</RegistrationNumber>
  <RelationId>1</RelationId>
  <WindowsUsername>sample string 12</WindowsUsername>
</Employee>