API Dashboard

Taffy 3.2.0

Resources:

/stats/portal/{portalid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

portalstats
getBusinessStats
Gets the stats for the business details page.
required numeric portalid
The id of the business.

/stats/{businessid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessstats
getBusinessStats
Gets the stats for the business details page.
required numeric businessid
The id of the business.

/data/realestate/stats DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

datarealestatestats
get
Get the real estate stats

/data/realestate/images DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

datarealestateimages
get
Get the real estate images

/data/realestate/firmbroker DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

datarealestatefirmbroker
get
Get the real estate frim brokers

/data/realestate/category DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

datarealestatecategory
get
Get the real estate categories

/data/realestate DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

datarealestate
get
Get the real estate records

/data/portalusers DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

dataportalusers
get
Get the real estate records

/data/clients DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

dataclients
get
Get the records

/data/businesses DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

databusinesses
get
Get the records

/{portalid}/weatherForecast DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

weatherforecast
getForecast
Returns the 3 day weather forecast for the selected region.
This relies on xml files which are generated on borg in /common/weather/~getWeatherScheduled.cfm.
This file is run hourly to refresh the forecast data.
required numeric portalid
The id of the portal you want to get the forecast for.

/{portalid}/user/login DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

userlogin
checkUserLogin
true
required numeric portalid
The id of the portal
required string username
The email address or screen name of the user attempting to log in
required string password
The password of the user attempting to log in, md5 hashed.

/{portalid}/user/{useruuid}/planner DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

userplannerdetail
getUserPlanner
Gets the types and ids that the user has saved to their planner
required numeric portalid
The id of the portal
required string useruuid
The uuid of the user
setUserPlanner
Saves the data for the users planner
required numeric portalid
The id of the portal
required string planner
A JSON string with the users planner types and ids
required string useruuid
The uuid of the user

/{portalid}/user DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

userdetail
getPortalDetails
true
required numeric userid

/{portalid}/schoolclosingschools DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

schoolclosingsschools
getSchools
Returns a distinct list of schools that have active closings
required numeric portalid
The id of the portal you want to get the school closings data for.

/{portalid}/schoolclosings DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

schoolclosingslist
getClosings
Returns a list of school closings for the given county and keyword. if not county or keyword is given, all closings will be returned.
querystring options are county and keyword.
required numeric portalid
The id of the portal you want to get the school closings for.

/{portalid}/schoolclosingcounties DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

schoolclosingscounties
getCounties
Returns a distinct list of counties that have active closings
required numeric portalid
The id of the portal you want to get the school closings data for.

/{portalid}/regions DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

regionslist
getRegions
Returns a list of regions for the given portal
required numeric portalid
The id of the portal you want to get the regions for.

/{portalid}/realestate/{propid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

realestatedetail
contactBroker
Save and send the email to the broker.
required numeric portalid
The id of the portal
required string uuid
the uuid of the property
getREListingDetail
Returns the details for the specified listing.
required numeric portalid
The id of the portal

/{portalid}/realestate DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

realestatelist
getREListings
Returns a list of real estate listings on the portal.
Optional querystring parameters:
portalidlist - a list of the portalids to get listings for
type - a numeric value for the property type you would like to get.
city - the city you would like listings from
low - the lowest price you would like to see
high - the hgighest price you would like to see
bed - the minimum number of bedrooms
bath - the minimum number of baths
openhouse - boolean determines if you want to see listings with upcoming open houses
justlisted - boolean determines if you want to see "just listed" properties (within the past week)
orderby - the field to order by
limit - the maximum number of rows to get
zip - the zip code of the property
address, the address of the property
searchterm - a search term which will search the city, zip and address
start - the row to start on (for pagaination)
limit - the number of rows to return.
required numeric portalid
The id of the portal

/{portalid}/portals DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

portallist
getPortalList
true
required numeric portalid
The id of the portal

/{portalid}/portal DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

portaldetail
getPortalDetails
Get the name and uuid of the portal
required numeric portalid
The id of the portal

/{portalid}/planner DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

plannerdetail
getPlannerDetails
Gets the data for the users planner
required numeric portalid
The id of the portal
required string planner
A JSON string with the users planner types and ids
optional string plannerRemove
setPlannerDetails
Gets the data for the users planner
required numeric portalid
The id of the portal
required string useruuid
The uuid of the user that we are updating the planner for
required string planner
A JSON string with the users planner types and ids

/{portalid}/movies/theaters DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

movietheaterlist
getTheaters
Returns the list of Theaters
required numeric portalid
The id of the portal you want to get the theaters for.
optional numeric nameonly (default: 0)
(1 or 0). if set to 1, then we only return a list of the name and id of each theater.
optional string orderby (default: city, name)

/{portalid}/movies/showtimes/theater/{theaterid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

movieshowtimetheater
getTheaterShowtimes
Returns the list of showtimes for all movies at the given Theater.
Note: this only returns showtimes for Today and Tomorrow
required numeric portalid
The id of the portal you are workign with
required string theaterid
The id of the theater you want to get the showtimes for.

/{portalid}/movies/showtimes/movie/{movieid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

movieshowtimemovie
getMovieShowtimes
Returns the list of showtimes for all theaters playing the given movie
required numeric portalid
The id of the portal you are workign with
required string movieid
The id of the movie you want to get the showtimes for.

/{portalid}/movies DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

movielist
getMovies
Returns the detail list of movies currently playing in theaters
This data is refreshed daily from admin in the /~scheduled folder..
required numeric portalid
The id of the portal you want to get the forecast for.
optional string movieid (default: all)
The TMS_id of the movie you want the details for. you can also specify "all"

/{portalid}/login DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

login
getSiteToken
login the user and create a new token for the site
required numeric portalid
The id of the portal
required string username
The username
required string password
The password for this user
required string domain
The domain for this portal site

/{portalid}/jobs/indeed/ DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

jobsindeedlist
getJobListingsIndeed
A list of jobs from the indeed API. You can also pass the following in the querystring:
start - the record number to start on
limit - the number of records to get (default is 20)
s - a search string
required numeric portalid
The id of the portal

/{portalid}/jobs/costs DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

jobscosts
getJobCosts
a list of the costs to post a job to the portal.
required numeric portalid
The id of the portal

/{portalid}/jobs/{jobid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

jobscontact
employerContact
A list of jobs on the portal, you can also pass in jobids, types or limit as url variables. Note that jobids is the job UUIDs.
required numeric portalid
The id of the portal
required string jobid

/{portalid}/jobs DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

jobslist
getJobListings
A list of jobs on the portal, you can also pass in job types, keyword or limit as url variables.
required numeric portalid
The id of the portal

/{portalid}/job/{jobid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

jobsdetails
getJobDetails
A list of jobs on the portal, you can also pass in jobids, types or limit as url variables.
required numeric portalid
The id of the portal
required string jobid
a list of 1 or more jobids that you want to get details for

/{portalid}/gallery/{galleryid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

photogallery
getEventDetails
Gets the gallery photos and text by the gallery id.
required numeric portalid
The id of the portal
required numeric galleryid
The id of the gallery

/{portalid}/events/otherportal DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventotherportallist
getEventOtherPortals
Gets a list of other portals to include as checkboxes in the event listing page filter
required numeric portalid
The id of the portal

/{portalid}/events DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventlist
getEventList
Retreive a list of events based on the portal id and search using the following query string keys:
  • bestbet
  • businessid
  • categoryid
  • city
  • date
  • dateend
  • datestart
  • eventid
  • excludeeventids
  • hasimage
  • ignoreportalcat
  • ismannix
  • otherportals
  • randomsort
  • selecttop
  • sponsorid
  • suppresedcategories
  • taglist
required numeric portalid
The id of the portal

/{portalid}/event/category/group DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventcategorygrouplist
getCategoryGroupList
Get the list of a portals event groups
required numeric portalid
The id of the portal

/{portalid}/event/category DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventcategorylist
getCategoryList
Get the list of a portals event categories
required numeric portalid
The id of the portal

/{portalid}/event/{eventid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventdetail
getEventDetails
Gets the event details by the eventd id. Also gets related events based on the category of the event
required numeric portalid
The id of the portal
required numeric eventid
The id of the event

/{portalid}/event DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

eventcreate
createEvent
Create an event based on the form scope posted to this endpoint
required numeric portalid
The id of the portal

/{portalid}/coupons DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

couponslist
getCouponList
A list of coupons on the portal
URL variables available: url.businessid, url.couponids, url.type, url.limit, url.catid
Note: url.catid must be the full wordpress category path (i.e.: /4/18/)
required numeric portalid
The id of the portal

/{portalid}/contest/{contestslug} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

contestdetail
enterContest
Save the users contest entry.
required numeric portalid
The id of the portal
required string contestslug
The slug of the contest
getContestBySlug
Gets the event details by the contest id.
required numeric portalid
The id of the portal
required string contestslug
The slug of the contest

/{portalid}/contest DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

contestlist
getContestList
Get a list of contests based on the portal id.
URL Variables
boolean url.live: true returns active contests. false returns past contests.
required numeric portalid
The id of the portal

/{portalid}/contact DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

contactsend
businessContactById
Send an email to multiple businesses based on the category id list for the portal.
required numeric portalid
The id of the portal
required string businessid
The id of the business

/{portalid}/category/sync DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscategorysync
syncCategoryList
Get the entire list of active categories for the portal.
required numeric portalid
The id of the portal
required string categorylist
A List of json formated categories that include the category id, parent id and name of each category

/{portalid}/category/contact DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscategorycontact
contactBusinessByCategoryIds
Send an email to multiple businesses based on the category id list for the portal.
required numeric portalid
The id of the portal
required string categoryids
The wordpress category ids

/{portalid}/category/{categoryid}/business DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscategorylist
getBusinessList
Get a list of businesses based on the portal id and category id.

multicats Optional URL param. If you want to get businesses for more than one category, list them here (comma separated). Note - this will override the categoryid value.
required numeric portalid
The id of the portal
required numeric categoryid
The wordpress category id

/{portalid}/category/{categoryid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscategorydetail
deleteCategory
Deletes a category and wp category association.
required numeric portalid
The id of the portal
required numeric categoryid
The wordpress category id
updateCategory
Updates a category and wp category association.
required numeric portalid
The id of the portal
required numeric categoryid
The wordpress category id
required numeric parentid
The parent id of the wordpress category
required numeric depth
The depth of the wordpress category ( 1 = main category, 2 = sub category, etc. )
required string name
The name of the wordpress category

/{portalid}/category DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscategory
createCategory
Creates a new category and wp category association.
required numeric portalid
The id of the portal
required numeric categoryid
The wordpress category id
required numeric parentid
The parent id of the wordpress category
required numeric depth
The depth of the wordpress category ( 1 = main category, 2 = sub category, etc. )
required string name
The name of the wordpress category
getCategoryList
Get the entire list of active categories for the portal.
required numeric portalid
The id of the portal

/{portalid}/business/group DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessgroup
getBusinessGroups
Send an email to multiple businesses based on the category id list for the portal.
required numeric portalid
The id of the portal

/{portalid}/business/featured DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessfeaturedlist
getBusinessList
Get a list of businesses based on the portal id and category id.
required numeric portalid
The id of the portal
optional numeric count

/{portalid}/business/{businessid}/website/{type} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesswebsite
getBusinessWebsite
Gets the url for the business
required numeric portalid
The id of the portal
required numeric businessid
The id of the business
required string type

/{portalid}/business/{businessid}/review/create DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessreviewcreate
createReview
Create a business review based on the form scope posted to this endpoint
required numeric portalid
The id of the portal
required numeric businessid
The id of the business

/{portalid}/business/{businessid}/review/{reviewuuid}/response DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessreviewresponse
createReviewResponse1
Create a business review based on the form scope posted to this endpoint
required numeric portalid
The id of the portal
required numeric businessid
The id of the business
required string reviewuuid

/{portalid}/business/{businessid}/review/{reviewid}/report DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessreviewreport
reportReview
Create a business review based on the form scope posted to this endpoint
required numeric portalid
The id of the portal
required numeric businessid
The id of the business

/{portalid}/business/{businessid}/review/{reviewid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessreviewdetail
getReviewById
Create a business review based on the form scope posted to this endpoint
required numeric portalid
The id of the portal
required numeric businessid
The id of the business
optional string replyuuid (default: "")

/{portalid}/business/{businessid}/review DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessreviewlist
getReviews
Get a list of reviews for a business
required numeric portalid
The id of the portal
required numeric businessid
The id of the business

/{portalid}/business/{businessid}/contact DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesscontact
businessContactById
Send an email to multiple businesses based on the category id list for the portal.
required numeric portalid
The id of the portal
required string businessid
The id of the business

/{portalid}/business/{businessid} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businessdetail
getBusinessDetails
Gets the data for the business details page. Query string values.
  • imgtype: The string that is appened to the end of a file name for the image type ( li for listing image, box for box image, etc. )
  • show: comma separated list of features to get. Default (and valid values): 'categories,coupons,details,events,img,pdf,reviews,slideshow,video'
required numeric portalid
The id of the portal.
required numeric businessid
The id of the business.

/{portalid}/business DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

businesslist
getBusinessList
Get a list of businesses based on the portal id optional query string values. Query string values.
  • categoryid: The wordpress category id
  • WpCategoryIds: a comma seperated list of wordpress category ids
  • city: a single city
  • tag: a comma separated list of tags
required numeric portalid
The id of the portal

/{ping}/{test} DELETE PATCH PUT POST GET

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

ping
getTest
Send an email to multiple businesses based on the category id list for the portal.

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.