POST PlanCare2Api/Timesheets/NonClient

Saves a new NonClient timesheet instance

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

Request Information

URI Parameters

None.

Body Parameters

The NonClient timesheet instance to save

TimesheetNonClient
NameDescriptionTypeAdditional information
OrganizationEntityId

Assigned organization entity id related to the registered worktype.

Identity

None.

Identifier

The Identifier of the timeregistration. Remarks: When using PlanCare2 identification: for new instance the Identifier should be 0 and Type should be PlanCare2Id When using External identification: the Identifier should always be your own identifier and Type should be ExternalId.

Identity

Required

Employee

References to the employee

Identity

Required

ProductId

References to the Product

integer

Required

Start

The start date and time

date

Required

End

The end date and time

date

Required

EmploymentId

References to the employment of the employee

integer

Required

WorkTypeId

References to an optional WorkType

integer

None.

Description

The description of the timeregistration

string

None.

ClientAbsent

Determines whether the client is absent

boolean

None.

ClientSigned

Determines whether the client has signed

boolean

None.

CostTypeId

The id of the costType

integer

None.

TravelMethodId

The id of the travelMethod

integer

None.

Cost

Amount of the cost

decimal number

None.

TravelDistance

The travel distances in km

integer

None.

TravelDuration

The travel duration in minutes

integer

None.

Location

The address

Location

None.

Request Formats

application/json, text/json

Sample:
{
  "OrganizationEntityId": {
    "$id": "2",
    "Identifier": "sample string 1",
    "Type": 0
  },
  "Identifier": {
    "$ref": "2"
  },
  "Employee": {
    "$ref": "2"
  },
  "ProductId": 1,
  "Start": "2026-05-26T21:01:06.1690561+02:00",
  "End": "2026-05-26T21:01:06.1690561+02:00",
  "EmploymentId": 4,
  "WorkTypeId": 1,
  "Description": "sample string 5",
  "ClientAbsent": true,
  "ClientSigned": true,
  "CostTypeId": 1,
  "TravelMethodId": 1,
  "Cost": 1.0,
  "TravelDistance": 1,
  "TravelDuration": 1,
  "Location": {
    "$id": "3",
    "ZipCode": "sample string 1",
    "HouseNumber": 1,
    "HouseNumberAddition": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<TimesheetNonClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.TimeSheet">
  <ClientAbsent>true</ClientAbsent>
  <ClientSigned>true</ClientSigned>
  <Cost>1</Cost>
  <CostTypeId>1</CostTypeId>
  <Description>sample string 5</Description>
  <Employee xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Employee>
  <EmploymentId>4</EmploymentId>
  <End>2026-05-26T21:01:06.1690561+02:00</End>
  <Identifier xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Identifier>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RealizedWorktime">
    <d2p1:HouseNumber>1</d2p1:HouseNumber>
    <d2p1:HouseNumberAddition>sample string 2</d2p1:HouseNumberAddition>
    <d2p1:ZipCode>sample string 1</d2p1:ZipCode>
  </Location>
  <ProductId>1</ProductId>
  <Start>2026-05-26T21:01:06.1690561+02:00</Start>
  <TravelDistance>1</TravelDistance>
  <TravelDuration>1</TravelDuration>
  <TravelMethodId>1</TravelMethodId>
  <WorkTypeId>1</WorkTypeId>
  <OrganizationEntityId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </OrganizationEntityId>
</TimesheetNonClient>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved NonClient timesheet instance

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.