simplyrets / docs.simplyrets.com Goto Github PK
View Code? Open in Web Editor NEW:robot: A RESTful API and WordPress plugin for powering your website with data from your MLS.
Home Page: https://docs.simplyrets.com
:robot: A RESTful API and WordPress plugin for powering your website with data from your MLS.
Home Page: https://docs.simplyrets.com
There are few things you can do when you're having trouble tracking down a listing the API:
In the title -- write a help topic on the sort options.
Primarily noting that listings are sorted by the .modified
timestamp by default.
Now that SimplyRETS supports RESO Web API feeds, we should add a help topic or two to the documentation site for things like:
These could all likely be in one help topic, but we may split them up if the length warrants it.
I just want to run this by the team, before I jump in and start adding a bunch. All of the existing pages will be pretty much the same on the new documentation site.
One that's up, we'll start adding "help topics". These are small, bite-size, articles about common questions/issues/etc using the API.
We'll put them in a folder called topics/
, and they will just be short posts about things like this:
https://docs.simplyrets.com/topics/paginating-api-responses-with-lastid
https://docs.simplyrets.com/topics/using-sort-options-with-the-SimplyRETS-API
Pretty much like this (except we won't have as many, and they will be at the bottom of the rest of the page):
Mostly a placeholder issue so I can keep track of a couple of things that need to be moved over:
curl
exampleThis would be a really good one. There's a few basic troubleshooting steps that can be done:
agent.id
or office.brokerid
fieldOnce you have an ID, you can use it in the agents
or office
parameter.
I started with minima because it has a lot of options for nav/footer links, and obviously blog posts.
Here's what it looks like right now (I disabled GH pages -- if you test it be sure to disable it afterwards until we are ready to move over so it doesn't get indexed by Google):
I'll run with this a little longer unless there are any objections.
The MLS's commonly use http://
protocol's on their images (even though they, but many user's sites run on https://
, which causes warnings in the console, and overall compromises security via https://
.
We can add a help topic for WordPress users to show them how to rewrite http://
links from the MLS to be https://
.
There needs to be a disclaimer that, your MLS may not have https support.
Add a help topic on using the lastId
parameter to paginate in the API.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.