Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Update README.md #2

Merged
merged 1 commit into from almost 2 years ago

2 participants

Bradley Herman Winton Welsh
Bradley Herman
Owner

Added documentation for /api/authenticate/forgot_password

Bradley Herman bradherman Update README.md
Added documentation for /api/authenticate/forgot_password
062d55a
Winton Welsh winton merged commit cc46ad3 into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Sep 14, 2012
Bradley Herman bradherman Update README.md
Added documentation for /api/authenticate/forgot_password
062d55a
This page is out of date. Refresh to see the latest.

Showing 1 changed file with 29 additions and 0 deletions. Show diff stats Hide diff stats

  1. +29 0 README.md
29 README.md
Source Rendered
@@ -18,6 +18,7 @@ Table of Contents
18 18 * [POST /api/authenticate/login.json](#authenticate_login_post)
19 19 * [GET /api/authenticate/logout.json](#authenticate_logout)
20 20 * [GET /api/authenticate/signup](#authenticate_signup)
  21 +* [POST /api/authenticate/forgot_password](#authenticate_forgot_password)
21 22 * [GET /api/front/lead_articles.json](#front_lead_articles)
22 23 * [GET /api/front/v2/lead_articles.json](#front_lead_articles_v2)
23 24 * [GET /api/geolocation/teams.json](#geolocation_teams)
@@ -163,6 +164,34 @@ http://bleacherreport.com/api/authenticate/signup?redirect_url=http://bleacherre
163 164 A `redirect_url` parameter is mandatory. B/R will redirect the request back to that URL, passing basic information
164 165 from the <a href="#user_user">User API</a> as GET parameters.
165 166
  167 +<a name="authenticate_forgot_password"></a>
  168 +
  169 +POST /api/authenticate/forgot_password
  170 +----------------------------
  171 +
  172 +### Parameters
  173 +
  174 +* email
  175 +* redirect_url (optional)
  176 +* format (optional) - json or not
  177 +
  178 +### Returns
  179 +
  180 +Either json of success/error, html status of 200 or 404 (for ajax), or redirect.
  181 +
  182 +### HTTP Example
  183 +
  184 +<pre>
  185 +http://bleacherreport.com/api/authenticate/forgot_password.json?email=bherman@bleacherreport.com
  186 +</pre>
  187 +
  188 +### Paramter Info
  189 +
  190 +Email parameter is mandatory.
  191 +
  192 +If requesting json, redirect_url will be ignored. If non-json and redirect_url, the request will be treated as html and redirect to the specified url.
  193 +If no params, it will be treated as an html request, but only return a status code of 200 for success or 404 for error (which could be an inability to find the email or any other error).
  194 +
166 195 <a name="front_lead_articles"></a>
167 196
168 197 GET /api/front/lead_articles.json

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.