API Reference

for object "Vacations"

Find here the list of actions to apply on the objects, and the data reference for this object.




What is a vacation request ?

It's a request from an employee for days of vacations or absences




Getting the vacation requests list

GET /vacation_requests.xml

Returns all vacation requests, page by page
Add a page parameter to navigate




Getting a single vacation request

GET /vacation_requests/#{id}.xml

Returns a single vacation request, identified by its id




Creating a new vacation request

POST /vacation_requests.xml

Creates a new vacation request, and returns the vacation request data




Updating an existing vacation request

PUT /vacation_requests/#{id}.xml

Updates some fields of an existing vacation request




Deleting an existing vacation request

DELETE /vacation_requests/#{id}.xml

Deletes the vacation request identified by its id




Object data

<vacation_request>
 <id>id of this object</id>
 <status_id>status of request (see below)</status_id>
 <staff_member_id>id of the staff member</staff_member_id>
 <start_date>first day of absence</start_date>
 <stop_date>day of return</stop_date>
 <duration>number of days of absence</duration>
 <vacation_type_id>type of absence (see below)</vacation_type_id>
</vacation_request>




Possible values of status

  • 65 if waiting approval

  • 66 if accepted

  • 67 if refused

  • 509 if being written



Possible values of vacation type

  • 61 if paid vacations

  • 62 if rest

  • 63 if employer rtt

  • 64 if employee rtt

  • 68 if absence without pay

  • 573 if sickness