API-dokumentasjon

Returns API url for given company login

• @param String $companyLogin
• @return String

Returns an application's token string for a company. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To

get application API key you need to enable [[Plugins#API|API plugin]].

• @param String $companyLogin
• @param String $apiKey
• @return String

Returns an authentication token string for certain user registered for company. You should use this token to
authenticate all calls of [[Company administration service methods|Company administration service API methods]] and

[[Catalogue|Catalogue API methods]].

• @param String $companyLogin a company identifier (login)
• @param String $userLogin user's login associated with company
• @param String $userPassword user's password
• @return String

Returns an application's token string for an application. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To

get application API key please contact SimplyBook.me support team.

• @param String $applicationApiKey
• @return String

{@inheritdoc}

• @param bool $isVisibleOnly
• @param bool $asArray
• @param integer $handleClasses
• @param string $searchString part of name (used for comboboxes)
• @return Array

{@inheritdoc}

• @param bool $isVisibleOnly
• @param bool $asArray
• @param integer $handleClasses (1 - classes only, -1 without classes, null - skip classes check)
• @param string $searchString part of name (used for comboboxes)
• @return Array

{@inheritdoc}

• @param bool $isPublic
• @return Array

{@inheritdoc}

• @param Boolean $isPublic
• @return Array

Returns payment processor config

• @param String $paymentProcessor
• @return Array

Validate application payment.

• @param mixed $paymentInfo
• @param Integer $cartId
• @return Boolean

Returns cart information by bookings ids.
cart_id and cart_hash is used to create secure signature to confirm cart payment.

status - current cart status
amount - is total amount to payment
currency - cart currency
cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
id - booking id
event_id - service id
name - event name + start date time (use it to provide cart information for payment system)
price - booking price
qty - qty of bookings

• @param Array $bookingIds
• @return Object

Returns current cart information
cart_id and cart_hash is used to create secure signature to confirm cart payment.

amount - is total amount to payment
currency - cart currency
cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
id - booking id
event_id - service id
name - event name + start date time (use it to provide cart information for payment system)
price - booking price
qty - qty of bookings

• @param Integer $cartId cart id
• @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
• @return Object

Returns current cart status
Possible result values:

cancel - user has canceled payment
paid - user has paid
error - error has been occurred on validation payment
not_paid - cart is not paid yet or payment status is pending

• @param Integer $id
• @return String

Confirm booking cart. Use it to confirm payment. Signature is required.

• @param Integer $cartId cart id
• @param String $paymentProcessor payment processor name
• @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
• @return Boolean

Confirm booking. Signature is required.
$sign = md5($bookingId . $bookingHash . $secretKey);

Call this method from server side only

• @param Integer $id
• @param String $sign
• @return Boolean

Confirm booking payment. Signature is required.
$sign = md5($bookingId . $bookingHash . $secretKey);

Call this method from server side only

• @param Integer $id
• @param String $paymentProcessor
• @param String $sign
• @return Boolean

Confirms booking batch. Signature is required.
$sign = md5($batchId . $batchHash . $secret)

Call this method from server side only

• @param Integer $batchId
• @param String $batchType
• @param String $sign
• @return Boolean

Returns an object with details information about booking. $sign parameter must be a string created
with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

value as result of [[#book|book]] API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if $sign parameter is wrong.

• @param Integer $id
• @param String $sign
• @return Object

Returns an object with details information about booking. $sign parameter must be a string created
with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

value as result of [[#book|book]] API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if $sign parameter is wrong.

• @param Integer $id
• @param String $sign
• @return Object

Returns true if [[Plugins#Accept_payments|Accept payments]] plugin activated and event with specified id has
configured price. If no paramentes specified then method returns true if payments plugin activated and at least

one event has configured price. Otherwise returns false.

• @param Integer $eventId
• @return Boolean

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be

require_confirm = true. $startDate and $startTime specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
[[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that $endDate and $endTime should be
later in time than $startDate and $startTime. If your clients located in different time
zone you should specify 'client_time_offset' value in $clientData object as difference
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 $clientTimeOffset will be 60 minutes. You
can get information about company's time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To
create batch booking you can specify either count more then 1 or valid batchId (only one
parameter can be specified). You should specify an $additionalFields parameter if service requires
some additional fields (see [[Plugins#Additional fields|Additional fields plugin]]). To create a booking with promo code you
should pass it as additional field. For example: {"name": "promocode", "value": "some code", "type": "text"}

See [[#book response|example]] of book API method response.

• @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
• @param Integer $eventId
• @param Integer $unitId
• @param String $date in Y-m-d format
• @param String $time in H:i:s format
• @param Object|array $clientData eg. {name: 'Name', email: 'test@gmail.com', phone: '+38099999999'}
• @param array|Object $additional additional params and fields.
• @param Integer $count bookings count, min. 1 (using for group bookings batch). (optional)
• @param Integer $batchId add booking to multiple bookings batch. (optional)
• @param Array $recurringData make booking recurrent. (optional)
• @return Object

Get list of dates for recurring booking

• @param Integer $eventId
• @param Integer $unitId
• @param String $date
• @param String $time
• @param array $recurringData
• @param array $productIds
• @return array

Returns availability of active promotions

• @return Boolean

Validate promotion code.
Returns true in case promocode is valid otherwise throws exception with error.

• @param String $code
• @param String $startDateTime
• @param Integer $eventId
• @param Integer $count
• @param array|Object $clientData
• @return Boolean

Returns an object with detailed information about promotion by promotion code. Returns null if no promotions with
specified code were not found.

• @param String $code
• @return Array

Returns promotion reward by common promotion id, client id and hash.

• @param Integer $commonPromotionId
• @param Integer $clientId
• @param String $hash
• @return Array

Returns user license text if user license plugin is turned on,
otherwise throws exception

• @return String

Returns user privacy policy text if user license plugin is turned on and privacy policy is enabled,
otherwise throws exception

• @return String

Returns client info by client id

• @param Integer $clientId
• @param String $sign signature = md5($clientId . $clientHash . $secretKey)
• @return Object

Returns client information by clients login (email)/password

• @param String $login
• @param String $password
• @return Object

Sends remind email for client

• @param String $email
• @return Boolean

Get client information by client login hash

• @param String $hash
• @param Boolean $setExpired
• @param Boolean $expireOtherHashes
• @return Object

Change client password

• @param int $clientId
• @param array $data
• @param string $sign
• @return bool

Edit client information data

• @param Integer $clientId
• @param Array $data
• @param String $sign signature = md5($clientId . $clientHash . $secretKey)
• @return Object

Returns list of available memberships

• @return Array

Returns purchased membership list

• @param Array $filter
• @param Integer $clientId
• @param String $sign
• @return Array

Returns client bookings, accepts $filter ($filter {upcoming_only: true/false, confirmed_only: true/false})

• @param integer $clientId
• @param string $sign
• @param object|array $filter
• @return array

Returns product list with filter.
At this time filter can accept only service_id parameter

• @param object $filter
• @return array

Returns company's classes list. Ordered by position

• @param Array $filter
• @return Array

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

• @param int $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
• @param string $sign
• @param String $startDate in Y-m-d format
• @param String $startTime in H:i:s format
• @param String $endDate in Y-m-d format
• @param String $endTime in H:i:s format
• @param array $additional
• @param int $clientTimeOffset
• @param string $clientTimezone
• @return Object
• @throws Api_Service_Exception
• @throws Exception

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not

allowed. See [[#Company_params|list of available keys]].

• @param String $key
• @return mixed

Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
it will return '''false''' as result. A different set of keys available for public API and for company

administration API. See [[#Company_params|list of available keys]].

• @param Array $keys
• @return Array

Returns cancellation policy rules.
If cancellation policy custom feature is not activated, method returns null.

• @return Array

Returns company timeline type

• @return String

Returns end datetime if booking is available, else return false

• @param String $startDateTime a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
• @param Integer $eventId
• @param Integer $unitId
• @param array $productIds
• @return String

Returns company work schedule as array
Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}

• @param Integer $year
• @param Integer $month
• @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
• @return Object

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type reserved_time and type

not_worked_time. reserved_time type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.

If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call
[[#isPluginActivated|isPluginActivated('google_calendar_export')]] API method to check if Google
calendar sync plugin activated.


Example:

  {

    "2016-02-05": [

      {

        "dd": [], // time slots from Google calendar

        "events": [ // reserved time slots

          { "from": "16:00", "to": "16:30" },

          { "from": "16:30", "to": "17:00" },

          ... ],

        "type": "reserved_time",

      },

      {

        "events": [

          { "from": "09:00", "to": "09:30" },

          { "from": "09:30", "to": "10:00" },

          ... ],

        "type": "not_worked_time"

     }],

     ...

  }

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Integer $unitId
• @param Integer $count
• @return Object

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from

service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:

  {'2014-05-14' : [

    {'from': '09:00:00', 'to': '13:00:00'},

    {'from': '14:00:00', 'to': '19:00:00'}

  ] }

• @param String $from
• @param String $to
• @param Integer $unitId (optional)
• @param Integer $eventId (optional)
• @param Integer $count (optional)
• @param array $productIds (optional)
• @return array

Returns first working date for unit

• @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
• @return String

Returns available start time, taking into account breaktimes, start and end working time
Eg.: {'2014-05-14': ['09:00:00', ...], ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @param int $bookingId
• @param array $productIds
• @return array

Returns available start time, taking into account breaktimes, start and end working time.
The difference between getStartTimeMatrix and getCartesianStartTimeMatrix is that getCartesianStartTimeMatrix

provides time slots for each individual provider.
Eg.: {"provider_id": 1, "service_id": 1, "timeslots": {"2014-05-14": ['09:00:00', ...], ...}, ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @param int $bookingId
• @param array $productIds
• @return array

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

• @param String $dateFrom
• @param String $dateTo
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @return Object

Returns available time intervals for all servics for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

• @param String $dateFrom
• @param String $dateTo
• @param Mixed $eventId can be Integer or Array of Integers
• @param Integer $unitId
• @param Integer $count
• @return Object

Returns not available time
Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}

• @param String $dateFrom
• @param String $dateTo
• @param Integer $eventId
• @param Integer|Array $unitId
• @param Integer $count
• @param int $bookingId
• @return array

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.
Eg.: [1, 2, 3]

• @param Integer $eventId
• @param String $dateTime a date and time string in format 'Y-m-d H:i:s'
• @param int $count
• @param int $unitId
• @param array $productIds
• @return array
• @throws Exception

Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
null if plugin not enabled.

Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

• @return Object

Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
activated. Returns empty array otherwise. Call [[#isPluginActivated|isPluginActivated('event_field')]]

API method to check if 'event_field' plugin activated.

• @param Integer $eventId
• @return Array

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]].

• @return Integer

Return plugin status true if status active, else false. $pluginName parameter is a plugin identifier.
See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].

• @param String $pluginName
• @return Boolean

Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].

• @param Array $pluginNames
• @return Array

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

• @return Object

Creates new booking batch record. Returns newly created batch id. You can use this id in [[#book|book]]
API method.

• @return Integer

Returns country phone code list

• @return Array

Returns an object with detailed information about promotion by promotion code. You can get promotion code
using [[Catalogue#getPromotionList|getPromotionList]] API method. If promotion record with specified

code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
not enabled then method returns an error with code -32001 (Plugin is not activated). Use
[[#isPluginActivated|isPluginActivated('promo')]] API method call to check if plugin enabled.


See [[#getPromotionList response|example]] of getPromotionList API method response. Please note that
response contains a list of services for wich promotion discount can be applied (service_ids key).

• @param String
• @return Array

Returns company timezone offset and company timezone

• @return array

Get user db data (id, phone, is_validated)

• @param int $userId
• @param string $number

Save configuration keys

• @param array $data
• @param string $module optional
• @param string $plugin optional
• @return array

Get structure of SMS and Email notification config params

• @param string $plugin optional
• @return mixed

Returns list of bookings filtered by given params. Filter params represented as object with following fields:

* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''edited_date_from''' a date string in format 'Y-m-d'
* '''edited_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Plugins#Approve booking|Approve booking]] plugin enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''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.
* '''code''' booking code
*: If plugin not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If plugin active:
** '''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)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

• @param Array
• @return Array

'create', 'cancel', 'new_client', 'change', 'create_invoice'

• @param string $url
• @param string $notificationType
• @return bool

• @return array

Returns client data

• @param int|string $clientId
• @return array

Returns client data

• @param int|string $clientId
• @return array
• @throws \Exception

Returns client data

• @return array
• @throws \Exception

Returns list of bookings filtered by given params

• @return Array

• @return array

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

• @param integer $id booking id
• @return Array

Get online meeting link for booking

• @param integer $id booking id
• @return string

Return busy time by unit id by GoogleCalendar plugin if enabled.
Please note that this method may return not actual data because data synchronization between server and

Google Calendar may take some time and synchronized data are cached for 15 minutes.

• @param string $startDateTime
• @param string $endDateTime
• @param string $type either 'unit_group' or 'event'. Default value is 'unit_group'.
• @return array

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains from and to properties with datetime string as value. This method only actual if

[Plugins#Google calendar sync plugin|Google calendar sync plugin] enabled. If plugin not enabled an empty list will
be returned. You should call [[#isPluginActivated|isPluginActivated('google_calendar_export')]] to
check status of the plugin. Each object of result contains from and to properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google Calendar may take some time and synchronized data are cached for 15 minutes.


Example:

[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]


• @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
• @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in this parameter. In this case method will use time value '23:59:59'.
• @param int $unitId
• @return Array

Returns configured unit ids, allowed to sync busy time

• @return Array

Returns time intervals not available for bookings because of configuration of [[Plugins#Limit bookings|Limit bookings]]
plugin for period of time. Returns empty array if plugin not available.

• @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
• @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'
• @param int $eventId
• @return Array

Return working durations

• @param string $dateStart
• @param string $dateEnd
• @param int $unitGroupId
• @return Array

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.

Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

• @param string $dateStart
• @param string $dateEnd
• @param int $unitGroupId
• @return Array

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either

by unit or by service. Set $dateStart and $dateEnd to null to get data for current week.

Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

• @param string $dateStart a date string in format 'Y-m-d'.
• @param string $dateEnd a date string in format 'Y-m-d'
• @param int $unitGroupId
• @param int $serviceId
• @return Array

Return workday info (date_start and date_end)

• @param string $dateStart
• @param string $dateEnd
• @param int $unitGroupId
• @return array

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

• @param Integer $id
• @return Boolean

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in $bookingIds list is used for

information in notifications.

• @param Integer $id identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
• @param Array $bookingIds ids of bookings included to batch.
• @return bool

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be

require_confirm = true. $startDate and $startTime specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
[[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that $endDate and $endTime should be
later in time than $startDate and $startTime. If your clients located in different time
zone you should specify 'client_time_offset' value in $clientData object as difference
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 $clientTimeOffset will be 60 minutes.
You can get information about company's
time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To create batch booking you can
specify either count more then 1 or valid batchId (only one parameter can be
specified). You should specify an $additionalFields parameter if service requires some additional
fields (see [[Plugins#Additional fields|Additional fields plugin]]).

To create a booking with promo code you should pass it as additional field. For example: {"promocode": "some code"}

If [[Plugins#Unit location|Unit location]] enabled you need to pass locations ID parameter as additional field
location_id. For example: {"location_id": "1"}. Use [[#isPluginActivated|isPluginActivated('location')]]
to check if plugin active and [[#getLocationsList|getLocationsList()]] method to get list of
available locations.

See [[#book response|example]] of book API method response.

• @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
• @param Integer $eventId
• @param Integer $unitId
• @param Integer $clientId
• @param string $startDate a date string in format 'Y-m-d'
• @param string $startTime a time string in format 'H:i:s'
• @param string $endDate a date string in format 'Y-m-d'
• @param string $endTime a time string in format 'H:i:s'
• @param Integer $clientTimeOffset
• @param array|Object $additional additional params and fields.
• @param Integer $count bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
• @param Integer $batchId add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
• @param Array $recurringData make booking recurrent. (optional)
• @return Object

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

• @param Integer $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
• @param Integer $eventId
• @param Integer $unitId
• @param Integer $clientId
• @param String $startDate in Y-m-d format
• @param String $startTime in H:i:s format
• @param String $endDate in Y-m-d format
• @param String $endTime in H:i:s format
• @param Integer $clientTimeOffset
• @param array|Object $additional additional params and fields.
• @return Object

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id.

email, phone number or both of them can be mandatory fields. You should call
getCompanyParam('require_fields') method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong


Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

• @param Object $clientData
• @param Boolean $sendEmail
• @return Integer

Edits client's record. See [[#addClient|addClient]] method description for list of available fields.
Method returns an id of client's record.

• @param Integer $clientId
• @param Object $clientData
• @return Integer

Change client password and send password email changing

• @param Integer $clientId
• @param String $password
• @param Boolean $sendEmail

Resets client password and send them emails

• @param Array $clientIds

Sends remind email for client

• @param String $email
• @return Boolean

Returns list of clients associated with company. You can use either phone number, email address or name as value
for $searchString. Pass an empty string for $searchString and null for $limit

parameters to get all records. See [[#addClient|addClient]] API method for list of available fields
of client data object.

• @param String $searchString
• @param Integer $limit
• @return Array

Returns list of available statuses or an empty list if [[Plugins#Status|Status plugin]] not enabled.

• @return Array

Returns status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

• @param Integer $bookingId
• @return Array

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Plugins#Status|Status plugin]] not enabled.

• @param Integer $bookingId
• @param Integer $statusId
• @return Boolean

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

• @see http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription
• @param Integer $eventId
• @return Array

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

• @param String $dateStart
• @param String $dateEnd
• @return Array

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

• @return Array

Get list of dates for recurring booking

• @param Integer $eventId
• @param Integer $unitId
• @param String $date
• @param String $time
• @param array $recurringData
• @param String $endDateTime (optional)
• @param array $productIds
• @return array

Get list of all countries

• @return Array

Get list of all country states

• @return Array

Get list of feedbacks

• @param Boolean $approvedOnly
• @param Boolean $reviewsOnly
• @param Boolean $lastOnly
• @param Integer $limit
• @return Array

Returns latest actions

• @param Boolean $lastOnly
• @param Integer $limit
• @return Array

Returns a list of objects represented system warnings. Each warning contains warning_type and warning_text
properties. warning_text property contains localized message. warning_type can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

• @param Boolean $lastObly Default value is '''false'''.
• @return Array

Mark notifications as readed

• @param String $type

Returns last update datetime

• @param String $type
• @return String

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. "type" field can be either

"create", "cancel" or "nopayment_cancel". If "user_id" not specified then bookings where created or
cancelled by admin or employee. Data with type "nopayment_cancel" represents bookings cancelled
automatically by system.

Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

• @param String $dateStart a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
• @param String $dateEnd a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.
• @return Array

Sets approve booking status to 'approved' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
list of approved booking IDs. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.

• @param Integer $id
• @return Array

Sets approve booking status to 'canceled' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
true. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.

• @param Integer $id
• @return Boolean

Returns count of bookings pending approval if [[Plugins#Approve booking|Approve booking]] plugin enabled. Returns
0 if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]] API method

call to check if plugin enabled.

• @return Integer

Returns list of objects with information about bookings pending approval if [[Plugins#Approve booking|Approve booking]]
plugin enabled. Returns empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.

• @return array

Returns a list of all plugins associated with company with status.

• @return Array

Returns booking comment

• @param Integer $id
• @return String

Set booking comment

• @param Integer $id
• @param String $comment
• @return Integer

Returns all information about current tariff (subscription). For example:

{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

• @return Array

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

• @param String $groupBy either 'day', 'week' or 'month'
• @return Array

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

• @param String $groupBy either 'day', 'week' or 'month'
• @return Array

Returns statistics about page visits if plugin [[Plugins#Visitor Counter|Visitor Counter plugin]] enabled. Returns
an empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('counter')]] API method

call to check if plugin enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

• @param String $groupBy
• @return Array

Returns social counters value for your domain

• @param String $provider
• @return Integer

Returns company's currency as three chars code (ISO 4217).

• @return String

Returns list of all comments for given client

• @param Integer $clientId
• @param Integer $shedulerId
• @return Array

Returns current SOAP information by client id

• @param integer $clientId
• @return array

Returns SOAP history by client id

• @param integer $clientId
• @return array

Returns current SOAP (crypt) information by client id

• @param integer $clientId
• @return array

Returns SOAP (crypt) history by client id

• @param integer $clientId
• @return array

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on group property value. Most of API methods returns an error if user has low access

rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

group property can be one of the values:

* shop_user - "Senior Employee" access role
* station_user - "Junior Employee" access role
* admin - "Administrator" access role
* viewer - "Viewer" access role
* reseller_company_admin - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}


• @return Array

Returns company categories list if [[Plugins#Service categories|Service categories plugin]] is activated. Returns
an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('event_category')]]

API method to check if plugin activated.

• @param Boolean $isPublic
• @return Array

Returns available locations for company if plugin [[Plugins#Unit location|Unit location plugin]] is activated. Return
an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('location')]]

API method to check if plugin activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

• @param Boolean $isPublic Optional. Default value is '''false'''.
• @param bool $asArray Optional. Default value is '''false'''.
• @return Array

Returns membership's data object.

• @param int $membershipId
• @return Array

Returns purchased membership list

• @param Integer $clientId
• @return Array

Set work day schedule for company|service|provider for week_day|date

Example:

{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}


index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company

• @param array $info
• @return boolean true on success

Delete special date if set

Example:

{
"unit_group_id":"",
"event_id":""
}

• @param string $date 'Y-m-d'
• @param array $params = null
• @return boolean true on success

Returns company special days and vacations

• @param Integer $year
• @return Object

Returns special days and vacations, defined for given service (event)

• @param Integer $year
• @param Integer $eventId
• @return Object

Get list of company vacations in format array(vacation_id => array())

• @return array

Get list of service vacations

• @param Integer $serviceId
• @return array

Get list of performer vacations

• @param Integer $performerId
• @return array

Get company vacation by id

• @param Integer $vacationId
• @return array vacation table row data

Get service vacation by id

• @param Integer $vacationId
• @param Integer $serviceId
• @return array vacation table row data

Get service vacation by id

• @param Integer $vacationId
• @param Integer $performerId
• @return array vacation table row data

Save company vacation data
(create or update table depending on 'id' param existing in $data)

• @param array $data
• @return Integer id of saved vacation

Save company vacation data
(create or update table depending on 'id' param existing in $data)

• @param array $data
• @param Integer $serviceId
• @return Integer id of saved vacation

Save company vacation data
(create or update table depending on 'id' param existing in $data)

• @param array $data
• @param Integer $performerId
• @return Integer id of saved vacation

Delete company vacation with all it's bindings
(including created special days in work_day_special table)

• @param Integer $vacationId

Delete service vacation with all it's bindings
(including created special days in work_day_special table)

• @param Integer $vacationId
• @param Integer $serviceId

Delete performer vacation with all it's bindings
(including created special days in work_day_special table)

• @param Integer $vacationId
• @param Integer $unigGroupId

Returns company's classes list. If $asArray is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of

class's details object.

• @param Boolean $isVisibleOnly
• @param Boolean $asArray
• @return Array

Returns product list with filter.
At this time filter can accept only service_id parameter

• @param object $filter
• @return array

Get paginated data for Booking report

The following filters can be provided in request param:
Date date_from, date_to, created_date_from, created_date_to
Integer unit_group_id, client_id
String code, promo_code
String booking_type = 'approved' | 'not_approved_yet' | 'cancelled_by_admin' | 'cancelled_by_client' | 'non_cancelled' | 'cancelled' | 'all'

Order can be one of the following values: record_date, date_start, date_start_asc

Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @todo : implement order by end_date, record_date
• @param Api
• @return array

Get paginated data for Client report

The following filters can be provided in request param:
Date date_from, date_to
Integer event_id, unit_group_id, client_id
String client_search (search string, can contains client name, address, phone)
String service_using_type = 'used_in_period' | 'not_used_in_period' | 'not_used_in_period_but_used_before'

No custom ordering implemented yet

Group data = 'client' | 'client_email_phone' | 'client_email' | 'client_phone'


Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @todo : implement order by send_date, sms_count
• @param Api
• @return array

Get paginated data for SMS report

The following filters can be provided in request param:
Date date_from, date_to
Integer unit_group_id, client_id
String phone, message

No custom ordering implemented yet (always ordered by client name)

Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @todo : implement order by date
• @param Api
• @return array

gets differend sms providers(transport) used by system

Get paginated data for email report

Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @param Api
• @return array

Get paginated data for Pos report

Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @param Api
• @return array
• @throws Api_Entity_Exception_AccessDenied
• @throws Api_Service_Exception

Get paginated data for Feedback report

The following filters can be provided in request param:
Date date_from, date_to
Integer from 1 to 5 rate_from, rate_to
String name, subject, message

Report can be ordered by one of the following fields:
date, rate, name, message, subject, answer

Return data in the following format:
array(
'data' => $data,
'metadata' => array(
'items_count'
'pages_count'
'page'
'on_page'
)
or Api_Service_Exception in error case

• @param Api
• @return array

Get detailed list of promotions (new)

• @param bool $isVisibleOnly
• @param bool $asArray
• @param string $promotionType = 'discount' / 'gift_card' / null
• @return array

Get all list of promotion instances

• @param string $promotionType = 'gift_card' | 'discount'
• @param bool $asArray
• @return array

Return promotion detailed info

• @param integer $id
• @return array

Get static page list

• @return array

Confirms invoice by id

• @param integer $id
• @param string $paymentSystem
• @return array
• @throws Api_Entity_Exception

Applies promo code to order (Coupons & Gift Cards custom feature)

• @param integer $id
• @param string $code
• @return array
• @throws Api_Entity_Exception

Applies tip to order (Tips custom feature)
You can apply tip by percent or by amount

• @param integer $id
• @param integer $percent
• @param integer $amount
• @return array
• @throws Api_Entity_Exception

• @param string $startDate
• @param string $endDate
• @return array

Returns company information for the current company.

• @return Array

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not

allowed. See [[#Company_params|list of available keys]].

• @param String $key
• @return mixed

Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
it will return '''false''' as result. A different set of keys available for public API and for company

administration API. See [[#Company_params|list of available keys]].

• @param Array $keys
• @return Array

Returns cancellation policy rules.
If cancellation policy custom feature is not activated, method returns null.

• @return Array

Returns company timeline type

• @return String

Returns company's events list. If $asArray is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of

event's details object.

• @param Boolean $isVisibleOnly
• @param Boolean $asArray
• @param integer $handleClasses 1 - classes only, -1 without classes, null - skip classes check
• @param string $searchString part of name (used for comboboxes)
• @return Array

Returns list of service performers. If $asArray is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property

of event's details object.

• @param Boolean $isVisibleOnly
• @param Boolean $asArray
• @param integer $handleClasses 1 - classes only, -1 without classes, null - skip classes check
• @param string $searchString part of name (used for comboboxes)
• @return Array

Returns end datetime if booking is available, else return false

• @param String $startDateTime a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
• @param Integer $eventId
• @param Integer $unitId
• @param array $productIds
• @return String

Returns company work schedule as array
Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}

• @param Integer $year
• @param Integer $month
• @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
• @return Object

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type reserved_time and type

not_worked_time. reserved_time type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.

If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call
[[#isPluginActivated|isPluginActivated('google_calendar_export')]] API method to check if Google
calendar sync plugin activated.


Example:

  {

    "2016-02-05": [

      {

        "dd": [], // time slots from Google calendar

        "events": [ // reserved time slots

          { "from": "16:00", "to": "16:30" },

          { "from": "16:30", "to": "17:00" },

          ... ],

        "type": "reserved_time",

      },

      {

        "events": [

          { "from": "09:00", "to": "09:30" },

          { "from": "09:30", "to": "10:00" },

          ... ],

        "type": "not_worked_time"

     }],

     ...

  }

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Integer $unitId
• @param Integer $count
• @return Object

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from

service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:

  {'2014-05-14' : [

    {'from': '09:00:00', 'to': '13:00:00'},

    {'from': '14:00:00', 'to': '19:00:00'}

  ] }

• @param String $from
• @param String $to
• @param Integer $unitId (optional)
• @param Integer $eventId (optional)
• @param Integer $count (optional)
• @param array $productIds (optional)
• @return array

Returns first working date for unit

• @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
• @return String

Returns available start time, taking into account breaktimes, start and end working time
Eg.: {'2014-05-14': ['09:00:00', ...], ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @param int $bookingId
• @param array $productIds
• @return array

Returns available start time, taking into account breaktimes, start and end working time.
The difference between getStartTimeMatrix and getCartesianStartTimeMatrix is that getCartesianStartTimeMatrix

provides time slots for each individual provider.
Eg.: {"provider_id": 1, "service_id": 1, "timeslots": {"2014-05-14": ['09:00:00', ...], ...}, ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.

• @param String $from
• @param String $to
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @param int $bookingId
• @param array $productIds
• @return array

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

• @param String $dateFrom
• @param String $dateTo
• @param Integer $eventId
• @param Mixed $unitId can be Integer or Array of Integers
• @param Integer $count
• @return Object

Returns available time intervals for all servics for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

• @param String $dateFrom
• @param String $dateTo
• @param Mixed $eventId can be Integer or Array of Integers
• @param Integer $unitId
• @param Integer $count
• @return Object

Returns not available time
Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}

• @param String $dateFrom
• @param String $dateTo
• @param Integer $eventId
• @param Integer|Array $unitId
• @param Integer $count
• @param int $bookingId
• @return array

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.
Eg.: [1, 2, 3]

• @param Integer $eventId
• @param String $dateTime a date and time string in format 'Y-m-d H:i:s'
• @param int $count
• @param int $unitId
• @param array $productIds
• @return array
• @throws Exception

Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
null if plugin not enabled.

Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

• @return Object

Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
activated. Returns empty array otherwise. Call [[#isPluginActivated|isPluginActivated('event_field')]]

API method to check if 'event_field' plugin activated.

• @param Integer $eventId
• @return Array

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]].

• @return Integer

Return plugin status true if status active, else false. $pluginName parameter is a plugin identifier.
See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].

• @param String $pluginName
• @return Boolean

Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].

• @param Array $pluginNames
• @return Array

Creates new booking batch record. Returns newly created batch id. You can use this id in [[#book|book]]
API method.

• @return Integer

Returns country phone code list

• @return Array

Returns an object with detailed information about promotion by promotion code. You can get promotion code
using [[Catalogue#getPromotionList|getPromotionList]] API method. If promotion record with specified

code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
not enabled then method returns an error with code -32001 (Plugin is not activated). Use
[[#isPluginActivated|isPluginActivated('promo')]] API method call to check if plugin enabled.


See [[#getPromotionList response|example]] of getPromotionList API method response. Please note that
response contains a list of services for wich promotion discount can be applied (service_ids key).

• @param String
• @return Array

Returns company timezone offset and company timezone

• @return array

Returns companies list

$filter filter params. Object that contains following params

'search_string': String,

'service_name': String,

'company_name': String,

'company_address': String,

'category_id': Integer,

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String,

'nearby': {

    'radius': Integer,

    'center': {

       'lat': Number,

       'lng': NUmber

    }

}

• @param Object $filter filter object
• @param Integer $from from position
• @param Integer $limit rows limit
• @return array

Returns active promotion list

$filter filter params. Object that contains following params

'search_string': String,

'service_name': String,

'company_name': String,

'company_address': String,

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String,

'nearby': {

    'radius': Integer,

    'center': {

       'lat': Number,

       'lng': NUmber

    }

}

• @param Object $filter filter object
• @param Integer $from from position
• @param Integer $limit rows limit
• @return array

Returns active promotion list

• @param array
• @return array

Returns total companies count with specified filter

$filter filter params. Object that contains following params

'search_string': String,

'service_name': String,

'company_name': String,

'company_address': String,

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String,

'nearby': {

    'radius': Integer,

    'center': {

       'lat': Number,

       'lng': NUmber

    }

}

• @param Object $filter filter object
• @return array

Returns total active promotions count with specified filter

$filter filter params. Object that contains following params

'search_string': String,

'service_name': String,

'company_name': String,

'company_address': String,

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String,

'nearby': {

    'radius': Integer,

    'center': {

       'lat': Number,

       'lng': NUmber

    }

}

• @param Object $filter filter object
• @return array

Returns country list as Array order by company count in country

• @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]

Returns city list as Array order by company count in city

• @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]

Returns a list of objects with just two properties each: id and country. An id
is a two character string with ISO 3166-1 country code.

• @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]

Returns a list of objects. If $country parametr specified then method returns only cities of this
country. Each object in list has 4 properties:

* id - number. A unique identificator of city. You should use it as filter options in methods getCompanyList.
* city - string. A city name.
* count_id - string. Two chars ISO 3166-1 country code.
* count - number.

Example:

  [{  

    "cnt" : 7,

    "country_id"" : "GB",

    "id" : 4607,

    "name" : "Uxbridge"

    },

    ...]

• @param String $country Optional. A two character ISO 3166-1 country code.
• @param bool $withActiveCompany
• @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]

Returns tags list

$filter filter params. Object that contains following params

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String

• @param Object $filter filter object
• @return Array [{'id': ..., 'tag': ...}, ....]

Returns company information by company login

• @param String $login
• @return Object

Returns promotion information by id

• @param Integer $id
• @param Integer $feedbackFrom = 0
• @param Integer $feedbackCount = 100
• @return Object

Returns related promotions by given promotion id

• @param Integer $id
• @param Integer $count = 10
• @return Array

Returns a list of company's review objects.

[{

  "company_id" : 86409,

  "domain" : "simplybook.me",

  "feedback_datetime" : "2015-10-27 13:06:57",

  "feedback_id" : 4623,

  "feedback_link" : "",

  "id" : 17384,

  "image" : "http://graph.facebook.com/1020443689023222/picture",

  "link" : "https://www.facebook.com/app_scoped_user_id/1020443689023222/",

  "message" : "Brilliant!",

  "name" : "Simply Booker",

  "provider" : "",

  "provider_data" : "...", // String. An object encoded with PHP's serialize method.

  "rate" : 5, // 0 to 5 rate

  "status" : "approved", // 'new' or 'approved'

  "subject" : "Good",

  "with_comment" : 1

},

...]

• @see http://php.net/serialize
• @param String $login
• @param Integer $count
• @param Integer $offset
• @return Object

Returns company's reviews count

• @param String $login
• @return Integer

Returns a company's review objects.

• @param String $login
• @param Integer $reviewId
• @return Object

Returns a list of company's review likes.

• @param String $clientId
• @param String $clientProvider
• @return Object

Adds company review

• @param String $login
• @param String $subject
• @param String $message
• @param Integer $rate
• @param String $provider
• @param String $accessToken
• @return Boolean

Add promotion review

• @param Integer $promotionId
• @param String $subject
• @param String $message
• @param Integer $rate
• @param String $provider
• @param String $accessToken
• @return Boolean

Returns promotion reviews list

• @param Integer $promotionId
• @return Object

Returns list of promotions ordered by date DESC

• @param Integer $count
• @return Array

Returns list of feedbacs ordered by date DESC

• @param Integer $count
• @return Array

Returns list of companies ordered by date DESC

• @param Integer $count
• @return Array

Returns all categories as list of objects. Each category can have a subcategories. Each subcategory contains parent
category id in company_category_id field. For top level categories this field is null and

is_header field is true.


Example:

  [{

     "company_category_id": null,

     "id": "1",

     "image": "/common/images/category_icons/car.png",

     "is_active": "1",

     "is_header": "1",

     "name": "Cars",

   },

   {

     "company_category_id": "1",

     "id" = 11;

     "image": null,

     "is_active": "1",

     "is_header": "0",

     "name": "Car wash",

   },

  ...]

• @return Array

Get list of ALL simplybook feedbacks

• @return Array

Returns a list of promotions objects associated with specified company. If company doesn't have any promotions or
[[Plugins#Simply_Smart_Promotions|Simply Smart Promotions plugin]] not active for this company method returns an

empty list.

• @param String $promotionCompanyLogin
• @param Integer $count Optional. Maximum amount of objects in response. Default value is 100.
• @return Array

Returns user location info

• @param String $ip optional
• @return Object

Returns suggestions for autocompeter

$filter filter params. Object that contains following params

'search_string': String,

'service_name': String,

'company_name': String,

'company_address': String,

'category_id': Integer,

'tag_ids': [Integer, Integer, ...],

'tags': String,

'country_id': String,

'city_id': String,

'nearby': {

    'radius': Integer,

    'center': {

       'lat': Number,

       'lng': NUmber

    }

}

• @param Object $filter filter object
• @param Boolean
• @return array

Anonymize client feedbacks and feedback likes
according to GDPR client's right to be forgotten

• @param array $gdprDataSerialized

Delete promotion_feedbak and promotion_feedback_response data
according to GDPR client's right to be forgotten

• @param array $gdprDataSerialized
• @return mixed
• @throws Gdpr_Exception