9,514
edits
Changes
no edit summary
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>'client_time_offset'</code> value in <code>$clientData</code> object as difference
zone you should specify <code>'client_time_offset'</code> value in <code>$clientData</code> object as difference
between company's time zone and client's time zone in seconds. For example if company located in city with time
between client's time zone and company's time zone in minutes. 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
zone GMT+2 and customer located in city with GMT+3 then <code>$clientTimeOffset</code> will be 60 minutes. You
can get information about company's time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To
can get information about company's 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
create batch booking you can 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
parameter can be specified). You should specify an <code>$additionalFields</code> parameter if service requires
some additional fields (see [[Custom_Features#Additional_Fields|Additional fields Custom feature]]). To create a booking with promo code you
some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]). To create a booking with promo code you
should pass it as additional field. For example: <code>{"name": "promocode", "value": "some code", "type": "text"}</code>See [[#book response|example]] of <code>book</code> API method response.
should pass it as additional field. For example: <code>{"name": "promocode", "value": "some code", "type": "text"}</code>See [[#book response|example]] of <code>book</code> API method response.
See also:
See also:
* [http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information]
* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]
----
----
----
----
=== confirmBookingPayment ===
=== confirmBookingPayment !Deprecated!===
<code>confirmBookingPayment($id, $paymentProcessor, $sign)</code>
<code>confirmBookingPayment($id, $paymentProcessor, $sign)</code>
Returns Array.
Returns Array.
Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom feature.
Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with locations Custom feature.
Returns empty array if all units are not allowed.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>
Eg.: <code>[1, 2, 3]</code>
Returns Array.
Returns Array.
Return additional fields for certain event if [[Custom_Features#Additional_Fields|Additional fields Custom feature]] is
Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.
API method to check if 'event_field' Custom Feature activated.
Returns Array.
Returns Array.
Returns available locations for company if Custom Feature [[Custom_Features#Unit_Location|Unit location Custom Feature]] is activated. Return
Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.
API method to check if Custom Feature activated.
----
----
=== getPluginPromoInfoByCode ===
<!----=== getPluginPromoInfoByCode ===
<code>getPluginPromoInfoByCode($code)</code>
<code>getPluginPromoInfoByCode($code)</code>
Returns Array.
Returns Array.
Returns an object with detailed information about promotion by promotion code. You can get promotion code
Returns an object with detailed information about Rewards and referrals promotion by promotion code. You can get promotion code
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified
code not found then method returns an empty array (an empty object). If [[Custom_Features#Simply_Smart_Promotions|Simply Smart Promotions Custom Feature]]
code not found then method returns an empty array (an empty object). If [[Rewards_and_Referrals_custom_feature|Rewards and Referrals Custom Feature]]
not enabled then method returns an error with code -32001 (Custom Feature is not activated). Use
not enabled then method returns an error with code -32001 (Custom Feature is not activated). Use
<code>[[#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled.See [[#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
<code>[[#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled.See [[#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).-->
----
----
=== getPromotionRewardInfo ===
<!---=== getPromotionRewardInfo ===
<code>getPromotionRewardInfo($commonPromotionId, $clientId, $hash)</code>
<code>getPromotionRewardInfo($commonPromotionId, $clientId, $hash)</code>
Returns promotion reward by common promotion id, client id and hash.
Returns promotion reward by common promotion id, client id and hash.
-->
----
----
If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Unit_Location|Unit Location]] Custom Feature description for
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple Locations]] Custom Feature description for
more details.
more details.
Returns Integer.
Returns Integer.
Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Settings#Timeframe|here]].
Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].
Returns String.
Returns String.
Returns company timeline type
Returns company calendar layout type
* -32062 Client email value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32063 Client phone value is wrong
* -32070 Additional field values are wrong
* -32070 Intake forms values are wrong
* -32080 Appointemnt couldn't be found
* -32080 Appointemnt couldn't be found
* -32085 Signature error
* -32085 Signature error
* time_format
* time_format
* timeframe
* timeframe
*: Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes. You can find more details about timeframe [[Settings#Timeframe|here]]
*: Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes. You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]]
* user_public_timeline_type
* user_public_timeline_type
*: String. Can be one of the following values:
*: String. Can be one of the following values:
*:Service categories
*:Service categories
* event_field
* event_field
*:Additional fields
*:Intake forms
* facebookImage
* facebookImage
*:Facebook client info
*:Facebook client info
*:Limit bookings
*:Limit bookings
* location
* location
*:Unit location
*:Multiple locations
* mobile_app_backend
* mobile_app_backend
*:Mobile application
*:Mobile application
* paid_events
* paid_events
*:Accept payments
*:Accept payments
* promo
<!--* promo
*:Simply Smart Promotions
*:Rewards and Referrals-->
* recap
* recap
*:Daily report
*:Daily report
----
----
====getPluginPromoInfoByCode response====
<!----====getPluginPromoInfoByCode response====
{
{
}
}
<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
<code>service_ids</code> contains a list of services for wich promotion discount can be applied.-->
----
----