Revision as of 16:05, 4 January 2016 by Admin (talk | contribs) (Created page with "== Methods == === getCategories === <code>getCategories()</code> No arguments. Returns Array. Get lsit of ALL categories ---- === getCities === <code>getCities($countr...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Catalogue

From SimplyBook.me

Methods

getCategories

getCategories()

No arguments. Returns Array.

Get lsit of ALL categories



getCities

getCities($country)

Parameters:

  • $country String

Returns Array.

Returns city list as Array order by name



getCompanyCount

getCompanyCount($filter)

Parameters:

  • $filter Object - filter object

Returns array.

Returns total companies count with specified filter$filter filter params. Object that contains following params

'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
    }
}

Use tag_ids OR tags



getCompanyInfo

getCompanyInfo($login)

Parameters:

  • $login String

Returns Object.

Returns company information by company login



getCompanyList

getCompanyList($filter, $from, $limit)

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

'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
    }
}

Use tag_ids OR tags



getCompanyMarkers

getCompanyMarkers($filter, $bounds, $zoom, $clustering)

Parameters:

  • $filter Object - filter object
  • $bounds
  • $zoom
  • $clustering

Returns array.

Returns company markers$filter filter params. Object that contains following params

'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
    }
}

Use tag_ids OR tags



getCompanyReviews

getCompanyReviews($login)

Parameters:

  • $login String

Returns Object.

Returns company reviews list



getCountries

getCountries()

No arguments. Returns Array.

Returns country list as Array order by name



getFeedbackList

getFeedbackList()

No arguments. Returns Array.

Get lsit of ALL simplybook feedbacks



getPromotionCount

getPromotionCount($filter)

Parameters:

  • $filter Object - filter object

Returns array.

Returns total active promotions count with specified filter$filter filter params. Object that contains following params

'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
    }
}

Use tag_ids OR tags



getPromotionInfo

getPromotionInfo($id, $feedbackFrom, $feedbackCount)

Parameters:

  • $id Integer
  • $feedbackFrom Integer = 0
  • $feedbackCount Integer = 100

Returns Object.

Returns promotion information by id



getPromotionList

getPromotionList($filter, $from, $limit)

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

'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
    }
}

Use tag_ids OR tags



getPromotionListByIds

getPromotionListByIds($ids)

Parameters:

  • $ids

Returns array.

Returns active promotion list



getPromotionReviews

getPromotionReviews($promotionId)

Parameters:

  • $promotionId Integer

Returns Object.

Returns promotion reviews list



getRecentCompanies

getRecentCompanies($count)

Parameters:

  • $count Integer

Returns Array.

Returns list of companies ordered by date DESC



getRecentFeedbacks

getRecentFeedbacks($count)

Parameters:

  • $count Integer

Returns Array.

Returns list of feedbacs ordered by date DESC



getRecentPromotions

getRecentPromotions($count)

Parameters:

  • $count Integer

Returns Array.

Returns list of promotions ordered by date DESC



getRelatedPromotions

getRelatedPromotions($id, $count)

Parameters:

  • $id Integer
  • $count Integer = 10

Returns Array.

Returns related promotions by given promotion id



getTags

getTags($filter)

Parameters:

  • $filter Object - filter object

Returns Array.

Returns tags list$filter filter params. Object that contains following params

'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String

Use tag_ids OR tags



getTopCities

getTopCities()

No arguments. Returns Array.

Returns city list as Array order by company count in city



getTopCountries

getTopCountries()

No arguments. Returns Array.

Returns country list as Array order by company count in country