9,514
edits
Changes
From SimplyBook.me
Company administration service methods (view source)
Revision as of 14:26, 30 March 2017
, 7 years agono edit summary
fields (see [[Custom_Features#Additional_Fields|Additional Fields Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>
fields (see [[Custom_Features#Additional_Fields|Additional Fields Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>
If [[Custom_Features#Unit_Location|Unit location]] 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>[[#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>[[#getLocationsList|getLocationsList()]]</code> method to get list of
Returns Array.
Returns Array.
Returns available locations for company if Custom Feature [[Custom_Features#Unit_Location|Unit location 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>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.
API method to check if Custom Feature activated.
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#Unit_Location|Unit location]] 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.
*:Limit bookings
*:Limit bookings
* location
* location
*:Unit location
*:Multiple locations
* mobile_app_backend
* mobile_app_backend
*:Mobile application
*:Mobile application
}
}
Location field is present in response only if [[Custom_Features#Unit_Location|Unit location 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.
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.
