User Tools

Site Tools


planner

This is an old revision of the document!


Planner.GetCalendars

Returns all agenda's available, internally an agenda is called a calendar

      /// <param name="token"></param>
      /// <param name="memberid"></param>
  

Example: https://demo.clubplanner.be/api/planner/getcalendars?token=DEMOTOKEN&memberid=1

Planner.GetCalendarItems

Returns all items in the given calendar where this member has access

      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="date"></param>
      /// <param name="days">1</param>
      /// <param name="employeeid">optional or 0 for no filter on employee</param>

Get all calenderitems for a given calender and date, set id = 0 for all calendars (= no filter).

Example:

https://demo.clubplanner.be/api/planner/getcalendarItems?token=DEMOTOKEN&id=1&date=01/01/2017&days=7

Planner.GetCalendarItem

Returns 1 calendar item

      /// <param name="token"></param>
      /// <param name="id"></param>

Example:

https://demo.clubplanner.be/api/planner/getcalendarItem?token=DEMOTOKEN&id=1

Planner.AddReservation

Add a reservation for a given calendaritem

      /// <param name="token"></param>
      /// <param name="memberid">id of the member</param>
      /// <param name="itemid">id of the calendaritem, you need to use getcalendaritems first</param>
      /// <param name="quantity">optional, default 1</param>
      /// <param name="logtype">optional: LogType</param>
      /// <param name="fullname">optional name</param>
      /// <param name="from">optional</param>

LogType:

  Manual = 0
  Mobile = 1
  Email = 2
  CheckInPoint = 3
  Web = 4
  WaitingList = 5
  App = 6
  Registration = 7
  ReservationWizard = 8

Example:

https://demo.clubplanner.be/api/planner/AddReservation?token=DEMOTOKEN&memberid=1&itemid=1

Planner.GetReservations

Get all the current reservations for a given member

      /// <param name="token"></param>
      /// <param name="memberid">id of the member (optional)</param>
      /// <param name="calitemid">id of the calendaritem (optional)</param>
      /// <param name="calid">id of the calendar (optional)</param>
      /// <param name="fromdate">startdate, to be used with calid (optional)</param>
      /// <param name="todate">enddate, to be used with calid (optional)</param>

Examples:

All reservations for a given member https://demo.clubplanner.be/api/planner/getreservations?token=DEMOTOKEN&memberid=1

All reservations for a given calendaritem https://demo.clubplanner.be/api/planner/getreservations?token=DEMOTOKEN&calitemid=1

All reservations for a given calendar, with start and enddate https://demo.clubplanner.be/api/planner/getreservations?token=DEMOTOKEN&calid=1&fromdate=01/09/2018&todate=01/10/2018

Planner.CancelReservation

Cancels a given reservation

      /// <param name="token"></param>
      /// <param name="reservationid"></param>
      /// <param name="from"></param>

Example: https://demo.clubplanner.be/api/planner/CancelReservation?token=DEMOTOKEN&reservationid=1

Planner.AddCalendarItem

Add an activity to a given calendar, internally an activity is called a calendaritem

      /// <param name="token"></param>
      /// <param name="fromdate"></param>
      /// <param name="todate"></param>
      /// <param name="description">description of the event</param>
      /// <param name="calendarid">id of the calendar</param>
      /// <param name="cost">optional</param>
      /// <param name="note">optional</param>
      /// <param name="quantity">optional, default 1</param>
      /// <param name="roomid">id of the room</param>
      /// <param name="memberid">optional, will also add reservation for this member</param>
      /// <param name="activity">optional</param>
      /// <param name="employeeid">optional, id of the employee</param>
      /// <param name="from">optional</param>

Planner.AddToWaitingList

Add 1 position on the waitinglist of a given calendaritem (itemid). Will return BadRequest when waitinglist is disabled or member is already on waiting list. Will return the ID of the waitinglist item when OK.

      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="itemid"></param>
      /// <param name="logtype"></param>
      /// <param name="from"></param>

Planner.DeleteCalendarItem

Remove an item from the calendar, you need the exact id of the calendaritem.

      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="from"></param>
              

Planner.DeleteWaitingListItem

Remove a waitinglist item, you need the exact id of the waitinglistitem.

      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="from"></param>
      

Planner.UpdateCalendarItem

Updates a given calendar item.

      /// <param name="token"></param>
      /// <param name="id">id of the calendar item</param>
      /// <param name="fromdate">optional</param>
      /// <param name="todate">optional</param>
      /// <param name="description">optional</param>
      /// <param name="cost">optional</param>
      /// <param name="note">optional</param>
      /// <param name="quantity">optional</param>
      /// <param name="roomid">optional</param>
      /// <param name="memberid">optional</param>
      /// <param name="employeeid">optional</param>
      /// <param name="activity">optional</param>
      /// <param name="from">optional</param>    
planner.1687854641.txt.gz · Last modified: 2023/06/27 10:30 (external edit)