9,514
edits
Changes
From SimplyBook.me
Created page with "== Methods == === getCategories === <code>getCategories()</code> No arguments. Returns Array. Get lsit of ALL categories ---- === getCities === <code>getCities($countr..."
== Methods ==
=== getCategories ===
<code>getCategories()</code>
No arguments.
Returns Array.
Get lsit of ALL categories
----
=== getCities ===
<code>getCities($country)</code>
Parameters:
* '''$country''' String
Returns Array.
Returns city list as Array order by name
----
=== getCompanyCount ===
<code>getCompanyCount($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns array.
Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyInfo ===
<code>getCompanyInfo($login)</code>
Parameters:
* '''$login''' String
Returns Object.
Returns company information by company login
----
=== getCompanyList ===
<code>getCompanyList($filter, $from, $limit)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit
Returns array.
Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyMarkers ===
<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''
Returns array.
Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyReviews ===
<code>getCompanyReviews($login)</code>
Parameters:
* '''$login''' String
Returns Object.
Returns company reviews list
----
=== getCountries ===
<code>getCountries()</code>
No arguments.
Returns Array.
Returns country list as Array order by name
----
=== getFeedbackList ===
<code>getFeedbackList()</code>
No arguments.
Returns Array.
Get lsit of ALL simplybook feedbacks
----
=== getPromotionCount ===
<code>getPromotionCount($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns array.
Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getPromotionInfo ===
<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>
Parameters:
* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100
Returns Object.
Returns promotion information by id
----
=== getPromotionList ===
<code>getPromotionList($filter, $from, $limit)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit
Returns array.
Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getPromotionListByIds ===
<code>getPromotionListByIds($ids)</code>
Parameters:
* '''$ids'''
Returns array.
Returns active promotion list
----
=== getPromotionReviews ===
<code>getPromotionReviews($promotionId)</code>
Parameters:
* '''$promotionId''' Integer
Returns Object.
Returns promotion reviews list
----
=== getRecentCompanies ===
<code>getRecentCompanies($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of companies ordered by date DESC
----
=== getRecentFeedbacks ===
<code>getRecentFeedbacks($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of feedbacs ordered by date DESC
----
=== getRecentPromotions ===
<code>getRecentPromotions($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of promotions ordered by date DESC
----
=== getRelatedPromotions ===
<code>getRelatedPromotions($id, $count)</code>
Parameters:
* '''$id''' Integer
* '''$count''' Integer = 10
Returns Array.
Returns related promotions by given promotion id
----
=== getTags ===
<code>getTags($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns Array.
Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags
----
=== getTopCities ===
<code>getTopCities()</code>
No arguments.
Returns Array.
Returns city list as Array order by company count in city
----
=== getTopCountries ===
<code>getTopCountries()</code>
No arguments.
Returns Array.
Returns country list as Array order by company count in country
----
=== getCategories ===
<code>getCategories()</code>
No arguments.
Returns Array.
Get lsit of ALL categories
----
=== getCities ===
<code>getCities($country)</code>
Parameters:
* '''$country''' String
Returns Array.
Returns city list as Array order by name
----
=== getCompanyCount ===
<code>getCompanyCount($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns array.
Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyInfo ===
<code>getCompanyInfo($login)</code>
Parameters:
* '''$login''' String
Returns Object.
Returns company information by company login
----
=== getCompanyList ===
<code>getCompanyList($filter, $from, $limit)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit
Returns array.
Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyMarkers ===
<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''
Returns array.
Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getCompanyReviews ===
<code>getCompanyReviews($login)</code>
Parameters:
* '''$login''' String
Returns Object.
Returns company reviews list
----
=== getCountries ===
<code>getCountries()</code>
No arguments.
Returns Array.
Returns country list as Array order by name
----
=== getFeedbackList ===
<code>getFeedbackList()</code>
No arguments.
Returns Array.
Get lsit of ALL simplybook feedbacks
----
=== getPromotionCount ===
<code>getPromotionCount($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns array.
Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getPromotionInfo ===
<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>
Parameters:
* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100
Returns Object.
Returns promotion information by id
----
=== getPromotionList ===
<code>getPromotionList($filter, $from, $limit)</code>
Parameters:
* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit
Returns array.
Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
----
=== getPromotionListByIds ===
<code>getPromotionListByIds($ids)</code>
Parameters:
* '''$ids'''
Returns array.
Returns active promotion list
----
=== getPromotionReviews ===
<code>getPromotionReviews($promotionId)</code>
Parameters:
* '''$promotionId''' Integer
Returns Object.
Returns promotion reviews list
----
=== getRecentCompanies ===
<code>getRecentCompanies($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of companies ordered by date DESC
----
=== getRecentFeedbacks ===
<code>getRecentFeedbacks($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of feedbacs ordered by date DESC
----
=== getRecentPromotions ===
<code>getRecentPromotions($count)</code>
Parameters:
* '''$count''' Integer
Returns Array.
Returns list of promotions ordered by date DESC
----
=== getRelatedPromotions ===
<code>getRelatedPromotions($id, $count)</code>
Parameters:
* '''$id''' Integer
* '''$count''' Integer = 10
Returns Array.
Returns related promotions by given promotion id
----
=== getTags ===
<code>getTags($filter)</code>
Parameters:
* '''$filter''' Object - filter object
Returns Array.
Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags
----
=== getTopCities ===
<code>getTopCities()</code>
No arguments.
Returns Array.
Returns city list as Array order by company count in city
----
=== getTopCountries ===
<code>getTopCountries()</code>
No arguments.
Returns Array.
Returns country list as Array order by company count in country
----
