Company public service methods: Difference between revisions

             "name": "Часовая фотосесcия",

             "description": "<p>Если Вы хотите попробовать себя в роли модели, но не определились с образом. <br /> 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске</p>",

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

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#getToken|getToken]]</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 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.  

<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters

can get information about company's time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To

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.

</code>. You can get <code>$bookingHash</code> value as result of <code>[[#book|book]]</code> API method call. Method

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>

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>

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee Selector Custom Feature]] configuration. Returns

value as result of <code>[[#book|book]]</code> API method call. Method return an error with code -32080

value as result of <code>[[#book|book]]</code> API method call. Method return an error with code -32080

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns

an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>

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

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

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

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>

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

by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature]] is enabled then object with

<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if  Calendar Sync Custom Feature activated.

units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple Locations]] Custom Feature description for

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 true if [[Custom_Features#Accept_Payments|Accept Payments]] Custom Feature activated and event with specified id has

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_public_service_methods#Custom_Features.27_identifiers|list of available Custom Features' names]].

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

*: [[Custom_Features#Group_Bookings|Group Bookings Custom Feature]] configuration. 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 [[Need_to_change_interval_(timeframe)|here]]

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

Read more about [[Custom_Features#Cancellation_Policy|Cancellation Policy Custom Feature configuration]].

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

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

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

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