American Bible Society

DONATE NOW

Switch to mobile version

Back to BibleSearch

Developer Tools: API

Widget

Highlighter - Beta

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
GET https://biblesearch.americanbible.org/user/notes.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="132">
    <id>132</id>
    <user_id>12</user_id>
    <title><![CDATA[A note]]></title>
    <content><![CDATA[This passage is noteworthy.]]></content>
    <public>0</public>
    <created_at>2010-10-26 15:11:34</created_at>
    <updated_at>2010-10-26 15:11:34</updated_at>
    <moderated />
    <references>
      <reference>
        <start>KJV:John.1.10</start>
        <end>KJV:John.1.10</end>
      </reference>
    </references>
  </note>
  <note id="175">
    <id>175</id>
    <user_id>12</user_id>
    <title><![CDATA[A very interesting note]]></title>
    <content><![CDATA[A note! How interesting!]]></content>
    <public>0</public>
    <created_at>2010-10-26 16:21:13</created_at>
    <updated_at>2010-10-26 16:21:13</updated_at>
    <moderated />
    <references>
      <reference>
        <start>KJV:1Chr.1.35</start>
        <end>KJV:1Chr.1.35</end>
      </reference>
    </references>
  </note>
</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
GET https://biblesearch.americanbible.org/notes/175.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<notes>
  <note id="175">
    <id>175</id>
    <user_id>12</user_id>
    <title><![CDATA[A very interesting note]]></title>
    <content><![CDATA[A note! How interesting!]]></content>
    <public>0</public>
    <created_at>2010-10-26 16:21:13</created_at>
    <updated_at>2010-10-26 16:21:13</updated_at>
    <moderated />
    <references>
      <reference>
        <start>KJV:1Chr.1.35</start>
        <end>KJV:1Chr.1.35</end>
      </reference>
    </references>
  </note>
</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
POST https://biblesearch.americanbible.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='185'>
    <id>185</id>
    <user_id>12</user_id>
    <title><![CDATA[Some Title]]></title>
    <content><![CDATA[Some body text.]]></content>
    <public>0</public>
    <created_at>2010-11-01 16:00:23</created_at>
    <updated_at>2010-11-01 16:00:23</updated_at>
    <moderated></moderated>
    <references>
      <reference>
        <start>GNT:Acts.8.34</start>
        <end>GNT:Acts.8.36</end>
      </reference>
    </references>
  </note>
</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
PUT https://biblesearch.americanbible.org/notes/185.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='185'>
    <id>185</id>
    <user_id>12</user_id>
    <title><![CDATA[New Title]]></title>
    <content><![CDATA[New body text.]]></content>
    <public>0</public>
    <created_at>2010-11-01 16:00:23</created_at>
    <updated_at>2010-11-01 16:04:27</updated_at>
    <moderated></moderated>
    <references>
      <reference>
        <start>GNT:Acts.8.34</start>
        <end>GNT:Acts.8.36</end>
      </reference>
    </references>
  </note>
</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
DELETE https://biblesearch.americanbible.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.