Difference between revisions of "Company administration service methods"

Latest revision as of 08:50, 26 August 2022

General Information

SimplyBook.me API service build on 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 JSON. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

jsonrpc - a version of JSON-RPC protocol. Always "2.0"
method - A String with the name of the method to be invoked.
params - An Array of objects to be passed as parameters to the defined method.
id - 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.

result - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
error - A specified error code if there was an error invoking the method, otherwise null.
id - The id of the request it is responding to.

Example

  Request
  {
    "jsonrpc": "2.0",
    "method": "getEventList",
    "params":[],
    "id":1
  }
  
  Response
  {
    "result": {
        "1": {
            "id": "1",
            "name": "Часовая фотосесcия",
            "duration": "60",
            "hide_duration": "0",
            "description": "<p>Если Вы хотите попробовать себя в роли модели, но не определились с образом. <br /> 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске</p>",
            "picture": "a200edab10b669225e22d2b3803a38b5.jpg",
            "is_public": "1",
            "is_active": "1",
            "position": "0",
            "is_recurring": "0",
            "picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
            "price": "300.0000",
            "currency": "UAH",
            "categories": ["1"]
        },
        ...
    },
    "id": "1",
    "jsonrpc": "2.0"
  }

Example of request with error response:

  Request
  {
    "jsonrpc": "2.0",
    "method": "someNotExistingMethod",
    "params":[],
    "id":1
  }
  
  Response
  {
    "jsonrpc": "2.0",
    "id":1,
    "error": {
      "code": -32601,
      "message": "Method not found"
    }
  }

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

X-Token an authentication token. See authentication section.

Endpoint

Use URL https://user-api.simplybook.me/admin for all administration service API calls.

Authentication

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 getUserToken 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 API Custom Feature 'Settings'.

Methods

addClient

addClient($clientData)

Parameters:

$clientData Object

Returns Integer.

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip, country_id. If client record with specified data exists method will return an id of this record. Otherwise data 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 getCompanyParam('require_fields') method to check which fields are required.

Method returns an error:

-32061 Client name value is wrong
-32062 Client email value is wrong
-32063 Client phone value is wrong

Example:

 {
    name: "Frances T. Perez",
    phone: "+1502-810-4521",
    email: "FrancesTPerez@teleworm.us",
    address1: "3872 Earnhardt Drive",
    address2: "Louisville, KY 40219",
    city: Louisville,
    zip: 3872
 }

addDeviceToken

addDeviceToken($token, $device)

Parameters:

$token String a device token string
$device String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or changes in already created bookings. Use either 'apple' or 'android' for device parameter.

book

book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)

Parameters:

$eventId Integer
$unitId Integer
$clientId Integer
$startDate string a date string in format 'Y-m-d'
$startTime string a time string in format 'H:i:s'
$endDate string a date string in format 'Y-m-d'
$endTime string a time string in format 'H:i:s'
$clientTimeOffset Integer
$additional array|Object - additional params and fields.
$count Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
$batchId Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
$recurringData Array - make booking recurrent. (optional)

Returns Object.

Creates new booking record. Returns an object with appointment information or throw exception if booking time not available or any of required parameters missed. If appointment requires confirmation, in result object will be require_confirm = true. $startDate and $startTime specifies a date of booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see getTimeframe API method). $endDate and $endTime parameters should be calculated according to service duration. However you can specify different values to make appointment longer or shorter then service configuration. Note that $endDate and $endTime should be later in time than $startDate and $startTime. If your clients located in different time zone you should specify $clientTimeOffset parameter as difference between company's time zone and 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 $clientTimeOffset will be -3600 seconds. You can get information about company's time zone using getCompanyInfo API method. To create batch booking you can specify either count more then 1 or valid batchId (only one parameter can be specified). You should specify an $additionalFields parameter if service requires some intake forms (see Intake Forms Custom feature).To create a booking with promo code you should pass it as additional field. For example: {"promocode": "some code"}

If Multiple locations enabled you need to pass locations ID parameter as additional field location_id. For example: {"location_id": "1"}. Use isPluginActivated('location') to check if Custom feature active and getLocationsList() method to get list of available locations.

See example of book API method response.

calculateEndTime

calculateEndTime($startDateTime, $eventId, $unitId)

Parameters:

$startDateTime String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
$eventId Integer
$unitId Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

cancelBatch

cancelBatch($id, $bookingIds)

Parameters:

$id Integer identifier of batch. See createBatch API method.
$bookingIds Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if no booking with specified id were found. A booking with first id in $bookingIds list is used for information in notifications.

cancelBooking

cancelBooking($id)

Parameters:

$id Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if no booking with specified id were found.

createBatch

createBatch()

No arguments. Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in book API method.

deleteDeviceToken

deleteDeviceToken($token)

Parameters:

$token String - device token

Returns boolean.

Unsubscribe from push notifications service.

editBook

editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)

Parameters:

$shedulerId Integer an id of booking to edit. See book or getBookings API methods.
$eventId Integer
$unitId Integer
$clientId Integer
$startDate String - in Y-m-d format
$startTime String - in H:i:s format
$endDate String - in Y-m-d format
$endTime String - in H:i:s format
$clientTimeOffset Integer
$additional array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See book API method description for more details about date/time parameters, time zone handling and additional fields. Returns null if parameters not valid.

editClient

editClient($clientId, $clientData)

Parameters:

$clientId Integer
$clientData Object

Returns Integer.

Edits client's record. See addClient method description for list of available fields.Method returns an id of client's record.

filterAvailableUnits

filterAvailableUnits($eventId, $dateTime, $unitIds, $count)

Parameters:

$eventId Integer
$dateTime String a date and time string in format 'Y-m-d H:i:s'
$unitIds
$count Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature. Returns empty array if all units are not allowed. Eg.: [1, 2, 3]

getAdditionalFields

getAdditionalFields($eventId)

Parameters:

$eventId Integer

Returns Array.

Return intake forms for certain event if Intake Forms Custom Feature is activated. Returns empty array otherwise. Call isPluginActivated('event_field') API method to check if 'event_field' Custom Feature activated.

getAnyUnitData

getAnyUnitData()

No arguments. Returns Object|null.

Returns information about Any Employee selector Custom Feature configuration. Returns null if Custom Feature not enabled.Example:

 {
   "description" : "Select this option, if you want to find an available time with any of the employees",
   "hide_other_units" : 1, // 1 or 0
   "image" : null,
   "name" : "Any employee",
   "picture_path" : null,
   "random_selection" : 0 // 1 or 0
 }

getAvailableTimeIntervals

getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)

Parameters:

$dateFrom String
$dateTo String
$eventId Integer
$unitId Mixed can be Integer or Array of Integers
$count Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

getAvailableUnits

getAvailableUnits($eventId, $dateTime, $count)

Parameters:

$eventId Integer
$dateTime String a date and time string in format 'Y-m-d H:i:s'
$count Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: [1, 2, 3]

getBookingCancellationsInfo

getBookingCancellationsInfo($dateStart, $dateEnd)

Parameters:

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

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for each type of operation (created or cancelled booking) groped by clients. "type" field can be either "create", "cancel" or "nopayment_cancel". If "user_id" not specified then bookings where created or cancelled by admin or employee. Data with type "nopayment_cancel" represents bookings cancelled automatically by system.Example:

 3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
 [{
   "cnt" : 3,
   "firstname" : null,
   "lastname" : null,
   "login" : null,
   "type" : "create",
   "user_id"" : null
 }, {
   "cnt" : 2,
   "firstname" : null,
   "lastname" : null,
   "login" : null,
   "type" : "nopayment_cancel",
   "user_id"" : null
 }]

getBookingComment

getBookingComment($id)

Parameters:

$id Integer

Returns String.

Returns booking comment

getBookingDetails

getBookingDetails($id)

Parameters:

$id integer booking id

Returns Array.

Returns detailed bookings object by booking id. See response example.

getBookingLimitUnavailableTimeInterval

getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)

Parameters:

$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 Array.

Returns time intervals not available for bookings because of configuration of Limit bookings Custom Feature for period of time. Returns empty array if Custom Feature not available.

getBookingRevenue

getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)

Parameters:

$dateStart string a date string in format 'Y-m-d'.
$dateEnd string a date string in format 'Y-m-d'
$unitGroupId integer
$serviceId integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either by unit or by service. Set $dateStart and $dateEnd to null to get data for current week.Example:

 ['2015-11-12' : {
    3 : [
      11, // bookings count
      128.53 // revenue
 ]}

getBookingStats

getBookingStats($groupBy)

Parameters:

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

Returns Array.

Returns statistic about bookings count grouped 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

getBookings

getBookings($params)

Parameters:

$params

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* date_from a date of booking in string format 'Y-m-d'

time_from a time string in format 'H:i:s'
date_to a date string in format 'Y-m-d'
time_to a time string in format 'H:i:s'
created_date_from a date string in format 'Y-m-d'
created_date_to a date string in format 'Y-m-d'
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.
is_confirmed 1 or 0. If 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.
order string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
booking_type a string. Value of this field depends on Approve booking Custom Feature status.
If Custom Feature not active:
- all for all bookings (default value)
- cancelled alias to 'is_confirmed' equal to 0
- non_cancelled alias to 'is_confirmed' equal to 1
If Custom Feature active:
- all for all bookings (default value)
- cancelled returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
- non_cancelled returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
- cancelled_by_client returns bookings approved by admin but cancelled by client
- cancelled_by_admin returns bookings cancelled by admin
- non_approved_yet returns bookings with approve status 'new'
- approved returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:

 {
   "date_from":"2015-12-29",
   "date_to":"2015-12-29",
   "booking_type":"cancelled",
   "event_id":"5",
   "order":"start_date"
 }

getBookingsZapier

getBookingsZapier()

No arguments. Returns Array.

Returns list of bookings filtered by given params

getCategoriesList

getCategoriesList($isPublic)

Parameters:

$isPublic Boolean

Returns Array.

Returns company categories list if Service Categories Custom Feature is activated. Returns an error with code -32001 if Custom Feature is not activated. Use isPluginActivated('event_category') API method to check if Custom Feature activated.

getClient

getClient($clientId)

Parameters:

$clientId

Returns Array.

Returns client's data object. See addClient API method for list of available fields of client data object.

getClientComments

getClientComments($clientId, $shedulerId)

Parameters:

$clientId Integer
$shedulerId Integer

Returns Array.

Returns list of all comments for given client

getClientList

getClientList($searchString, $limit)

Parameters:

$searchString String
$limit Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value for $searchString. Pass an empty string for $searchString and null for $limit parameters to get all records. See addClient API method for list of available fields of client data object.

getCompanyCurrency

getCompanyCurrency()

No arguments. Returns String.

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

getCompanyInfo

getCompanyInfo()

No arguments. Returns Object.

Returns an object with detailed information about company. See example of response.

getCompanyParam

getCompanyParam($key)

Parameters:

$key String

Returns mixed.

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 allowed. See list of available keys.

getCompanyParams

getCompanyParams($keys)

Parameters:

$keys Array

Returns Array.

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 allowed. See list of available keys.For non-existent and not-allowed params it will return false as result

getCompanyTimezoneOffset

getCompanyTimezoneOffset()

No arguments. Returns array.

Returns company timezone offset and company timezone

getCountryList

getCountryList()

No arguments. Returns Array.

Get list of all countries

getCountryPhoneCodes

getCountryPhoneCodes()

No arguments. Returns Array.

Returns country phone code list

getCurrentTariffInfo

getCurrentTariffInfo()

No arguments. Returns Array.

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

   "name" : "gold",
   "expire_date" : "2016-02-11 12:32:00",
   "rest" : 41, // number of days until subscription expiration
   "color" : "#fcb322"
 }

getCurrentUserDetails

getCurrentUserDetails()

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some access rights based on group property value. Most of API methods returns an error if user has low access rights but not all. There are 4 roles:

Administrator - have full access to the system
Senior Employee - have access to calendar, services and providers, and can modify bookings related with user
Junior Employee - can access caledar (but only to own bookings), services associated with user
Viewer - have only access to calendar and services in read only mode

group property can be one of the values:

shop_user - "Senior Employee" access role
station_user - "Junior Employee" access role
admin - "Administrator" access role
viewer - "Viewer" access role
reseller_company_admin - reserved

Example:

 {
   "id": 1,
   "login": admin,
   "email": "admin@mycoolcompany.com";
   "firstname": "Michail",
   "lastname": " ",
   "phone": "",
   "group": "admin",
   "is_blocked": 0,
   "last_access_time": "2016-06-06 17:55:51",
   "unit_group_id": null
 }

getEventList

getEventList($isVisibleOnly, $asArray)

Parameters:

$isVisibleOnly Boolean
$asArray Boolean

Returns Array.

Returns company's events list. If $asArray is false then method returns a map with event id as key and details object as value. If parameter set to true then method returns a list sorted by 'position' property of event's details object.

getFeedbacks

getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)

Parameters:

$approvedOnly Boolean
$reviewsOnly Boolean
$lastOnly Boolean
$limit Integer

Returns Array.

Get list of feedbacks

getFirstWorkingDay

getFirstWorkingDay($unitId)

Parameters:

$unitId Integer

Returns String.

Returns first working date for unit

getGoogleCalendarBusyTime

getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)

Parameters:

$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'. You can date string avoiding time in

this parameter. In this case method will use time value '23:59:59'.

$unitId integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result contains from and to 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 be returned. You should call isPluginActivated('google_calendar_export') to check status of the Custom Feature. Each object of result contains from and to properties with datetime string as value. 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.Example:

 [
  {"from" : "2016-02-16 13:30:00",
   "to" : "2016-02-16 16:00:00"},
   ...
 ]

getGoogleCalendarBusyTimeAvailableUnits

getGoogleCalendarBusyTimeAvailableUnits()

No arguments. Returns Array.

Returns configured unit ids, allowed to sync busy time

getLastNotificationUpdate

getLastNotificationUpdate($type)

Parameters:

$type String

Returns String.

Returns last update datetime

getLocationsList

getLocationsList($isPublic, $asArray)

Parameters:

$isPublic Boolean Optional. Default value is false.
$asArray boolean Optional. Default value is false.

Returns Array.

Returns available locations for company if Custom Feature Multiple locations Custom Feature is activated. Return an error with code -32001 if Custom Feature is not activated. Use isPluginActivated('location') API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If isPublic flag is true then method returns only public locations. If asArray flag is true method returns list of objects. Otherwise method returns map of objects with object id as key. You can omit both parameters.

getPluginList

getPluginList()

No arguments. Returns Array.

Returns a list of all Custom Features associated with company with status.

getPluginStatuses

getPluginStatuses($pluginNames)

Parameters:

$pluginNames Array

Returns Array.

Return Custom Feature status true if status active, else false. See list of available plugin's names.

getRecentActions

getRecentActions($lastOnly, $limit)

Parameters:

$lastOnly Boolean
$limit Integer

Returns Array.

Returns latest actions

getRecurringDatetimes

getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)

Parameters:

$eventId Integer
$unitId Integer
$date String
$time String
$recurringData Array
$endDateTime String (optional)

Returns Array.

Get list of dates for recurring booking

getRecurringSettings

getRecurringSettings($eventId)

Parameters:

$eventId Integer

Returns Array.

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

getRegistrations

getRegistrations($groupBy)

Parameters:

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

Returns Array.

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

getReservedTime

getReservedTime($from, $to, $eventId, $unitId, $count)

Parameters:

$from String
$to String
$eventId Integer
$unitId Integer
$count Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value is an array of two objects. Both objects contains list of time slots for type reserved_time and type not_worked_time. reserved_time type represents time slots working time but already booked by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.If Calendar Sync Custom Feature enabled then object with reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call isPluginActivated('google_calendar_export') API method to check if Calendar Sync Custom Feature activated.

Example:

  {
    "2016-02-05": [
      {
        "dd": [], // time slots from Google calendar
        "events": [ // reserved time slots
          { "from": "16:00", "to": "16:30" },
          { "from": "16:30", "to": "17:00" },
          ... ],
        "type": "reserved_time",
      },
      {
        "events": [
          { "from": "09:00", "to": "09:30" },
          { "from": "09:30", "to": "10:00" },
          ... ],
        "type": "not_worked_time"
     }],
     ...
  }

getReservedTimeIntervals

getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)

Parameters:

$dateFrom String
$dateTo String
$eventId Integer
$unitId Integer|Array
$count Integer

Returns Object.

Returns not available time Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}

getSocialCounterStats

getSocialCounterStats($provider)

Parameters:

$provider String

Returns Integer.

Returns social counters value for your domain

getStartTimeMatrix

getStartTimeMatrix($from, $to, $eventId, $unitId, $count)

Parameters:

$from String
$to String
$eventId Integer
$unitId Mixed can be Integer or Array of Integers
$count Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time Eg.: {'2014-05-14': ['09:00:00', ...], ...}

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 Multiple locations Custom Feature description for more details.

getStatuses

getStatuses()

No arguments. Returns Array.

Returns list of available statuses or an empty list if Status Custom feature not enabled.

getTimeframe

getTimeframe()

No arguments. Returns 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 here.

getTimelineType

getTimelineType()

No arguments. Returns String.

Returns company calendar layout type

getTopPerformers

getTopPerformers()

No arguments. Returns Array.

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

getTopServices

getTopServices($dateStart, $dateEnd)

Parameters:

$dateStart String
$dateEnd String

Returns Array.

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

getUnitList

getUnitList($isVisibleOnly, $asArray)

Parameters:

$isVisibleOnly Boolean
$asArray Boolean

Returns Array.

Returns list of service performers. If $asArray is false then method returns a map with event id as key and details object as value. If parameter set to true then method returns a list sorted by 'position' property of event's details object.

getUnitWorkdayInfo

getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)

Parameters:

$dateStart string
$dateEnd string
$unitGroupId integer

Returns Array.

Return workday info (date_start and date_end)

getUnitWorkingDurations

getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)

Parameters:

$dateStart string
$dateEnd string
$unitGroupId integer

Returns Array.

Return working durations

getVisitorStats

getVisitorStats($groupBy)

Parameters:

$groupBy String

Returns Array.

Returns statistics about page visits if Custom Feature Visitor Counter Custom Feature enabled. Returns an empty list if Custom Feature not enabled. Use isPluginActivated('counter') API method 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

for 'week' methods returns data last 10 weeks period
for 'month' time period is last 12 months

getWarnings

getWarnings($lastOnly)

Parameters:

$lastOnly Boolean. Default value is false.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains warning_type and warning_text properties. warning_text property contains localized message. warning_type can be one of the values:

sms_limit – warning indicates low amount of SMS credits
sheduler_limit – warning indicates low amount of available bookings

getWorkCalendar

getWorkCalendar($year, $month, $unitId)

Parameters:

$year Integer
$month Integer
$unitId Integer

Returns Object.

Returns company work schedule as array Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}

getWorkDaysInfo

getWorkDaysInfo($from, $to, $unitId, $eventId, $count)

Parameters:

$from String
$to String
$unitId Integer (optional)
$eventId Integer (optional)
$count Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period between two dates. If only service specified then information about performer (or performers) will be taken from service configuration. Method returns a list of objects for each date in specified period. Count of objects in list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method

returns:

  {'2014-05-14' : [
    {'from': '09:00:00', 'to': '13:00:00'},
    {'from': '14:00:00', 'to': '19:00:00'}
  ] }

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time range finishes on midnight.

getWorkDaysTimes

getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')

Parameters:

$startDateTime string
$endDateTime string
$type string. Optional. Either 'unit_group' or 'event'.

Returns Array.

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

getWorkload($dateStart, $dateEnd, $unitGroupId)

Parameters:

$dateStart string
$dateEnd string
$unitGroupId integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:

 ['2015-10-21' : {
    5 : [
      10, // working hours
      10, // load hours (confirmed bookings hours)
      0   // cancelled bookings hours
 ] }]

isPluginActivated

isPluginActivated($pluginName)

Parameters:

$pluginName String

Returns Boolean.

Return Custom Feature status true if status active, else false. $pluginName parameter is a Custom Feature identifier.See Custom Features page for full Custom Features description. See list of available plugin's names.

pluginApproveBookingApprove

pluginApproveBookingApprove($id)

Parameters:

$id Integer

Returns Array.

Sets approve booking status to 'approved' if Approve booking Custom Feature enabled and returns list of approved booking IDs. Returns false if Custom Feature not enabled. Use isPluginActivated('approve_booking') API method call to check if Custom Feature enabled.

pluginApproveBookingCancel

pluginApproveBookingCancel($id)

Parameters:

$id Integer

Returns Boolean.

Sets approve booking status to 'canceled' if Approve bookings Custom Feature enabled and returns true. Returns false if Custom Feature not enabled. Use isPluginActivated('approve_booking') API method call to check if Custom Feature enabled.

pluginApproveGetPendingBookings

pluginApproveGetPendingBookings()

No arguments. Returns array.

Returns list of objects with information about bookings pending approval if Approve bookings Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use isPluginActivated('approve_booking') API method call to check if Custom Feature enabled.

pluginApproveGetPendingBookingsCount

pluginApproveGetPendingBookingsCount()

No arguments. Returns Integer.

Returns count of bookings pending approval if Approve bookings Custom Feature enabled. Returns 0 if Custom Feature not enabled. Use isPluginActivated('approve_booking') API method call to check if Custom Feature enabled.

setBookingComment

setBookingComment($id, $comment)

Parameters:

$id Integer
$comment String

Returns Integer.

Set booking comment

getBookingStatus

getBookingStatus ($bookingId)

Parameters:

$bookingId Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled) default status will be returned if bookingId does not exists

setStatus

setStatus($bookingId, $statusId)

Parameters:

$bookingId Integer
$statusId Integer

Returns Boolean.

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 Status Custom feature not enabled.

updateNotification

updateNotification($type)

Parameters:

$type String

Returns .

Mark notifications as readed

setWorkDayInfo

setWorkDayInfo($info)

Parameters:

$info Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:

{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company

deleteSpecialDay

deleteSpecialDay($date, $params = null)

Parameters:

$date String
$params Array

Returns true on success

Delete special date if set

Example:

'2017-08-21', 
{
    "unit_group_id":"",
    "event_id":""
}

addServiceProvider

addServiceProvider($data)

Parameters:

$data Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:

{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}

editServiceProvider

editServiceProvider($id, $data)

Parameters:

$id Integer
$data Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider (there is no way to delete provider via API, in this case set is_active = 0)

Example:

1, 
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}

Constants

Error codes

See Errors handling for details.

-32001 Custom Feature is not activated
-32010 Some required params are missed
-32011 Params is not array
-32012 Sheduler id not found
-32015 Passed event id is not reccuren
-32020 Sorry, you have no permissions to perform this action
-32030 Invalid promotion code
-32031 Promotion has expired
-32032 Promotion is not active yet
-32033 This promocode is not valid for selected service
-32034 Exceed max usage limit
-32035 Exceed max usage per customer limit'const
-32036 This promocode is not available for datetime range
-32051 Selected event id is not available
-32052 Selected unit id is not available
-32053 Selected date start is not available
-32054 Selected time start is not available
-32055 One or more appointments couldn't be reserved
-32056 Booking is not allowed at this time
-32061 Client name value is wrong
-32062 Client email value is wrong
-32063 Client phone value is wrong
-32070 Intake form values are wrong
-32080 Appointemnt couldn't be found
-32081 Service can't be performed when company does not work
-32082 Service performer can't work when company does not work
-32085 Signature error
-32090 Confirmation with this key type is not available
-32095 Batch not found
-32097 Unsupported payment system
-32099 Payment failed
-32600
An error with this code can be thrown with one of the following messages:
- Access denied
- Company does not exists
-32601 Method not found
-32602 Invalid params
-32603 Internal error
-3264 Client with given id not found

Company params

Use these values to get configuration params for company with getCompanyParam API method.

General params

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
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_ga_tracking_id
default_phone
disconnect_on_timeout
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
mobile_site_link
mobile_site_link_title
no_show_period
on_success_button_link
on_success_button_text
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
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_public_layout
user_public_theme
waiting_video

Accept payments Custom Feature params

allow_delay_payment
Allow delay payment option. Boolean.
company_currency
hide_sale_tax
Hide sales tax option. Boolean.
payment_timeout
Payment timeout option. String ("5 minutes", "1 hour", ...)
sale_tax
Sales tax option. Integer. You should divide by 100 to get percent value.
paypal_account
PayPal payment processor configuration. String.
skrill_account
Skrill payment processor configuration parameter. String.
skrill_secret
Skrill payment processor configuration parameter. String.
zooz_app_id
ZooZ payment processor configuration parameter. String.
zooz_app_key
ZooZ payment processor configuration parameter. String.
dwolla_application_key
Dwolla payment processor configuration parameter. String.
dwolla_id
Dwolla payment processor configuration parameter. String.
dwolla_secret_key
Dwolla payment processor configuration parameter. String.
liqpay_merchant_id
liqpay_merchant_pass

Term & Conditions Custom Feature params

Read more about Terms and Conditions Custom Feature.

user_license_text
Terms and conditions text. String.

Custom Features' identifiers

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in isPluginActivated and getPluginStatuses API methods.

advanced_notification
Book Soon notification system
any_unit
Any Employee selector
api
API
approve_booking
Approve booking
back_to_site
Take me back home
contact_widget
Contact widget
counter
Visitor Counter
custom_css
Custom CSS
data_security
Clean history
description
HTML description field for events
event_category
Service categories
event_field
Intake forms
facebookImage
Facebook client info
financial_dashboard
Insights
google_analytics
Google Adwords and analytics
google_calendar_export
Calendar sync
group_booking
Group bookings
hipaa
HIPAA
limit_bookings
Limit bookings
location
Multiple locations
mobile_app_backend
Mobile application
multiple_booking
Multiple bookings
news
News
paid_events
Accept payments
recap
Daily report
secure
SSL
status
Status
unit_colors
Providers color coding
user_license
Terms and conditions
cancelation_policy
Cancellation Policy

See Custom Features page for description for each Custom Feature.

Examples

getBookingDetails response

An example of data returned by getBookingDetails API method.

 {
   "id": "321",
   "event_id": "5",
   "event_name": "Massage",
   "unit_id": "3",
   "unit_name": "John",
   "client_id": "1",
   "client_name": "Bob",
   "start_date_time": "2015-11-25 15:00:00",
   "end_date_time": "2015-11-25 16:00:00",
   "is_confirmed": "1",
   "code": "h8v8w5ls",
   "record_date": "2015-11-19 04:06:38",
   "comment": null,
   "company_login": "testzt",
   "company_name": "My Cool Company",
   "company_phone": "+1-555-55-55",
   "company_email": "into@mycoolcompany.com",
   "additional_fields": [{
     "value": "on",
     "field_name": "201a89517de509f6b3a60858918faac3",
     "field_title": "Include washing",
     "field_position": "4",
     "field_type": "checkbox",
     "field_id": "4"
   }],
   "comments": [],
   "history": [{
     "id": "536",
     "sheduler_id": "321",
     "datetime": "2015-11-19 11:06:38",
     "type": "create",
     "user_id": "1",
     "agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
     "ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
     "referer": "",
     "login": "admin",
     "firstname": "Mikhail",
     "lastname": ""
   }],
   "status": {
     "id": "3",
     "name": "Fancy Status",
     "description": null,
     "color": "4cbadb",
     "is_default": "1"
   },
   "location": {
     "id": "1",
     "title": "location",
     "description": null,
     "picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
     "address1": null,
     "address2": "Saint Margaret Street",
     "city": "\u041b\u043e\u043d\u0434\u043e\u043d",
     "zip": null,
     "country_id": "GB",
     "lat": "51.50013000000000000000",
     "lng": "-0.12630500000000000000",
     "phone": "44",
     "position": "1",
     "is_default": "1"
   },
   "price": [],
   "promo": false
 }

Location field is present in response only if 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.

Status field is present in response only if 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.

Price field is present in response only if 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.

additional_fields field is present in response only if 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

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

 {
   "require_confirm":false,
   "bookings":[
     {
       "id":"434",
       "event_id":"7",
       "unit_id":"3",
       "client_id":"34",
       "start_date_time":"2015-12-30 13:00:00",
       "end_date_time":"2015-12-30 13:30:00",
       "is_confirmed":"1",
       "code":"h8vc14ca",
       "hash":"785cb8cce316e64765b94c05a635f4be"
     },
     {
       "id":"435",
       "event_id":"7",
       "unit_id":"3",
       "client_id":"34",
       "start_date_time":"2015-12-31 13:00:00",
       "end_date_time":"2015-12-31 13:30:00",
       "is_confirmed":"1",
       "code":"h8vc2pge",
       "hash":"8b92d634541bfd93c0830967e56f4653"
     },
     {
       "id":"436",
       "event_id":"7",
       "unit_id":"3",
       "client_id":"34",
       "start_date_time":"2016-01-04 13:00:00",
       "end_date_time":"2016-01-04 13:30:00",
       "is_confirmed":"1",
       "code":"h8vc3urb",
       "hash":"cd22a0bf183f7350e595988dd2486e5b"
     },
     {
       "id":"437",
       "event_id":"7",
       "unit_id":"3",
       "client_id":"34",
       "start_date_time":"2016-01-05 13:00:00",
       "end_date_time":"2016-01-05 13:30:00",
       "is_confirmed":"1",
       "code":"h8vc44d9",
       "hash":"53f98ff4e4a0323aa907156c59c99362"
     }
   ],
   "batch_type":"batch_recurrent_booking",
   "recurrent_batch_id":"1",
   "batch_hash":"357178bce290381bb7235080941ec143"
 }

getCompanyInfo response

An example of data returned by getCompanyInfo API method.

 {
   "login": "pierrecoetzee",
   "name": "Pierre",
   "description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
   "address1": "",
   "address2": "Storey's Gate, ",
   "city": "London",
   "country_id": "GB",
   "lat": "51.500435",
   "lng": "-0.129811",
   "email": "pierre.coe@gmail.com",
   "phone": "",
   "web": null,
   "skip_address": null,
   "logo": null,
   "address": "GB, London, Storey's Gate, ",
   "description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
   "timezone": "Europe London",
   "show_in_client_timezone": false,
   "timeframe": "60",
   "timeline_type": "modern_week",
   "allow_event_day_break": "0",
   "allow_event_breaktime_break": "0"
 }

timeline_type field can be one the following values:

flexible
modern
flexible_week
modern_week
classic
classes

Please note that classic timeline type is deprecated and not supported anymore.

description field contains raw data of company's description which can include HTML tags. description_text field contains only text information without HTML tags.

For information about timeframe, timezone, allow_event_day_break and allow_event_breaktime_break see Company params section.

Search

Difference between revisions of "Company administration service methods"

Latest revision as of 08:50, 26 August 2022

General Information

Endpoint

Authentication

Methods

Methods

addClient

addDeviceToken

book

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

getPluginStatuses

getRecentActions

getRecurringDatetimes

getRecurringSettings

getRegistrations

getReservedTime

getReservedTimeIntervals

getSocialCounterStats

getStartTimeMatrix

getStatuses

getTimeframe

getTimelineType

getTopPerformers

getTopServices

getUnitList

getUnitWorkdayInfo

getUnitWorkingDurations

getVisitorStats

getWarnings

getWorkCalendar

getWorkDaysInfo

getWorkDaysTimes

getWorkload

isPluginActivated

pluginApproveBookingApprove

pluginApproveBookingCancel

pluginApproveGetPendingBookings

pluginApproveGetPendingBookingsCount