Company administration service methods: Difference between revisions

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Plugins' link and select [[Plugins#API|API plugin]] 'Settings'.  

will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.

 

Also email, phone number or both of them can be mandatory fields. You should call

fields (see [[Plugins#Additional fields|Additional fields plugin]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

 

<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>

 

See [[#book response|example]] of <code>book</code> API method response.

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for

"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or

cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled

 

  3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.

=== getBookingComment ===

 

 

Returns String.

Returns booking comment

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

* '''$id''' integer booking id

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

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'

* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'

* '''$eventId''' integer

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.

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

* '''$dateStart''' string a date string in format 'Y-m-d'.

 

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

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

* '''$groupBy''' String either 'day', 'week' or 'month'

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

 

=== getBookings ===

<code>getBookings($params)</code>

* '''$params'''

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

 

 

----

 

=== getBookingsZapier ===

 

<code>getBookingsZapier()</code>

Returns list of bookings filtered by given params

=== getClient ===

<code>getClient($clientId)</code>

* '''$clientId'''

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields

of client data object.

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

* '''$clientId''' Integer

Returns list of all comments for given client

 

 

 

<code>getClientList($searchString, $limit)</code>

Parameters:

 

 

 

Returns list of clients associated with company. You can use either phone number, email address or name as value

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

Returns String.

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

=== getCountryList ===

<code>getCountryList()</code>

Get list of all countries

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

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

    "rest" : 41, // number of days until subscription expiration

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

Returns current logged user info

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

* '''$approvedOnly''' Boolean

Get list of feedbacks

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

 

 

Returns Array.

 

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result

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

    ...

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

Returns Array.

Returns configured unit ids, allowed to sync busy time

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

* '''$type''' String  

Returns String.

Returns last update datetime

=== getPluginList ===

<code>getPluginList()</code>

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

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

 

 

Returns latest actions

=== getRecurringDatetimes ===

 

 

* '''$endDateTime''' String (optional)

Get list of dates for recurring booking

=== getRecurringSettings ===

 

 

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

 

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

* '''$groupBy''' String either 'day', 'week' or 'month'

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

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

* '''$provider''' String

Returns Integer.

=== getStatuses ===

<code>getStatuses()</code>

<code>getTopServices($dateStart, $dateEnd)</code>

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

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

* '''$dateStart''' string

Returns Array.

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

* '''$dateStart''' string

Return working durations

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

 

Returns Array.

 

an empty list if plugin not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method

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

 

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

* '''$lastOnly'''   

Returns warnings for admin

(sms limit, bookings limit, etc)

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime)</code>

* '''$startDateTime''' string

Return busy time by unit id by GoogleCalendar plugin if enabled.If cache is not expired will return from cache, else load from google and save to cache

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

* '''$dateStart''' string

* '''$dateEnd''' string

Example:

Please note that <code>classic</code> timeline type is deprecated and not supported anymore.