9,514
edits
Changes
From SimplyBook.me
Company administration service methods (view source)
Revision as of 09:27, 30 December 2015
, 8 years agono edit summary
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
[[#getTimeframe|<code>getTimeframe</code>]] API method). <code>$endDate</code> and <code>$endTime</code> parameters
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using [[#getCompanyInfo|<code>getCompanyInfo</code>]] API method. To create batch booking you can
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some additional
specified). You should specify an <code>$additionalFields</code> parameter if service requires some additional
Parameters:
Parameters:
* '''$shedulerId''' Integer an id of booking to edit. See [[#book|<code>book</code>]] or [[#getBookings|<code>getBookings</code>]] API methods.
* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|<code>book</code>]] or [[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$unitId''' Integer
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking plugin status.
* '''booking_type''' a string. Value of this field depends on Approve booking plugin status.
If plugin not active:
** '''all''' for all bookings (default value)
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
If plugin active:
** '''all''' for all bookings (default value)
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
Returns Array.
Returns Array.
Returns all information about current tariff (subscription). For example:
Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"expire_date" : "2016-02-11 12:32:00",
