GET PlanCare2Api/Employees?referenceDate={referenceDate}&isLocked={isLocked}&allowAccessEmployeePortal={allowAccessEmployeePortal}

Gets detail info of all employees active on referenceDate with a valid Contract of Service on referenceDate

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

Request Information

URI Parameters

Name	Description	Type	Additional information
referenceDate	Date employees have to be active	date	Required
isLocked	Indicates whether the employee has a user account which is locked.	boolean	Nullable
allowAccessEmployeePortal	Indicates whether the employee is allowed employee portal access.	boolean	Nullable

Body Parameters

None.

Response Information

Resource Description

A list of active employees on given date

Collection of Employee

Name	Description	Type	Additional information
RelationId	Id of the relation	integer	-
EmployeeId	Id of the employee	integer	-
BSN	Socialsecuritynumber	string	-
FirstName	Firstname of the employee	string	-
LastName	Surname of the employee	string	-
LookupName	Lookupname of the employee	string	-
Prefix	Prefix of the employee	string	-
Gender	Gender of the employee	GenderEnum	-
GenderNumber	Gender number	integer	-
DateOfBirth	Date of birth of the employee	date	-
AccessUserId	Id for the employee to logon with	integer	-
DateOfRemoval	Date of removal of the employee Which can be the date of death or the enddate of the last contract	date	Nullable
RegistrationNumber	External registrationnumber	string	-
WindowsUsername	Single Sign On Username	string	-
EmailAddresses	Email addresses of employee	Collection of string	-
AccessUsername	Username of the employee	string	-
MobilePhoneNumbers	Mobile phone numbers of the employee	Collection of PhoneNumber	-
AutoLoginWithDefaultLoginEmployment	Enable automatic selection of employment during log on	boolean	-
IsAuthorizedForTimeRegistration	Indicator that employee is central authorized for timeregistration	boolean	-
IsServiceAccount	Indicator that employee is a service account	boolean	-
AllowAccessEmployeePortal	Indicates whether the employee is allowed to use the employee-portal.	boolean	-
AllowAccessEmployeePortalStartDate	Optional begin of period when the employee is allowed to use the employee-portal.	date	Nullable
AllowAccessEmployeePortalEndDate	Optional end of period when the employee is allowed to use the employee-portal.	date	Nullable
PortalEmail	The employee's e-mail (username) within the employee-portal.	string	-
IsLocked	Indicates whether the employee has a user account which is locked.	boolean	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "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-26T21:10:17.9870257+02:00",
    "AccessUserId": 10,
    "DateOfRemoval": "2026-05-26T21:10:17.9870257+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,
    "AllowAccessEmployeePortal": true,
    "AllowAccessEmployeePortalStartDate": "2026-05-26T21:10:17.9870257+02:00",
    "AllowAccessEmployeePortalEndDate": "2026-05-26T21:10:17.9870257+02:00",
    "PortalEmail": "sample string 18",
    "IsLocked": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmployee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Employee">
  <Employee>
    <AccessUserId>10</AccessUserId>
    <AccessUsername>sample string 13</AccessUsername>
    <AllowAccessEmployeePortal>true</AllowAccessEmployeePortal>
    <AllowAccessEmployeePortalEndDate>2026-05-26T21:10:17.9870257+02:00</AllowAccessEmployeePortalEndDate>
    <AllowAccessEmployeePortalStartDate>2026-05-26T21:10:17.9870257+02:00</AllowAccessEmployeePortalStartDate>
    <AutoLoginWithDefaultLoginEmployment>true</AutoLoginWithDefaultLoginEmployment>
    <BSN>sample string 3</BSN>
    <DateOfBirth>2026-05-26T21:10:17.9870257+02:00</DateOfBirth>
    <DateOfRemoval>2026-05-26T21:10:17.9870257+02:00</DateOfRemoval>
    <EmailAddresses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EmailAddresses>
    <EmployeeId>2</EmployeeId>
    <FirstName>sample string 4</FirstName>
    <GenderNumber>8</GenderNumber>
    <IsAuthorizedForTimeRegistration>true</IsAuthorizedForTimeRegistration>
    <IsLocked>true</IsLocked>
    <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>
    <PortalEmail>sample string 18</PortalEmail>
    <Prefix>sample string 7</Prefix>
    <RegistrationNumber>sample string 11</RegistrationNumber>
    <RelationId>1</RelationId>
    <WindowsUsername>sample string 12</WindowsUsername>
  </Employee>
  <Employee>
    <AccessUserId>10</AccessUserId>
    <AccessUsername>sample string 13</AccessUsername>
    <AllowAccessEmployeePortal>true</AllowAccessEmployeePortal>
    <AllowAccessEmployeePortalEndDate>2026-05-26T21:10:17.9870257+02:00</AllowAccessEmployeePortalEndDate>
    <AllowAccessEmployeePortalStartDate>2026-05-26T21:10:17.9870257+02:00</AllowAccessEmployeePortalStartDate>
    <AutoLoginWithDefaultLoginEmployment>true</AutoLoginWithDefaultLoginEmployment>
    <BSN>sample string 3</BSN>
    <DateOfBirth>2026-05-26T21:10:17.9870257+02:00</DateOfBirth>
    <DateOfRemoval>2026-05-26T21:10:17.9870257+02:00</DateOfRemoval>
    <EmailAddresses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EmailAddresses>
    <EmployeeId>2</EmployeeId>
    <FirstName>sample string 4</FirstName>
    <GenderNumber>8</GenderNumber>
    <IsAuthorizedForTimeRegistration>true</IsAuthorizedForTimeRegistration>
    <IsLocked>true</IsLocked>
    <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>
    <PortalEmail>sample string 18</PortalEmail>
    <Prefix>sample string 7</Prefix>
    <RegistrationNumber>sample string 11</RegistrationNumber>
    <RelationId>1</RelationId>
    <WindowsUsername>sample string 12</WindowsUsername>
  </Employee>
</ArrayOfEmployee>