SimplyBook.me

Company administration service methods: Difference between revisions

← Older edit
VisualWikitext
Marked this version for translation
No edit summary
 
Line 12: Line 12:


<translate>
<translate>
==General Information== <!--T:2-->
==General Information== <!--T:2-->


Line 57: Line 58:
         "1": {
         "1": {
             "id": "1",
             "id": "1",
             "name": "Часовая фотосесcия",
             "name": "Hourly photoshoot",
             "duration": "60",
             "duration": "60",
             "hide_duration": "0",
             "hide_duration": "0",
             "description": "<p>Если Вы хотите попробовать себя в роли модели, но не определились с образом. <br /> 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске</p>",
             "description": "<p>If you want to try yourself as a model but haven't decided on an image. <br /> 5-7 retouched and print-ready photos + the raw footage on a disc </p>",
             "picture": "a200edab10b669225e22d2b3803a38b5.jpg",
             "picture": "a200edab10b669225e22d2b3803a38b5.jpg",
             "is_public": "1",
             "is_public": "1",
Line 110: Line 111:


<!--T:12-->
<!--T:12-->
* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.
* <code>X-Token</code> an authentication token. See [[Company administration service methods#Authentication|authentication]] section.


===Endpoint=== <!--T:13-->
===Endpoint=== <!--T:13-->
Line 120: Line 121:


<!--T:16-->
<!--T:16-->
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 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.  
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 'Custom Features' link and select [[Custom Features#API|API Custom Feature]] 'Settings'.  


== Methods == <!--T:17-->
== Methods == <!--T:17-->
Line 237: Line 238:
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
<code>[[Company administration service methods#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
Line 244: Line 245:
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
client's time zone in seconds. 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 can get information about company's
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
time zone using <code>[[Company administration service methods#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 parameter can be
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>
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>


</translate>
</translate>
Line 253: Line 254:


<!--T:42-->
<!--T:42-->
If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
If [[Custom Features#Multiple Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
to check if Custom feature active and <code>[[Company administration service methods#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.
available locations.


<!--T:43-->
<!--T:43-->
See [[#book response|example]] of <code>book</code> API method response.
See [[Company administration service methods#book response|example]] of <code>book</code> API method response.


<!--T:44-->
<!--T:44-->
Line 309: Line 310:


<!--T:56-->
<!--T:56-->
* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$id''' Integer identifier of batch. See <code>[[Company administration service methods#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.
* '''$bookingIds''' Array ids of bookings included to batch.


Line 364: Line 365:


<!--T:70-->
<!--T:70-->
Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[Company administration service methods#book|book]]</code>
API method.
API method.


Line 408: Line 409:


<!--T:82-->
<!--T:82-->
* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$shedulerId''' Integer an id of booking to edit. See <code>[[Company administration service methods#book|book]]</code> or <code>[[Company administration service methods#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer  
* '''$eventId''' Integer  
* '''$unitId''' Integer  
* '''$unitId''' Integer  
Line 423: Line 424:


<!--T:84-->
<!--T:84-->
Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
Edit existing booking record. See [[Company administration service methods#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.
time zone handling and additional fields. Returns null if parameters not valid.


Line 450: Line 451:


<!--T:91-->
<!--T:91-->
Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.
Edits client's record. See <code>[[Company administration service methods#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.




Line 505: Line 506:


<!--T:105-->
<!--T:105-->
Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms 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>[[Company administration service methods#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.


Line 527: Line 528:


<!--T:110-->
<!--T:110-->
Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
Returns information about [[Custom Features#Any Employee Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
null if Custom Feature not enabled.Example:
   {
   {
Line 689: Line 690:


<!--T:145-->
<!--T:145-->
Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].
Returns detailed bookings object by booking id. See [[Company administration service methods#getBookingDetails response|response example]].




Line 716: Line 717:


<!--T:152-->
<!--T:152-->
Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Returns time intervals not available for bookings because of configuration of [[Custom Features#Limit Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.
Custom Feature for period of time. Returns empty array if Custom Feature not available.


Line 813: Line 814:
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''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.
* '''event_id''' an integer. Use it to  get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''is_confirmed''' 1 or 0. If [[Custom Features#Approve Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''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.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
Line 883: Line 884:


<!--T:186-->
<!--T:186-->
Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
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>
an error with code -32001 if Custom Feature is not activated. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.
API method to check if Custom Feature activated.


Line 910: Line 911:


<!--T:193-->
<!--T:193-->
Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
Returns client's data object. See <code>[[Company administration service methods#addClient|addClient]]</code> API method for list of available fields
of client data object.
of client data object.


Line 965: Line 966:
Returns list of clients associated with company. You can use either phone number, email address or name as value
Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
parameters to get all records. See <code>[[Company administration service methods#addClient|addClient]]</code> API method for list of available fields
of client data object.
of client data object.


Line 1,006: Line 1,007:


<!--T:217-->
<!--T:217-->
Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].
Returns an object with detailed information about company. See [[Company administration service methods#getCompanyInfo response|example of response]].




Line 1,033: Line 1,034:
Returns company config value for key. A different set of keys available for public API and for company
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
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]].
allowed. See [[Company administration service methods#Company params|list of available keys]].




Line 1,060: Line 1,061:
Returns company config values for keys. A different set of keys available for public API and for company
Returns company config values for keys. 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
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]].For non-existent and not-allowed params it will return false as result
allowed. See [[Company administration service methods#Company params|list of available keys]].For non-existent and not-allowed params it will return false as result




Line 1,313: Line 1,314:
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
be returned. You should call <code>[[Company administration service methods#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
datetime string as value. Please note that this method may return not actual data because data synchronization
Line 1,394: Line 1,395:


<!--T:308-->
<!--T:308-->
Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations 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>[[Company administration service methods#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.
API method to check if Custom Feature activated.


Line 1,447: Line 1,448:
<!--T:321-->
<!--T:321-->
Returns an object with detailed information about Rewards and referrals 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 code not found then method returns an empty array (an empty object). If [[Rewards_and_Referrals_custom_feature|Rewards and Referrals Custom Feature]]
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 [[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>[[Company administration service methods#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled. See [[Company administration service methods#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).
--->
--->
Line 1,474: Line 1,475:


<!--T:327-->
<!--T:327-->
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]].
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]].




Line 1,621: Line 1,622:
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
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]] enabled then object with
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]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.
<code>[[Company administration service methods#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.




Line 1,740: Line 1,741:
<!--T:379-->
<!--T:379-->
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#Multiple_Locations|Multiple locations]] 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.


Line 1,762: Line 1,763:


<!--T:383-->
<!--T:383-->
Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.
Returns list of available statuses or an empty list if [[Custom Features#Status|Status Custom feature]] not enabled.




Line 1,783: Line 1,784:


<!--T:387-->
<!--T:387-->
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 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]].




Line 1,964: Line 1,965:


<!--T:425-->
<!--T:425-->
Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
Returns statistics about page visits if Custom Feature [[Custom Features#Visitor Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
an empty list if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
call to check if Custom Feature 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
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
Line 2,158: Line 2,159:


<!--T:463-->
<!--T:463-->
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]].
Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom Features]] page for full Custom Features description. See [[Company administration service methods#Custom Features.27 identifiers|list of available plugin's names]].




Line 2,184: Line 2,185:


<!--T:469-->
<!--T:469-->
Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
Sets approve booking status to 'approved' if [[Custom Features#Approve Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.
API method call to check if Custom Feature enabled.


Line 2,212: Line 2,213:


<!--T:475-->
<!--T:475-->
Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
Sets approve booking status to 'canceled' if [[Custom Features#Approve Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
true. Returns false if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.
API method call to check if Custom Feature enabled.


Line 2,235: Line 2,236:


<!--T:479-->
<!--T:479-->
Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Returns list of objects with information about bookings pending approval if [[Custom Features#Approve Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.
API method call to check if Custom Feature enabled.


Line 2,258: Line 2,259:


<!--T:483-->
<!--T:483-->
Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
Returns count of bookings pending approval if [[Custom Features#Approve Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
0 if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.
call to check if Custom Feature enabled.


Line 2,340: Line 2,341:
<!--T:501-->
<!--T:501-->
Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
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 [[Custom_Features#Status|Status Custom feature]] not enabled.
bookings. This method does nothing if [[Custom Features#Status|Status Custom feature]] not enabled.




Line 2,608: Line 2,609:


<!--T:543-->
<!--T:543-->
Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.
Use these values to get configuration params for company with <code>[[Company administration service methods#getCompanyParam|getCompanyParam]]</code> API method.


=====General params===== <!--T:544-->
=====General params===== <!--T:544-->


<!--T:545-->
<!--T:545-->
Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:
Administration API inherits all [[Company public service methods#Company params|keys]] allowed for public API and extends this list with keys:


<!--T:546-->
<!--T:546-->
Line 2,757: Line 2,758:


<!--T:548-->
<!--T:548-->
Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].
Read more about [[Custom Features#Accept Payments|Accept Payments Custom Feature configuration]].


<!--T:549-->
<!--T:549-->
Line 2,798: Line 2,799:


<!--T:551-->
<!--T:551-->
Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].
Read more about [[Custom Features#Terms and Conditions|Terms and Conditions Custom Feature]].


<!--T:552-->
<!--T:552-->
Line 2,815: Line 2,816:


<!--T:554-->
<!--T:554-->
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.
Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[Company administration service methods#isPluginActivated|isPluginActivated]]</code> and <code>[[Company administration service methods#getPluginStatuses|getPluginStatuses]]</code> API methods.


<!--T:555-->
<!--T:555-->
Line 2,882: Line 2,883:


<!--T:556-->
<!--T:556-->
See [[Custom_Features|Custom Features]] page for description for each Custom Feature.
See [[Custom Features]] page for description for each Custom Feature.


</translate>
</translate>
Line 2,892: Line 2,893:


<!--T:559-->
<!--T:559-->
An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.
An example of data returned by [[Company administration service methods#getBookingDetails|getBookingDetails]] API method.


   <!--T:560-->
   <!--T:560-->
Line 2,968: Line 2,969:


<!--T:561-->
<!--T:561-->
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.
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.


<!--T:562-->
<!--T:562-->
Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.
Status field is present in response only if [[Custom Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.


<!--T:563-->
<!--T:563-->
Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments 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 free service.
Price field is present in response only if [[Custom Features#Accept Payments|Accept payments 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 free service.


<!--T:564-->
<!--T:564-->
<!--Promo field is present in response only if [[Rewards_and_Referrals_custom_feature|Rewards and Referrals Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains false if Custom Feature is enabled but booking was created without any promo codes.
<!--Promo field is present in response only if [[Rewards_and_Referrals_custom_feature|Rewards and Referrals Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains false if Custom Feature is enabled but booking was created without any promo codes.
-->
-->
<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.
<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.




Line 2,992: Line 2,993:


<!--T:566-->
<!--T:566-->
[[#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.
[[Company administration service methods#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.


   <!--T:567-->
   <!--T:567-->
Line 3,057: Line 3,058:


<!--T:569-->
<!--T:569-->
An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.
An example of data returned by [[Company administration service methods#getCompanyInfo|getCompanyInfo]] API method.


   <!--T:570-->
   <!--T:570-->
Line 3,106: Line 3,107:


<!--T:575-->
<!--T:575-->
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]].
For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[Company administration service methods#Company params|Company params section]].


</translate>
</translate>
Retrieved from "https://help.simplybook.me/index.php?title=Company_administration_service_methods"