simplyrets / docs.simplyrets.com Goto Github PK

There are few things you can do when you're having trouble tracking down a listing the API:

1. Verify the listing's property type and status
   • You may need to modify the default search parameters
2. Ensure the listing does not have any IDX restrictions
   • You can check this directly in the MLS system, or by searching for the listing online (see step 3).
3. Check that the listing shows on Realtor.com
   • We usually have good parity with Realtor.com and Redfin.com. Any other site is not as reliable.

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:

• Getting your WebAPI credentials from Bridge
• Getting your WebAPI credentials from MLS Grid
• Connecting them to SimplyRETS
• ...etc

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):

• https://help.github.com

Mostly a placeholder issue so I can keep track of a couple of things that need to be moved over:

• Index page content
  We can find a better place for the "static" docs and curl example
• Swagger UI docs
• WordPress plugin style guide
  Maybe move this to the WordPress documentation site.

This would be a really good one. There's a few basic troubleshooting steps that can be done:

1. Find a listing by that agent or office.
2. Query for it in the API, and look at the agent.id or office.brokerid field

Once 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.