Home

Documentation for the Back End Resources for Ally Guide.

Usage

• Endpoints resources location on Side Bar. Brief details about usage are below.

Amplify	/api/amplify
Representatives	Returns list of Representatives based on Zip Code parameter

Campaign	/api/campaign
Individual Campaign	Returns a single campaign object based on a parameter
Campaigns	Returns list of Campaigns
POST	Provides ability to integrate and submit data to database

This is the letters uploaded in Lob per campaign

Letter_Versions	/api/letter_versions
Individual Letter	Returns a single Letter object based on a parameter
POST	Provides ability to integrate and submit data to the letter_versions database
GET	Provides ability to retrieve data from letter_versions database. For ex, display_letter uses it to return a Lob html object

This is the table for volunteer users:

Volunteers	/api/volunteers
Individual volunteer	End user that sends campaign letters by name and address
POST	Record letters sent by template_id