Company administration service methods
From SimplyBook.me
You can find full list of Company administration service API methods here.
Methods
getCompanyParam
getCompanyParam(key)
Params:
- key string
Returns string.
getCompanyParam API method returns configuration value for specified key. Method return invalid params error (code -32602) in case if specified key not allowed.
getPluginStatuses
getPluginStatuses(pluginNames)
Params:
- pluginNames an array of strings
Returns an associative array with strings as keys and booleans as values.
Returns an associative array (a JSON object) with values from pluginNames parameter as keys and boolean values for each plugin. See list of available plugin names.
isPluginActivated
isPluginActivated(pluginName)
Params:
- pluginName string
Returns boolean (1 or 0).
Return plugin status true if status active, else false. pluginName parameter is a plugin. See list of available plugin names.
Constants
Company params
Use these values to get configuration params for company with getCompanyParam API method.
Administration API inherits all keys allowed for public API and extends this list with keys:
- attach_ical
- auto_redirect
- auto_redirect_text
- blockchain_address
- blockchain_secret
- borgun_merchant_id
- borgun_payment_gateway_id
- borgun_secret_code
- changable_prefix_by_client
- client_batch_cancel_template
- client_batch_cancel_template_email
- client_batch_cancel_template_email_subject
- client_event_cancel_template
- client_event_cancel_template_email
- client_event_cancel_template_email_subject
- client_event_change_template
- client_event_change_template_email
- client_event_change_template_email_subject
- client_event_creation_template
- client_event_creation_template_email
- client_event_creation_template_email_subject
- client_event_group_creation_template
- client_event_group_creation_template_email
- client_event_group_creation_template_email_subject
- client_event_multiple_creation_template
- client_event_multiple_creation_template_email
- client_event_multiple_creation_template_email_subject
- client_group_notification_template
- client_group_notification_template_email
- client_group_notification_template_email_subject
- client_multiple_notification_template
- client_multiple_notification_template_email
- client_multiple_notification_template_email_subject
- client_notification_template
- client_notification_template_email
- client_notification_template_email_subject
- client_notification_time
- client_recurring_event_creation_template
- client_recurring_event_creation_template_email
- client_recurring_event_creation_template_email_subject
- common_limit_booking
- company_currency
- company_ga_tracking_id
- default_phone
- disconnect_on_timeout
- dwolla_application_key
- dwolla_id
- dwolla_secret_key
- email_event_list
- email_events_list_template
- email_group_events_list_template
- event_list_style
- feed_back_interval
- feedback_invite_template_email
- feedback_invite_template_email_subject
- google_conversion_color
- google_conversion_currency
- google_conversion_format
- google_conversion_id
- google_conversion_label
- google_conversion_language
- google_conversion_value
- hide_working_hours_block
- include_cancel_link
- kortais_merchant
- kortais_secret_code
- kortais_terminal
- layout_background
- layout_background_repeat
- liqpay_merchant_id
- liqpay_merchant_pass
- max_group_bookings
- mobile_site_link
- mobile_site_link_title
- no_show_period
- on_success_button_link
- on_success_button_text
- paypal_account
- recap_interval
- recap_send_after_time
- recap_send_canceled_bookings
- recap_send_new_bookings
- recap_send_upcomming_bookings
- send_cancel_to_client
- send_cancel_to_client_email
- send_cancel_to_unit
- send_cancel_to_unit_email
- send_contact_widget_email_notification
- send_contact_widget_sms_notification
- send_notify_to_client
- send_notify_to_client_email
- send_notify_to_unit
- send_notify_to_unit_email
- send_onchange_to_client
- send_onchange_to_client_email
- send_onchange_to_unit
- send_onchange_to_unit_email
- send_oncreate_to_client
- send_oncreate_to_client_email
- send_oncreate_to_unit
- send_oncreate_to_unit_email
- send_sms_if_push_enabled
- site_link
- site_link_title
- skip_limits_for_admin
- skip_show_mobile_app_ads
- skip_show_on_success_button
- skrill_account
- skrill_secret
- sms_event_list
- sms_events_list_template
- sms_group_events_list_template
- unit_batch_cancel_template
- unit_batch_cancel_template_email
- unit_batch_cancel_template_email_subject
- unit_event_cancel_template
- unit_event_cancel_template_email
- unit_event_cancel_template_email_subject
- unit_event_change_template
- unit_event_change_template_email
- unit_event_change_template_email_subject
- unit_event_creation_template
- unit_event_creation_template_email
- unit_event_creation_template_email_subject
- unit_event_group_creation_template
- unit_event_group_creation_template_email
- unit_event_group_creation_template_email_subject
- unit_group_notification_template
- unit_group_notification_template_email
- unit_group_notification_template_email_subject
- unit_notification_template
- unit_notification_template_email
- unit_notification_template_email_subject
- unit_notification_time
- unit_recurring_event_creation_template
- unit_recurring_event_creation_template_email
- unit_recurring_event_creation_template_email_subject
- use_common_client_db
- user_confirmation
- user_license_text
- user_public_layout
- user_public_theme
- waiting_video
- zooz_app_id
- zooz_app_key
