API WIKI

User Tools

Site Tools

Trace:
planner

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
planner [2018/10/29 15:30]
clubadmin [Planner.AddReservation] 		planner [2023/06/28 16:22] (current)
Line 9: Line 9:
 ===== Planner.GetCalendarItems =====  ===== Planner.GetCalendarItems ===== 
  
- Returns all items in the give calendar where the member has access to+ Returns all items in the given calendar where this member has access
  
         /// <param name="token"></param>         /// <param name="token"></param>
Line 15: Line 15:
         /// <param name="date"></param>         /// <param name="date"></param>
         /// <param name="days">1</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). Get all calenderitems for a given calender and date, set id = 0 for all calendars (= no filter).
Line 21: Line 22:
  
 https://demo.clubplanner.be/api/planner/getcalendarItems?token=DEMOTOKEN&id=1&date=01/01/2017&days=7 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 =====  ===== Planner.AddReservation ===== 
Line 27: Line 39:
  
         /// <param name="token"></param>         /// <param name="token"></param>
-        /// <param name="memberid"></param> +        /// <param name="memberid">id of the member</param> 
-        /// <param name="itemid"></param> +        /// <param name="itemid">id of the calendaritem, you need to use getcalendaritems first</param> 
-        /// <param name="quantity">optional</param> +        /// <param name="quantity">optional, default 1</param> 
-        /// <param name="logtype">optional</param>+        /// <param name="logtype">optional: LogType</param>
         /// <param name="fullname">optional name</param>         /// <param name="fullname">optional name</param>
         /// <param name="from">optional</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 =====  ===== Planner.GetReservations ===== 
Line 78: Line 105:
         /// <param name="fromdate"></param>         /// <param name="fromdate"></param>
         /// <param name="todate"></param>         /// <param name="todate"></param>
-        /// <param name="description"></param> +        /// <param name="description">description of the event</param> 
-        /// <param name="calendarid"></param> +        /// <param name="calendarid">id of the calendar</param> 
-        /// <param name="cost"></param> +        /// <param name="cost">optional</param> 
-        /// <param name="note"></param> +        /// <param name="note">optional</param> 
-        /// <param name="quantity"></param> +        /// <param name="quantity">optional, default 1</param> 
-        /// <param name="roomid"></param> +        /// <param name="roomid">id of the room</param> 
-        /// <param name="memberid"></param> +        /// <param name="memberid">optional, will also add reservation for this member</param> 
-        /// <param name="activity"></param> +        /// <param name="activityId">optional id (number)</param> 
-        /// <param name="from"></param>+        /// <param name="employeeid">optional, id of the employee</param> 
 +        /// <param name="from">optional</param> 
 + 
 +Example:
  
 +https://demo.clubplanner.be/api/planner/addcalendaritem?token=DEMOTOKEN&fromdate=2023-01-01T12:30:00&todate=2023-01-01T13:00:00&description=testdescription&calendarid=46&roomid=1
 ===== Planner.AddToWaitingList=====  ===== Planner.AddToWaitingList===== 
  
Line 99: Line 130:
         /// <param name="logtype"></param>         /// <param name="logtype"></param>
         /// <param name="from"></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=====  ===== Planner.DeleteWaitingListItem===== 
  
Line 108: Line 147:
         /// <param name="from"></param>         /// <param name="from"></param>
                  
-===== Planner.DeleteCalendarItem ===== 
  
-Removes a given calendar item.+===== Planner.UpdateCalendarItem ===== 
 + 
 +Updates a given calendar item.
  
         /// <param name="token"></param>         /// <param name="token"></param>
-        /// <param name="id"></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>    
  
-Note : you can only delete calendar item via the API.+===== Planner.GetFreeTimeslots =====  
 +Returns a list with free timeslots for a given activity
  
 +        /// <param name="token"></param>
 +        /// <param name="calendarid">id of the calendar</param>
 +        /// <param name="date">date of the selected day</param>
 +        /// <param name="activityId">id of the activity (number)</param>
 +        
 +        
 +https://demo.clubplanner.be/api/planner/GetFreeTimeslots?token=DEMOTOKEN&date=2023-10-01&calendarid=46&activityId=1
 +
 +===== Planner.GetActivities ===== 
 +Returns a list of activities linked to a calendar
 +
 +        /// <param name="token"></param>
 +        /// <param name="calendarid">id of the calendar</param>
 +          
 +https://demo.clubplanner.be/api/planner/GetActivities?token=DEMOTOKEN&calendarid=92
planner.1540823453.txt.gz · Last modified: 2018/10/29 16:30 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki