-
Notifications
You must be signed in to change notification settings - Fork 5
verify_user.json
Timothy Duffy edited this page Apr 5, 2015
·
3 revisions
###verify_user.json###
This end point is used when a client wants to become 'verified' within the yellr system. This matches a name and email address with the client id. This is a HTTP POST end point.
verify_user.json?cuid=<client_id>&language_code=<language_code>&lat=<lat>&lng=<lng>
The following fields are required:
[GET]
client_id:
This is of type text, and is the unique id of the client. This is a uuid that is generated by the
client and is associated with a user within the database. Event if a user is 'validated' their
unique client_id is still used to identify them.
[GET]
language_code:
This is of type text, and holds the two letter language code the post is in. Language codes must
match those codes that exist within the languages table within the database. Valid values currently
are:
en - English
es - Español
Note: If responding to an assignment, the response post should have the same language code as the
question being asked.
[GET]
lat:
This is the latitude of the user. 43.1656 is an example.
[GET]
lng
This is the longitude of the user. -77.6114 is an example.
[POST]
username
This is a unique username the user uses to login with
[POST]
password
This is the sha256 of the users password.
[POST]
first_name
The users first name
[POST]
last_name
The users last name
[POST]
email [optional]
The users email address
A response looks like:
{
"verfied_user_id": 33,
"success": true
}
An error would look like:
{
"error_text": "Username, email, and/or client ID already registered",
"success": false
}