Platform Glossary
This section provides further information on the concepts and terminology referenced by the Reapit Foundations Platform and the endpoints we provide
Areas represent a specific geographical location that an applicant is interested in buying/renting within. Areas are comprised of either polygon coordinates or a listing of postcodes. Areas are hierarchical and a single area can alternatively include a list of other areas.
Appointments represent calendar engagements used by negotiators to schedule meetings or arrange events, such as property viewings and valuations. Appointments can be set to recur by including recurrence information and can be scheduled to appear in multiple negotiators’ calendars.
Configuration represents the customisation options relevant for a customers data set, as some data can differ depending on the configuration of the customer. For example, an agent may want to add to their list of vendor selling reasons so that it can be set against a particular vendors
sellingReasonIdWe present lists like this as RESTful endpoints and document where a field references a configurable lists id. We also include links/embed options where appropriate to simplify consumption.
Conveyancing represents the process of progressing an accepted offer to the completion of the sale of a property.
Submitting new offers and transitioning them to an accepted status is done using the Offers API. The Conveyancing API is responsible for transitioning that existing, accepted offer into a completed property sale.
Our Conveyancing APIs also allow a chain to be managed, providing a means of linking dependant offers together. It's possible to link to offers added to other properties that the customer has instructed, as well as those that are external and instructed to another agent.
Customers represent estate agents who use Reapit software. We do not provide an API to obtain details of our customers, instead, their details will be known to you at the point that they install your AppMarket application.
Departments represent a set of descriptive attributes used to describe a property. Departments are assigned to both properties and applicants and are used to define which attributes can be used to describe a property or an applicant property requirement.
A Department is most commonly used to ring fence groups of properties and applicants, particularly when it comes to matching (the process of finding properties that meet specific applicant requirements and vice versa). Typically, customers dealing with only residential sales and lettings will have a single department as there is no real need to separate any of the data, however an example of where multiple departments might be configured would be a customer who deals with both residential and commercial property transactions. In this scenario, a separate Department would normally be setup to separate the two disparate sets of data, as it would be undesirable for residential applicants to be sent details of commercial properties.
Departments are completely customisable for each agent and subsequently it can be difficult to understand how to interpret this data as it comes out of the various APIs that expose it. As the APIs are standardised across all our customers, Department data has also been standardised where possible using a mapping mechanism to map the customisable values from our CRM into standard values in the API. Any options that do not have a corresponding mapping and are selected on a Property or Applicant entity will be included in the
unmappedAttributes and unmappedRequirements collections in their respective APIs. Additionally, the Special attributes column in the CRM is mapped explicitly. The tabbed content below provides the latest version of the mappings
Type
Style
Situation
Locality
Parking
Age
The following table shows the values exposed in the
type collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
bungalow | Bungalow |
commercial | Commercial |
cottage | Cottage |
developmentOpportunity | Development Opportunity |
developmentPlot | Development Plot, Single Plot, Plot, Building Plot |
estate | Estate, Farm/Estate, Residential Farm/Estate, Country Estate |
farm | Farm |
flatApartment | Flat/Apartment, Flat / Apartment, Flat, Apartment, Unit/Apartment, Flats |
garage | Garage, Garage Lockup, Lockup, Garage Only |
hotel | Hotel, Hotels |
house | House, House/Villa |
industrial | Industrial, Industrial/Storage |
land | Land |
leisure | Leisure, Leisure Facility |
maisonette | Maisonette |
mixedUse | Mixed Use, Mixed |
office | Office, Offices |
publicHouse | Public House, Pub |
retail | Retail |
shop | Shop |
smallHolding | Small Holding |
studio | Studio, Studio Flat |
townhouse | Townhouse, Town House |
villa | Villa |
warehouse | Warehouse, Warehouse/Distribution |
The following table shows the values exposed in the
style collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
basement | Basement |
bungalow | Bungalow |
detached | Detached |
duplex | Duplex |
endTerrace | End of Terrace |
firstFloor | First Floor |
groundFloor | Ground Floor |
linkDetached | Link Detached, Link-Detached |
lowerGroundFloor | Lower Ground Floor, Lower Ground |
mews | Mews |
penthouse | Penthouse |
semiDetached | Semi Detached, Semi-Detached |
steading | Steading |
studio | Studio, Studio Flat |
terraced | Terraced, Terrace |
upperFloor | Upper Floor, Upper Floor without Lift, Upper Floor w/out Lift |
upperFloorWithLift | Upper Floor with Lift, Upper Floor w/Lift, Upper Flr with Lift |
The following table shows the values exposed in the
situation collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
balcony | Balcony |
communalGarden | Communal Garden |
conservatory | Conservatory |
garden | Garden |
julietBalcony | Juliette Balcony |
land | Land/Paddock, Land / Paddock, Paddock Land |
outsideSpace | Outside Space |
patio | Patio |
roofTerrace | Roof Terrace, Terrace, Roof Terrace/Terrace |
The following table shows the values exposed in the
locality collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
rural | Rural |
townCity | Town/City, Town / City, Town, Town Centre, Town/City Centre |
village | Village |
The following table shows the values exposed in the
parking collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
carport | Carport, Car Port |
doubleGarage | Double Garage |
garage | Garage |
offStreet | Off Street Parking, Off Road Parking, Driveway, Off Street |
residents | Residents Parking, Resident Parking, Parking, Allocated Parking, Permit Parking, Garage/Parking Space, Allocated Parking Space, Allocated/Private Parking |
secure | Secure Parking, Gated Parking |
tripleGarage | Triple Garage |
underground | Underground, Underground Parking, Secure Underground Parking |
The following table shows the values exposed in the
age collection returned by the Applicant, Property and Department APIs and their corresponding mappings back to the AgencyCloud CRM.
Platform Value | AgencyCloud Mapping |
|---|---|
modern | Modern, Post War, Post-war, Modern (Post 1945), Modern (1920+) |
new | New, New Build, New Homes, New Home, New (Off Plan), Newly Built, New Property, New Development, New Property |
period | Period, Pre-war, Period (to 1714), Period (Pre 1945), Period (Pre-1920) |
Documents represent the details of a file asset that has been added to our platform. Documents can be assigned a type to indicate its purpose (eg. a brochure) and associated to an associated entity (eg. a property).
When using the
GET /documents/{id}/download endpoint to download the physical file asset, you must pass an Accept header with the value application/octet-streamEnquiries (Internet Registrations) represent a potential sales or lettings lead for the agent. An enquiry can either contain information about a valuation request from a vendor/landlord or can represent interest from a potential applicant such as a viewing request. Enquiries are vetted by the agent before they are promoted into property or applicant entities. Enquiries will appear in AgencyCloud under the 'Internet Registrations' section.
Identity checks represent the information captured to verify the identity of a contact or company. Agents must adhere to anti-money laundering regulations and are required to capture proof of identity and address for their customers. Identity checks can store textual information such as passport number as well as file assets associated as documents (such as scanned copies).
Journal entries indicate that an event has occurred for an associated entity. For example, if a property asking price was changed, this event would be recorded as a timestamped journal entry. Journal entries are used to drive the various activity feeds in our CRM systems.
Landlords represent the details of one or more contacts or companies that wish to rent out a property. Landlords can have a portfolio of any number of properties on the system.
Negotiators represent a member of staff working for an agent. Details about the individual negotiator are captured such as name, job title and email address – as well as the singular office to which they are assigned.
Our metadata system allows you to easily extend the data that our platform supports. Most of our POST and PATCH endpoints provide the ability to attach a JSON document to our entities which will be automatically included in future fetches of that entity.
When using our specific metadata endpoints for more direct, granular control on the data you provide, you can also build new, standalone entities that are specific to your application without needing to hosting your own datastore.
Metadata is specific to a developer and any data that your application sets will not be presented to other developers who build on the Foundations platform. We do not recommend using metadata storage for any sensitive information (personally identifiable details, bank accounts, etc).
Offices represent the details of a branch within an agency. Offices contain information about the office such as manager, contact details and address, though some offices may be virtual and not have a physical address. Each office can contain multiple negotiators.
Properties represent the details of a building that the agent has had an interaction with. Properties include specifics such as the number of rooms, asking price and descriptive marketing details. Properties can be flagged for both sales and lettings marketing concurrently and are associated to a single vendor and/or landlord entity.
Property images represent a picture that has been taken of a property to be used for marketing purposes. Property images are most frequently used for display on portals, agent web sites and for generation of printed materials.
Rest hooks are a loose standard for providing a set of APIs to create a web hook programmatically. If your application uses web hooks, this functionality can help you automate onboarding of customers and remove any manual steps needed in the portal.
Tasks represent details on an action that should be performed by a given date. Tasks are categorised by type and can optionally be related to another entity (for example, a task to remind a negotiator to call a landlord). If no activation date is specified, tasks can be used to send messages to and from negotiators/offices.
Tenancies represent a property lease agreement between a landlord and one or more tenants. The role of the agent during the life-cycle of the tenancy will differ, depending on the agreement with the landlord. The tenancy can be managed from offer submission/arranging stage right through until the tenancy is finished.
Works orders represent one or more maintenance jobs that have been requested for a lettings property. Works orders are usually reported by the landlord or tenant and can be tracked from approval until the work has been completed. Approved works orders are assigned to a company supplier who can then provide estimates and costings for the work.
Last modified 6d ago