Developer Tools: API
Widget
Highlighter - Beta
API
Application Programming Interface (API)
Users
You may access your user account (and associated resources) via the ABS API. Users have many tags and notes.
List
No list actions are available for the User resource. You may only access show actions for your own user account.
Show
GET /user.xml
Returns your user resource.
Example:
Request
GET https://biblesearch.americanbible.org/user.xmlResponse
<?xml version="1.0" encoding="utf-8"?>
<users>
<user id="12">
<id>12</id>
<username><![CDATA[joe@example.com]]></username>
<first_name><![CDATA[Joe]]></first_name>
<middle_initial><![CDATA[]]></middle_initial>
<last_name><![CDATA[Sixpack]]></last_name>
<nickname><![CDATA[]]></nickname>
<address><![CDATA[]]></address>
<address2><![CDATA[]]></address2>
<city><![CDATA[]]></city>
<state_id>0</state_id>
<zip><![CDATA[]]></zip>
<country_id>0</country_id>
</user>
</users>
Create
No create action is available for the User resource. (Users must be created by signing up for ABS BibleSearch via the website.)
Update
PUT /user.xml
Update your user account with content of the submitted XML.
Example:
Request
PUT https://biblesearch.americanbible.org/user.xmlContent-Type
application/xmlBody
<user>
<first_name>Joseph</first_name>
<middle_initial>T</middle_initial>
</user>
Response
<?xml version="1.0" encoding="utf-8"?>
<users>
<user id='12'>
<id>12</id>
<username><![CDATA[joe@example.com]]></username>
<first_name><![CDATA[Joseph]]></first_name>
<middle_initial><![CDATA[T]]></middle_initial>
<last_name><![CDATA[Sixpack]]></last_name>
<nickname><![CDATA[]]></nickname>
<address><![CDATA[]]></address>
<address2><![CDATA[]]></address2>
<city><![CDATA[]]></city>
<state_id>0</state_id>
<zip><![CDATA[]]></zip>
<country_id>0</country_id>
</user>
</users>
Delete
No delete action is available for the User resource. (Users must be deleted by canceling your account via the ABS BibleSearch website.)