Documentation


Using the API

To access the API, you must first sign up for an account to the database. You will receive an API key to log in and receive a JSON Web Token for API sessions.

Methods Parameters
login email*
password*
search_address first_name
last_name
title
support_type
campus
area (name of the area)
method (name of the method)
tool (name of the tool)
tool_type
search_person first_name
last_name
title
support_type
campus
area (name of the area)
method (name of the method)
tool (name of the tool)
get_person/[public_id]
add_person** first_name*
last_name*
title
pronouns
email*
web_address
phone*
scheduler_address
preferred_contact*
support_type*
bio
notes
delete_person*** email*
add_area** name*
update_area** name*
new_name
delete_area*** name*
search_area name*
get_area/[area_id]
add_method** name*
update_method** name*, new_name*
delete_method*** name*
search_method name*
get_method/[method_id]
add_tool** name*
type*
web_address
update_tool** name*
new_name
new_type
web_address
delete_tool*** area_name*
search_tool tool_name*
get_tool/[tool_id]
add_resource** name*
type*
web_address
update_resource** name*
new_name
new_type
web_address
delete_resource*** name*
search_resource name*
get_resource/[resource_id]
* required parameter
** requires authorization
*** requires special permission