GET PlanCare2Api/RealizedWorktime?dateFrom={dateFrom}&dateUntil={dateUntil}&employmentOrganizationEntity={employmentOrganizationEntity}

Retrieve all realized worktime filtered by organization entity

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

Request Information

URI Parameters

Name Description Type Additional information
dateFrom

Start date for the filter

date

Required

dateUntil

End date for the filter

date

Required

employmentOrganizationEntity

The id of the organization entity filter

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns all realized worktime filtered by organization entity

Collection of RealizedWorktime
Name Description Type Additional information
TimesheetId

The internal id of the realized timesheet

integer

-

ExternalId

The external id of the realized timesheet

string

-

WorkTypeCode

The code of the worktype

string

-

WorkTypeOrganizationEntity

Organization entity of the worktype

OrganizationEntity

-

EmployeeRegistrationNumber

Registration number of the employee

string

-

EmployeeEmploymentNumber

Employment number of the employee

string

-

EmploymentOrganizationEntity

Organization entity of the employee's employment

OrganizationEntity

-

ClientOrganizationEntity

Organization entity of the client

OrganizationEntity

-

Location

The address

Location

-

Start

The start date and time

date

-

End

The end date and time

date

-

Amount

The duration in minutes

integer

-

ApprovalLevel

The current approval level

integer

-

TravelDistance

The travel distances in km

integer

Nullable

TravelMethod

The travelMethod

TravelMethod

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "TimesheetId": 1,
    "ExternalId": "sample string 2",
    "WorkTypeCode": "sample string 3",
    "WorkTypeOrganizationEntity": {
      "$id": "2",
      "CostCenter": "sample string 1",
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Id": {
        "$id": "3",
        "Identifier": "sample string 1",
        "Type": 0
      }
    },
    "EmployeeRegistrationNumber": "sample string 4",
    "EmployeeEmploymentNumber": "sample string 5",
    "EmploymentOrganizationEntity": {
      "$ref": "2"
    },
    "ClientOrganizationEntity": {
      "$ref": "2"
    },
    "Location": {
      "$id": "4",
      "ZipCode": "sample string 1",
      "HouseNumber": 1,
      "HouseNumberAddition": "sample string 2"
    },
    "Start": "2026-05-26T23:17:43.291784+02:00",
    "End": "2026-05-26T23:17:43.291784+02:00",
    "Amount": 8,
    "ApprovalLevel": 9,
    "TravelDistance": 1,
    "TravelMethod": {
      "$id": "5",
      "Id": 1,
      "Code": "sample string 2",
      "Description": "sample string 3"
    }
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRealizedWorktime xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RealizedWorktime">
  <RealizedWorktime>
    <Amount>8</Amount>
    <ApprovalLevel>9</ApprovalLevel>
    <ClientOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </ClientOrganizationEntity>
    <EmployeeEmploymentNumber>sample string 5</EmployeeEmploymentNumber>
    <EmployeeRegistrationNumber>sample string 4</EmployeeRegistrationNumber>
    <EmploymentOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </EmploymentOrganizationEntity>
    <End>2026-05-26T23:17:43.291784+02:00</End>
    <ExternalId>sample string 2</ExternalId>
    <Location>
      <HouseNumber>1</HouseNumber>
      <HouseNumberAddition>sample string 2</HouseNumberAddition>
      <ZipCode>sample string 1</ZipCode>
    </Location>
    <Start>2026-05-26T23:17:43.291784+02:00</Start>
    <TimesheetId>1</TimesheetId>
    <TravelDistance>1</TravelDistance>
    <TravelMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RootData">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:Description>sample string 3</d3p1:Description>
      <d3p1:Id>1</d3p1:Id>
    </TravelMethod>
    <WorkTypeCode>sample string 3</WorkTypeCode>
    <WorkTypeOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </WorkTypeOrganizationEntity>
  </RealizedWorktime>
  <RealizedWorktime>
    <Amount>8</Amount>
    <ApprovalLevel>9</ApprovalLevel>
    <ClientOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </ClientOrganizationEntity>
    <EmployeeEmploymentNumber>sample string 5</EmployeeEmploymentNumber>
    <EmployeeRegistrationNumber>sample string 4</EmployeeRegistrationNumber>
    <EmploymentOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </EmploymentOrganizationEntity>
    <End>2026-05-26T23:17:43.291784+02:00</End>
    <ExternalId>sample string 2</ExternalId>
    <Location>
      <HouseNumber>1</HouseNumber>
      <HouseNumberAddition>sample string 2</HouseNumberAddition>
      <ZipCode>sample string 1</ZipCode>
    </Location>
    <Start>2026-05-26T23:17:43.291784+02:00</Start>
    <TimesheetId>1</TimesheetId>
    <TravelDistance>1</TravelDistance>
    <TravelMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RootData">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:Description>sample string 3</d3p1:Description>
      <d3p1:Id>1</d3p1:Id>
    </TravelMethod>
    <WorkTypeCode>sample string 3</WorkTypeCode>
    <WorkTypeOrganizationEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:CostCenter>sample string 1</d3p1:CostCenter>
      <d3p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </WorkTypeOrganizationEntity>
  </RealizedWorktime>
</ArrayOfRealizedWorktime>