ICal Export: Difference between revisions

Jump to navigation Jump to search
← Older edit
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 16: Line 16:
== Limitations ==
== Limitations ==
Only active bookings are exported, cancelled bookings will not appear.  
Only active bookings are exported, cancelled bookings will not appear.  
Settings in prices which limit availability are not considered.


Your Calendar program is responsible for routinely updating the calendar, we have no control over how often systems like Google calendar actually perform an update.
Your Calendar program is responsible for routinely updating the calendar, we have no control over how often systems like Google calendar actually perform an update.
Line 41: Line 43:


'''Include Room Description''': This link will show personal information plus the values of the template variables you have entered in the "iCal Room Description" field.
'''Include Room Description''': This link will show personal information plus the values of the template variables you have entered in the "iCal Room Description" field.
If you add &nourl=1 to the URL the link to the booking will be removed.


=== Activate ===
=== Activate ===
Line 73: Line 78:


== Data Options ==
== Data Options ==
Additional parameters can be added to the calendar URL to further specify the export data.
1. These options can be used to setup two way syncing to a google or other calendar without re-exporting imports and creating duplicate bookings. See also the options for iCal import to ignore duplicates.
{| class="wikitable"
|-
! scope="col"| Paramenter
! scope="col"| Use
|-
 
| &icalimport1=hide
| add this to not include bookings imported from channel Ical Import 1.
|-
 
| &icalimport2=hide
| add this to not include bookings imported from channel Ical Import 2.
|-
 
| &icalimport3=hide
| add this to not include bookings imported from channel Ical Import 3.
|-
 
|}
 
2. Additional parameters can be added to the calendar URL to further specify the export data.
{| class="wikitable"
|-
! scope="col"| Paramenter
! scope="col"| Use
|-
 
| &end=lastnight
| Exports the end date of the booking as the date of the last night, i.e. one day before the checkout date
|-
 
| &dates=checkin
| Only shows check-in days, not the rest of the booking
|-


These options can be used to setup two way syncing to a google or other calendar without re-exporting imports and creating duplicate bookings. See also the options for iCal import to ignore duplicates.
| &dates=checkout
'''&icalimport1=hide''' - add this to not include bookings imported from channel Ical Import 1.
| Only shows check-out days, not the rest of the booking
'''&icalimport2=hide''' - add this to not include bookings imported from channel Ical Import 2.
|-
'''&icalimport3=hide''' - add this to not include bookings imported from channel Ical Import 3.


| &showtime=true''
| Adds time to the calendar dates. Default checkin is added at 2PM and checkout at 10AM
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>This option should only be used if your software requires dates including time information.
|-


This option will export the end date of the booking as the date of the last night, i.e. one day before the checkout date.
| &starttime=hh:mm
'''&end=lastnight''' - add this to export end date as last night.
| Specifies the event start time, for example 16:00 when using &showtime=true
|-


| &endtime=hh:mm
| Specifies the event end time, for example 11:00 when using &showtime=true
|-


This option will only show check-in days, not the rest of the booking.
'''&dates=checkin''' - add this to export only the check-in day to the calendar.


| &timezone=Europe/London
| Specify the timezone if your calendar needs it, the timezone must be a valid ical timezone value. Valid timezone values can be found in the TZ* column at this link http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|-


This option will only show check-out days, not the rest of the booking.
| &hiderequest=true
'''&dates=checkout''' - add this to export only the check-out day to the calendar.
|Prevents request status bookings appearing in the ical
|-


| &hideblack=true
|Prevents black status bookings appearing in the ical
|-


This option should only be used if your software requires dates including time information.
| &showinquiry=true
'''&showtime=true''' - add this to add time to the calendar dates. Default checkin is added at 2PM and checkout at 10AM
|Shows Inquiry bookings in the ical, they will not appear without this option.
|-


Specify a different event start time when using &showtime=true.
| &includerooms=true
<code>&starttime=hh:mm</code>- add this to specify the event start time, for example 07:30
| Include the details of bookings included from other rooms as per the room dependency "Include Bookings From" settings.
|-


Specify a different event end time when using &showtime=true.
| &unavaildates=365
<code>&endtime=hh:mm</code> - add this to specify the event end time, for example 11:00
| The default days in the future returned is 365 days, this can be overridden with this parameter to any value between 0 and 750 days in advance.
|-


Specify a time zone when using &showtime=true.
| &nourl=true
<code>'&timezone=Europe/London</code>- add this to specify the timezone if your calendar needs it, the timezone must be a valid ical timezone value.
| Hides the view booking link.
Valid timezone values can be found in the TZ* column at this link http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|-


Hide request status bookings
| &back=7
<code>&hiderequest=true</code> - add this to prevent request status bookings appearing in the ical
| Include bookings from this many days ago (allowed values are 0 to 30).
|-


Include bookings from linked rooms
'''&includerooms=true''' - add this to include the details of bookings included from other rooms as per the room dependency "Include Bookings From" settings.


Number of days into the future to include unavailable dates
|}
<code>'&unavaildates=365</code>- the default is 365 days, this can be overridden with this parameter to any value between 0 and 750 days in advance.


== Troubleshooting ==
== Troubleshooting ==
Retrieved from "https://wiki.beds24.com/index.php/ICal_Export"