Company administration service methods: Difference between revisions

{{#seo:

|title=Company administration service methods - SimplyBook.me

}}

==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>

* <code>params</code> - An Array of objects to be passed as parameters to the defined method.

* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.

* <code>id</code> - The id of the request it is responding to.

Example

   }

</pre>

Example of request with error response:

   }

</pre>

All calls of public service methods should have additional HTTP header:

Returns Integer.

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

   }

----

----

=== book ===

Returns Object.

Creates new booking record. Returns an object with appointment information or throw exception if booking time not

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 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>{"promocode": "some code"}</code>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field

----

=== calculateEndTime ===

----

=== cancelBatch ===

----

=== cancelBooking ===

----

=== createBatch ===

----

=== deleteDeviceToken ===

----

=== editBook ===

----

=== editClient ===

----

=== filterAvailableUnits ===

----

=== getAdditionalFields ===

----

=== getAnyUnitData ===

----

=== getAvailableTimeIntervals ===

----

=== getAvailableUnits ===

----

=== getBookingCancellationsInfo ===

----

=== getBookingComment ===

----

=== getBookingDetails ===

----

=== getBookingLimitUnavailableTimeInterval ===

----

=== getBookingRevenue ===

----

=== getBookingStats ===

----

=== getBookings ===

----

=== getBookingsZapier ===

----

=== getCategoriesList ===

----

=== getClient ===

----

=== getClientComments ===

----

=== getClientList ===

----

=== getCompanyCurrency ===

----

=== getCompanyInfo ===

----

=== getCompanyParam ===

----

=== getCompanyParams ===

----

=== getCompanyTimezoneOffset ===

----

=== getCountryList ===

----

=== getCountryPhoneCodes ===

----

=== getCurrentTariffInfo ===

----

=== getCurrentUserDetails ===

----

=== getEventList ===

----

=== getFeedbacks ===

----

=== getFirstWorkingDay ===

----

=== getGoogleCalendarBusyTime ===

----

=== getGoogleCalendarBusyTimeAvailableUnits ===

----

=== getLastNotificationUpdate ===

----

=== getLocationsList ===

----

=== getPluginList ===

----

<!---=== getPluginPromoInfoByCode ===

response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).

--->

----

=== getPluginStatuses ===

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

----

=== getRecentActions ===

Returns latest actions

----

=== getRecurringDatetimes ===

Get list of dates for recurring booking

----

=== getRecurringSettings ===

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

----

=== getRegistrations ===

* for 'month' time period is last 12 months

----

=== getReservedTime ===

</pre>

----

=== getReservedTimeIntervals ===

Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

----

=== getSocialCounterStats ===

Returns social counters value for your domain

----

=== getStartTimeMatrix ===

more details.

----

=== getStatuses ===

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

----

=== getTimeframe ===

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

----

=== getTimelineType ===

Returns company calendar layout type

----

=== getTopPerformers ===

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

----

=== getTopServices ===

revenues value for each service.

----

=== getUnitList ===

of event's details object.

----

=== getUnitWorkdayInfo ===

Return workday info (date_start and date_end)

----

=== getUnitWorkingDurations ===

Return working durations

----

=== getVisitorStats ===

* for 'month' time period is last 12 months

----

=== getWarnings ===

* '''sms_limit''' – warning indicates low amount of SMS credits

* '''sheduler_limit''' – warning indicates low amount of available bookings

----

=== getWorkCalendar ===

Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

----

=== getWorkDaysInfo ===

range finishes on midnight.

----

=== getWorkDaysTimes ===

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

----

=== getWorkload ===

   ] }]

----

<code>isPluginActivated($pluginName)</code>

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

----

=== pluginApproveBookingApprove ===

API method call to check if Custom Feature enabled.

----

=== pluginApproveBookingCancel ===

API method call to check if Custom Feature enabled.

----

=== pluginApproveGetPendingBookings ===

API method call to check if Custom Feature enabled.

----

=== pluginApproveGetPendingBookingsCount ===

call to check if Custom Feature enabled.

----

=== setBookingComment ===

Set booking comment

----

=== getBookingStatus ===

Returns an object of status of given booking (if status plugin is enabled)

default status will be returned if bookingId does not exists

----

=== setStatus ===

=== updateNotification ===

Mark notifications as readed

----

=== setWorkDayInfo===

if unit_group_id and event_id not passed then it set data for company

</pre>

----

=== deleteSpecialDay===

}

</pre>

----

=== addServiceProvider===

}

</pre>

----

=== editServiceProvider===

}

</pre>

----

== Constants ==

* -32603 Internal error

* -3264 Client with given id not found

----

===Company params===

* user_public_theme

* waiting_video

=====Accept payments Custom Feature params=====

* liqpay_merchant_id

* liqpay_merchant_pass

=====Term & Conditions Custom Feature params=====

* user_license_text

*: Terms and conditions text. String.

----

===Custom Features' identifiers===

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

----

== Examples ==

     "promo": false

   }

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

-->

<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

----

====book response====

     "batch_hash":"357178bce290381bb7235080941ec143"

   }

====getCompanyInfo response====

* classes

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

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

----

<!--====getPluginPromoInfoByCode response====

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.

-->