GET PlanCare2Api/RootData/Worktypes

Get all worktypes

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The list of worktypes

Collection of WorkType

Name	Description	Type	Additional information
Id	Id of the worktype	integer	None.
Code	Unique code of the worktype	string	None.
Name	Name of the worktype	string	None.
Description	Description of the worktype	string	None.
StartDate	Startdate of the worktype	date	None.
EndDate	Optional enddate of the worktype	date	None.
WorkTypeIsDirect	Indicator if worktype is direct or indirect	boolean	None.
ExternalCode	External code of worktype by connector based on ApiKey	string	None.
IsWorkTime	Indicator if worktype is working time	boolean	None.
OrganizationEntities	Assigned organization entities	Collection of OrganizationEntity	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "StartDate": "2026-05-26T21:01:03.0158688+02:00",
    "EndDate": "2026-05-26T21:01:03.0158688+02:00",
    "WorkTypeIsDirect": true,
    "ExternalCode": "sample string 7",
    "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:

<ArrayOfWorkType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <WorkType>
    <Code>sample string 2</Code>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T21:01:03.0158688+02:00</EndDate>
    <ExternalCode>sample string 7</ExternalCode>
    <Id>1</Id>
    <IsWorkTime>true</IsWorkTime>
    <Name>sample string 3</Name>
    <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>
    <StartDate>2026-05-26T21:01:03.0158688+02:00</StartDate>
    <WorkTypeIsDirect>true</WorkTypeIsDirect>
  </WorkType>
  <WorkType>
    <Code>sample string 2</Code>
    <Description>sample string 4</Description>
    <EndDate>2026-05-26T21:01:03.0158688+02:00</EndDate>
    <ExternalCode>sample string 7</ExternalCode>
    <Id>1</Id>
    <IsWorkTime>true</IsWorkTime>
    <Name>sample string 3</Name>
    <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>
    <StartDate>2026-05-26T21:01:03.0158688+02:00</StartDate>
    <WorkTypeIsDirect>true</WorkTypeIsDirect>
  </WorkType>
</ArrayOfWorkType>