Service
https://api.timewax.com/calendar/entries/add/
Goal
Adding resource or project bookings in the calendar or the planning board.
Request
The following xml structure must be provided:
<request>
<token></token>
<entry>
<type></type>
<resource></resource>
<project></project>
<breakdown></breakdown>
<status></status>
<date></date>
<timeFrom></timeFrom>
<hours></hours>
<fullDay></fullDay>
<location></location>
<description></description>
<remarks></remarks>
<linkedResources>
<resource></resource>
</linkedResources>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition>lt;/requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
<needsAction></needsAction>
<actionsText></actionsText>
</entry>
</request>
Parameter | Description | Required |
---|---|---|
token | Token for this request | yes |
type | Type of the booking. "entry" for resource bookings, "request" for request (= project) bookings. | yes |
resource | Code or name. The planned resource. | When type= "entry": yes |
project | Code or name. The project for the booking. | yes |
breakdown | Code or name. The breakdown for the booking. | yes |
status | Hard or Soft. The status of the booking | yes |
date | Date of the booking. Format: yyyymmdd. | yes |
timeFrome | Start time for the booking. Format: hh:mm. | yes |
hours | Number of hours. | yes |
fullDay | Yes or No.Marks the booking as "Full day" | no |
Location | The location field. | no |
description | The description field. | no |
remarks | The remarks field. | no |
linkedResources/resource | Code or name.Only for request bookings. The resource(s) connected to the booking. | no |
requestOrganisationalUnit | The Organisational Unit for the request. | no |
requestSkillLevel1 | The requestSkillLevel 1 for the request. | no |
requestSkillLevel2 | The requestSkillLevel 2 for the request. | no |
requestSkillLevel3 | The requestSkillLevel 3 for the request. | no |
needsAction | Yes or no. Marks if there is an action for this booking | no |
actionsText | Description of the action | no |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
</response>
Parameter | Description |
---|---|
valid | Indication that service was executed successfully |
id | Id of the entry |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<id></id>
<errors>no</errors>
</response>
Opmerkingen