BranchContent

Manages branch content.

APIDescription
POST api/BranchContent

Updates the branch content from IDBS/Rosy. The branch must be in a publishable state, i.e. not have errors, for the data to be applied successfully, which can be tested by republishing the branch node within Umbraco.

BranchRating

Manages branch rating details.

APIDescription
POST api/BranchRating

Updates the overall rating details of a branch. The branch must be in a publishable state, i.e. not have errors, for the data to be applied successfully, which can be tested by republishing the branch node within Umbraco.

BranchRatings

Manages branch rating details.

APIDescription
POST api/BranchRatings

Updates the overall rating details of all the branches. The branches must be in a publishable state, i.e. not have errors, for the data to be applied successfully, which can be tested by republishing the branch node within Umbraco. Request Timeout has been set to 10 minutes.

CompetitorProperties

Contains operations that update competitor properties contained within the Elasticsearch instance. These properties are stored on a separate search index from the Spicerhaart properties to avoid confusion!

APIDescription
GET api/CompetitorProperties/Clear

Clears the entire index.

POST api/CompetitorProperties

Adds properties if their unique IDs have not been indexed before, otherwise updates the existing entries.

PUT api/CompetitorProperties

Adds properties if their unique IDs have not been indexed before, otherwise updates the existing entries.

DELETE api/CompetitorProperties

Removes properties from the search index.

CompetitorProperty

Contains operations that update competitor properties contained within the Elasticsearch instance. These properties are stored on a separate search index from the Spicerhaart properties to avoid confusion!

APIDescription
POST api/CompetitorProperty

Adds a property if its unique ID has not been indexed before, otherwise updates the existing entry.

PUT api/CompetitorProperty

Adds a property if its unique ID has not been indexed before, otherwise updates the existing entry.

DELETE api/CompetitorProperty/{id}

Removes a property from the search index, also delete any properties with this id that users have saved in MyProperties.

ElasticStatistics

Contains operations that extract statistical data for the search indices.

APIDescription
GET api/ElasticStatistics

Statistics API that retrieves a breakdown of all recorded stats.

File

Downloads a transferred file into the temp folder.

APIDescription
POST api/File

Saves uploaded image to local file location.

OPTIONS api/File

Saves uploaded image to local file location.

MarketData

Updates the market statistics data of branches.

APIDescription
POST api/MarketData

Adds or updates the market statistics for sales branches.

Properties

Contains operations that update properties contained within the Elasticsearch instance.

APIDescription
POST api/Properties

Adds properties if their unique IDs have not been indexed before, otherwise updates the existing entries.

PUT api/Properties

Adds properties if their unique IDs have not been indexed before, otherwise updates the existing entries.

DELETE api/Properties

Removes properties from the search index, also deletes any properties with these IDs from statistics, or that users have saved in My Properties or Saved Properties.

Property

Contains operations that update properties contained within the Elasticsearch instance.

APIDescription
POST api/Property

Adds a property if its unique ID has not been indexed before, otherwise updates the existing entry.

PUT api/Property

Adds a property if its unique ID has not been indexed before, otherwise updates the existing entry.

DELETE api/Property/{id}

Removes a property from the search index, also deletes any properties with this ID from statistics, or that users have saved in My Properties or Saved Properties.

PropertyStatistics

Contains operations that extract statistical data recorded through site usage.

APIDescription
GET api/PropertyStatistics

Statistics API that retrieves a breakdown of all recorded stats.

POST api/PropertyStatistics

Statistics API that retrieves all stats recorded between the specified time frame.

Testimonial

Contains operations to create/update and delete testimonials from the CMS.

APIDescription
POST api/Testimonial

Creates or updates a testimonial. Will create the testimonial listing node if it does not yet exist for the branch.

DELETE api/Testimonial

Deletes a testimonial.