Question

Photo of Dan Rye

1

ROCK JSON API

2

Does RockRMS have a JSON API for reading and writing data? If so, is there a set of documentation I can find on this API?

EDIT: I accepted Jon Horton's answer because what I was really looking for was this: http://rock.rocksolidchurchdemo.com/page/244

Clicking through on each of those endpoints gives you the level of detail I was looking for.  Thanks!

  • Nick Airdo

    Nick Airdo

    Dan, thanks for jumping in over here with your question. If you don't mind, be sure to update your profile photo. We really want to build a strong dev community here and seeing faces really helps with the process.

    • Photo of Jon Horton

      4

      I was able to sit in on the REST API session at CITRT, and I was blown away by what's possible with the API.  If you checkout http://rock.rocksolidchurchdemo.com/page/244 on the Rock demo site, it lists all available rest controllers + their URLs. It's super helpful at discovering what data is accessible.

      Further, you can use oData to retrieve nearly any information that you have access to. For instance, to access the Campus API, it would look something like http://rock.rocksolidchurchdemo.com/api/Campus. To filter by a specific campus, you can use oData like: http://rock.rocksolidchurchdemo.com/api/Campus?$filter=LocationId eq 24. You can find more information about oData here: http://www.odata.org/getting-started/basic-tutorial/

      Definitely watch the video about REST that Jim posted—it contains a lot of good information on authenticating, getting started and goes more in depth about oData!

       

       

    • Photo of Jim Michael

      3

      Yes, Rock has a baked-in REST API (vs. one that was hacked on after-the-fact). The official documentation for the API hasn't been released yet, but it will show up here when it's ready. There also might be something about the API out on the Rock Wiki... not sure.

      In the mean time you should check out the videos they shot last week at the CITRT/RefreshCache conference. The one on REST/OData may be useful to you.