Developer Tools: API

This documentation describes version 1 of the API, which is deprecated. The functionality on this page has been removed in version 2 of the API.

Application Programming Interface (API)

Notes

Notes are annotations you apply to selected Bible verses. Notes belong to users. All notes retrieved via API will also include the verse references to which they refer.

List

GET /user/notes.xml

Returns all of your notes.

Example:

Request
XML
JSON
GET https://cy.bibles.org/user/notes.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="175">
    <id>175</id>
    <user_id>1470</user_id>
    <title><![CDATA[A Note]]></title>
    <content><![CDATA[This passage is noteworthy.]]></content>
    <public>0</public>
    <created_at>Thu, 05 Jan 2012 17:14:46 -0600</created_at>
    <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
    <moderated/>
    <references>
      <reference>
        <start>GNT:Gen.1.4</start>
        <end>GNT:Gen.1.4</end>
        <created_at>Thu, 05 Jan 2012 17:14:46 -0600</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
      <reference>
        <start>GNT:Gen.1.6</start>
        <end>GNT:Gen.1.6</end>
        <created_at>Fri, 04 May 2012 11:47:23 -0500</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
      <reference>
        <start>GNT:Gen.1.9</start>
        <end>GNT:Gen.1.9</end>
        <created_at>Fri, 04 May 2012 11:47:23 -0500</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
    </references>
  </note>
  <note id="199">
    <id>199</id>
    <user_id>1470</user_id>
    <title><![CDATA[A very interesting note]]></title>
    <content><![CDATA[A note! How interesting!]]></content>
    <public>0</public>
    <created_at>Mon, 28 May 2012 10:21:47 -0500</created_at>
    <updated_at>Mon, 28 May 2012 10:21:47 -0500</updated_at>
    <moderated/>
    <references>
      <reference>
        <start>GNT:Gen.1.13</start>
        <end>GNT:Gen.1.13</end>
        <created_at>Mon, 28 May 2012 10:21:47 -0500</created_at>
        <updated_at>Mon, 28 May 2012 10:21:47 -0500</updated_at>
      </reference>
    </references>
  </note>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('506dabfe8c8f72.42768042');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=506dabfe8c8f72.42768042" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>506dabfe8c8f72.42768042</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('506dabfe8c8f72.42768042'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=506dabfe8c8f72.42768042" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</notes>

Show

GET /notes/#{note_id}.xml

Returns your note identified by the specified ID. The note id is a number that uniquely identifies a note and can be found by listing all notes for a user.

Example:

Request
XML
JSON
GET https://cy.bibles.org/notes/175.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="175">
    <id>175</id>
    <user_id>1470</user_id>
    <title><![CDATA[A very interesting note]]></title>
    <content><![CDATA[A note! How interesting!]]></content>
    <public>0</public>
    <created_at>Thu, 05 Jan 2012 17:14:46 -0600</created_at>
    <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
    <moderated/>
    <references>
      <reference>
        <start>GNT:Gen.1.4</start>
        <end>GNT:Gen.1.4</end>
        <created_at>Thu, 05 Jan 2012 17:14:46 -0600</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
      <reference>
        <start>GNT:Gen.1.6</start>
        <end>GNT:Gen.1.6</end>
        <created_at>Fri, 04 May 2012 11:47:23 -0500</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
      <reference>
        <start>GNT:Gen.1.9</start>
        <end>GNT:Gen.1.9</end>
        <created_at>Fri, 04 May 2012 11:47:23 -0500</created_at>
        <updated_at>Fri, 11 May 2012 12:06:17 -0500</updated_at>
      </reference>
    </references>
  </note>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('506db0d1bf9c29.88928912');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=506db0d1bf9c29.88928912" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>506db0d1bf9c29.88928912</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('506db0d1bf9c29.88928912'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=506db0d1bf9c29.88928912" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</notes>

Create

POST /notes.xml

Creates a note resource for the verse reference you pass to it in the body of your XML request.

The verse references must have both a start and an end node, each representing a verse id marking the start and end of the passage you would like to tag. To tag a single verse, submit the same verse id as both the start and end values.

Example:

Request
XML
JSON
POST https://cy.bibles.org/notes.xml
Content-Type
application/xml
Body
<note>
  <title>Some Title</title>
  <content>Some body text.</content>
  <references>
    <reference>
      <start>GNT:Acts.8.34</start>
      <end>GNT:Acts.8.36</end>
    </reference>
  </references>
</note>
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="206">
    <id>206</id>
    <user_id>1470</user_id>
    <title><![CDATA[Some Title]]></title>
    <content><![CDATA[Some body text.]]></content>
    <public>0</public>
    <created_at>Wed, 12 Sep 2012 12:39:15 -0500</created_at>
    <updated_at>Wed, 12 Sep 2012 12:39:15 -0500</updated_at>
    <moderated/>
    <references>
      <reference>
        <start>GNT:Acts.8.34</start>
        <end>GNT:Acts.8.36</end>
        <created_at>Wed, 12 Sep 2012 12:39:15 -0500</created_at>
        <updated_at>Wed, 12 Sep 2012 12:39:15 -0500</updated_at>
      </reference>
    </references>
  </note>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('5050c8c37469f6.05429140');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5050c8c37469f6.05429140" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>5050c8c37469f6.05429140</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('5050c8c37469f6.05429140'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5050c8c37469f6.05429140" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</notes>

Update

PUT /notes/#{note_id}.xml

Updates the note identified by the specified ID, with content of the submitted XML. The note ID is a number and is returned when a note is listed.

Example:

Request
XML
JSON
PUT https://cy.bibles.org/notes/206.xml
Content-Type
application/xml
Body
<note>
  <title>New Title</title>
  <content>New body text.</content>
  <references>
    <reference>
      <start>GNT:Acts.8.34</start>
      <end>GNT:Acts.8.36</end>
    </reference>
  </references>
</note>
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="206">
    <id>206</id>
    <user_id>1470</user_id>
    <title><![CDATA[New Title]]></title>
    <content><![CDATA[New body text.]]></content>
    <public>0</public>
    <created_at>Wed, 12 Sep 2012 12:39:15 -0500</created_at>
    <updated_at>Wed, 12 Sep 2012 12:49:29 -0500</updated_at>
    <moderated/>
    <references>
      <reference>
        <start>GNT:Acts.8.34</start>
        <end>GNT:Acts.8.36</end>
        <created_at>Wed, 12 Sep 2012 12:39:15 -0500</created_at>
        <updated_at>Wed, 12 Sep 2012 12:49:29 -0500</updated_at>
      </reference>
    </references>
  </note>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('5050cb29afc3d9.34378299');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5050cb29afc3d9.34378299" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>5050cb29afc3d9.34378299</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('5050cb29afc3d9.34378299'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5050cb29afc3d9.34378299" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</notes>

Delete

DELETE /notes/#{note_id}.xml

Deletes the note identified by the specified ID. The note ID is a number and is returned when a note is listed.

Example:

Request
XML
JSON
DELETE https://cy.bibles.org/notes/12.xml
Response
[Empty response body]

Note: The content-type header is not needed for DELETE requests, since you are not sending any XML to the ABS API.