GET PlanCare2Api/Employees/{employeeId}/Employments?referenceDate={referenceDate}

Gets the employments for the specified employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeId

Employee identifier

integer

Required

referenceDate

Date to validate on

date

Required

Body Parameters

None.

Response Information

Resource Description

The list of employments for the specified employee

Collection of Employment
NameDescriptionTypeAdditional information
Id

Id of the employment

integer

None

EmployeeId

Id of the referenced employee

integer

None

Description

Description of the employment

string

None

StartDate

Startdate of the employment

date

None

EndDate

Possible enddate of the employment

date

None

IsDefaultEmployment

Indicator employment is default

boolean

None

IsDefaultForLogin

Indicator employment is the default for login purposes

boolean

None

OrganizationEntityId

The internal id of the Organization entity

integer

None

OrganizationEntityName

Organization entity referenced to employment

string

None

Discipline

Discipline referenced to employment

string

None

DisciplineId

The internal id of the discipline

integer

None

EmploymentReferenceNumber

The employment reference number

string

None

HoursPerWeek

The hours per week

integer

None

DaysPerWeek

The days per week

integer

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "EmployeeId": 2,
    "Description": "sample string 3",
    "StartDate": "2026-05-26T23:13:54.3223049+02:00",
    "EndDate": "2026-05-26T23:13:54.3223049+02:00",
    "IsDefaultEmployment": true,
    "IsDefaultForLogin": true,
    "OrganizationEntityId": 7,
    "OrganizationEntityName": "sample string 8",
    "Discipline": "sample string 9",
    "DisciplineId": 1,
    "EmploymentReferenceNumber": "sample string 10",
    "HoursPerWeek": 1,
    "DaysPerWeek": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEmployment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Employee">
  <Employment>
    <DaysPerWeek>1</DaysPerWeek>
    <Description>sample string 3</Description>
    <Discipline>sample string 9</Discipline>
    <DisciplineId>1</DisciplineId>
    <EmployeeId>2</EmployeeId>
    <EmploymentReferenceNumber>sample string 10</EmploymentReferenceNumber>
    <EndDate>2026-05-26T23:13:54.3223049+02:00</EndDate>
    <HoursPerWeek>1</HoursPerWeek>
    <Id>1</Id>
    <IsDefaultEmployment>true</IsDefaultEmployment>
    <IsDefaultForLogin>true</IsDefaultForLogin>
    <OrganizationEntityId>7</OrganizationEntityId>
    <OrganizationEntityName>sample string 8</OrganizationEntityName>
    <StartDate>2026-05-26T23:13:54.3223049+02:00</StartDate>
  </Employment>
  <Employment>
    <DaysPerWeek>1</DaysPerWeek>
    <Description>sample string 3</Description>
    <Discipline>sample string 9</Discipline>
    <DisciplineId>1</DisciplineId>
    <EmployeeId>2</EmployeeId>
    <EmploymentReferenceNumber>sample string 10</EmploymentReferenceNumber>
    <EndDate>2026-05-26T23:13:54.3223049+02:00</EndDate>
    <HoursPerWeek>1</HoursPerWeek>
    <Id>1</Id>
    <IsDefaultEmployment>true</IsDefaultEmployment>
    <IsDefaultForLogin>true</IsDefaultForLogin>
    <OrganizationEntityId>7</OrganizationEntityId>
    <OrganizationEntityName>sample string 8</OrganizationEntityName>
    <StartDate>2026-05-26T23:13:54.3223049+02:00</StartDate>
  </Employment>
</ArrayOfEmployment>