Company administration service methods: Difference between revisions

* '''$clientData''' Object

* '''$token''' String- device token

* '''$device''' String- device type (android or apple)

Subscribe a mobile device to push notifications about new bookings or changes in already created bookings.Use <code>'apple'</code> or <code>'android'</code> for <code>device</code> parameter.

* '''$eventId''' Integer

* '''$unitId''' Integer

* '''$clientId''' Integer

* '''$startDate'''  

* '''$startTime'''  

* '''$endDate''' null

* '''$endTime''' null

* '''$clientTimeOffset''' Integer

* '''$additional''' array|Object- additional params and fields.

* '''$count''' Integer- bookings count, min. 1 (using for group bookings batch). (optional)

* '''$batchId''' Integer- add booking to multiple bookings batch. (optional)

* '''$recurringData''' Array- make booking recurrent. (optional)

Book service. Returns object with appointment information or throw exception

If appointment requires confirm, in result object will be require_confirm = true

You can use $count > 1 or $batchId != null at the same time.

* '''$startDateTime''' Stringa date and time string in format &#039;Y-m-d H:i:s&#039;, eg. &#039;2001-10-02 13:30:00&#039;.

* '''$eventId''' Integer

* '''$unitId''' Integer

* '''$id''' Integer

* '''$bookingIds''' Array

* '''$id''' Integer

Create booking batch

Returns batch id

* '''$token''' String- device token

* '''$shedulerId''' Integer

* '''$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.

Edit existing booking

* '''$clientId''' Integer

* '''$clientData''' Object

* '''$eventId''' Integer

* '''$eventId''' Integer

* '''$dateTime''' Stringa date and time string in format Y-m-d H:i:s

* '''$count''' Integer

Returns available unit ids for present data or empty array if all units are not allowed

Eg.: <code>[1, 2, 3]</code>

* '''$dateStart''' Stringa date string in format &#039;Y-m-d&#039;. Pass null to get data from first day of current week.

* '''$dateEnd''' Stringa date string in format &#039;Y-m-d&#039;. Pass null to get data filtered to last day of current week.

* '''$id''' Integer

* '''$id''' integerbooking id

* '''$startDateTime''' stringa date and time string in format &#039;Y-m-d H:i:s&#039;

* '''$endDateTime''' stringa date and time string in format &#039;Y-m-d H:i:s&#039;

* '''$eventId''' integer

* '''$dateStart''' null

* '''$dateEnd''' null

* '''$unitGroupId''' integer

* '''$serviceId''' integer

* '''$groupBy''' String

* '''$params'''  

* '''$isPublic''' Boolean

* '''$clientId'''  

Get client by id

* '''$clientId''' Integer

* '''$shedulerId''' Integer

* '''$searchString''' String

* '''$limit''' Integer

Get list of clients

Returns company currency

* '''$key''' String

Return all information about current tariff

* '''$isVisibleOnly''' Boolean

* '''$asArray''' Boolean

* '''$approvedOnly''' Boolean

* '''$reviewsOnly''' Boolean

* '''$lastOnly''' Boolean

* '''$limit''' Integer

* '''$unitId''' Integer

* '''$startDateTime''' string

* '''$endDateTime''' string

* '''$unitId''' integer

* '''$type''' String

* '''$isPublic''' Boolean

Get list of plugins with status

* '''$pluginNames''' Array

* '''$lastOnly''' Boolean

* '''$limit''' Integer

* '''$eventId''' Integer

* '''$unitId''' Integer

* '''$date''' String

* '''$time''' String

* '''$recurringData''' Array

* '''$endDateTime''' null

* '''$eventId''' Integer

* '''$groupBy''' String

* '''$from''' String

* '''$to''' String

* '''$eventId''' Integer

* '''$unitId''' Integer

* '''$count''' Integer

* '''$provider''' String

* '''$from''' String

* '''$to''' String

* '''$eventId''' Integer

* '''$unitId''' Mixedcan be Integer or Array of Integers

* '''$count''' Integer

Return list of available statuses

Get list of performers with number of bookings and revenues per service

* '''$dateStart''' String

* '''$dateEnd''' String

Get list of services with number of bookings and revenues per service

* '''$isVisibleOnly''' Boolean

* '''$asArray''' Boolean

* '''$dateStart'''  

* '''$dateEnd'''  

* '''$unitGroupId''' integer

* '''$dateStart''' null

* '''$dateEnd''' null

* '''$unitGroupId''' integer

* '''$groupBy''' String

* '''$year''' Integer

* '''$month''' Integer

* '''$unitId''' Integer

* '''$from''' String

* '''$to''' String

* '''$unitId''' Integer

* '''$eventId''' null

* '''$startDateTime''' string

* '''$endDateTime''' string

* '''$dateStart''' null

* '''$dateEnd''' null

* '''$unitGroupId''' integer

* '''$pluginName''' String

* '''$id''' Integer

* '''$id''' Integer

* '''$id''' Integer

* '''$comment''' String

* '''$bookingId''' Integer

* '''$statusId''' Integer

Set status

* '''$type''' String

<code>additional_fields</code> fields is present in response only if [[Plugins#Additional fields|Additional fields plugin]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if plugin is enabled but booking was created for a service with no additional fields.