GET PlanCare2Api/RootData/Worktypes?dateFrom={dateFrom}&dateUntil={dateUntil}

Get worktypes within date selection where the startdate of the worktype should by in the selected period.

Request Information

URI Parameters

Name Description Type Additional information
dateFrom

Startdate of period

date

Required

dateUntil

Enddate of period

date

Required

Body Parameters

None.

Response Information

Resource Description

Collection of WorkTypeBulk
Name Description Type Additional information
ProductId

Id of the product

integer

-

ContractTypeId

Id of the contractType

integer

-

ContractTypeCode

Code of the contractType

string

-

WorkTypeId

Id of the worktype

integer

-

WorktTypeCode

Unique code of the worktype

string

-

WorkTypeName

Name of the worktype

string

-

WorkTypeDescription

Description of the worktype

string

-

StartDate

Startdate of the worktype

date

-

EndDate

Optional enddate of the worktype

date

Nullable

ExternalCode

External code of worktype by connector based on ApiKey

string

-

IsWorkTime

Indicator if worktype is working time

boolean

-

OrganizationEntities

Assigned organization entities

Collection of OrganizationEntity

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "ProductId": 1,
    "ContractTypeId": 2,
    "ContractTypeCode": "sample string 3",
    "WorkTypeId": 4,
    "WorktTypeCode": "sample string 5",
    "WorkTypeName": "sample string 6",
    "WorkTypeDescription": "sample string 7",
    "StartDate": "2026-05-26T21:07:33.5821292+02:00",
    "EndDate": "2026-05-26T21:07:33.5821292+02:00",
    "ExternalCode": "sample string 9",
    "IsWorkTime": true,
    "OrganizationEntities": [
      {
        "$id": "2",
        "CostCenter": "sample string 1",
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Id": {
          "$id": "3",
          "Identifier": "sample string 1",
          "Type": 0
        }
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfWorkTypeBulk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <WorkTypeBulk>
    <ContractTypeCode>sample string 3</ContractTypeCode>
    <ContractTypeId>2</ContractTypeId>
    <EndDate>2026-05-26T21:07:33.5821292+02:00</EndDate>
    <ExternalCode>sample string 9</ExternalCode>
    <IsWorkTime>true</IsWorkTime>
    <OrganizationEntities>
      <OrganizationEntity>
        <Code>sample string 2</Code>
        <CostCenter>sample string 1</CostCenter>
        <Id xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </Id>
        <Name>sample string 3</Name>
      </OrganizationEntity>
      <OrganizationEntity>
        <Code>sample string 2</Code>
        <CostCenter>sample string 1</CostCenter>
        <Id xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </Id>
        <Name>sample string 3</Name>
      </OrganizationEntity>
    </OrganizationEntities>
    <ProductId>1</ProductId>
    <StartDate>2026-05-26T21:07:33.5821292+02:00</StartDate>
    <WorkTypeDescription>sample string 7</WorkTypeDescription>
    <WorkTypeId>4</WorkTypeId>
    <WorkTypeName>sample string 6</WorkTypeName>
    <WorktTypeCode>sample string 5</WorktTypeCode>
  </WorkTypeBulk>
  <WorkTypeBulk>
    <ContractTypeCode>sample string 3</ContractTypeCode>
    <ContractTypeId>2</ContractTypeId>
    <EndDate>2026-05-26T21:07:33.5821292+02:00</EndDate>
    <ExternalCode>sample string 9</ExternalCode>
    <IsWorkTime>true</IsWorkTime>
    <OrganizationEntities>
      <OrganizationEntity>
        <Code>sample string 2</Code>
        <CostCenter>sample string 1</CostCenter>
        <Id xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </Id>
        <Name>sample string 3</Name>
      </OrganizationEntity>
      <OrganizationEntity>
        <Code>sample string 2</Code>
        <CostCenter>sample string 1</CostCenter>
        <Id xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </Id>
        <Name>sample string 3</Name>
      </OrganizationEntity>
    </OrganizationEntities>
    <ProductId>1</ProductId>
    <StartDate>2026-05-26T21:07:33.5821292+02:00</StartDate>
    <WorkTypeDescription>sample string 7</WorkTypeDescription>
    <WorkTypeId>4</WorkTypeId>
    <WorkTypeName>sample string 6</WorkTypeName>
    <WorktTypeCode>sample string 5</WorktTypeCode>
  </WorkTypeBulk>
</ArrayOfWorkTypeBulk>