-
Notifications
You must be signed in to change notification settings - Fork 3
API Users
Brandon Spears edited this page Jun 20, 2019
·
1 revision
Method | URL (https://scholar.uc.edu) | Description |
---|---|---|
GET | /api/users/email (.json) |
Return user. |
PATCH | /api/users/email (.json) |
Update user. |
POST | /api/users | Create user. |
The email
field in the URL must replace the "." with "-dot-". Do not do this when it is passed as a parameter via JSON. For example example@mail-dot-com
.
Field | Required | Notes |
---|---|---|
always | When the email is in the URL, you must replace the "." with "-dot-". This is not allowed when it is passed as a parameter. The email must not be in use by our application in order to create a new user with that email. | |
first_name | For creating | |
last_name | For creating | |
password | For creating | This field is only available when creating a new user |
department | For creating | |
facebook_handle | no | |
twitter_handle | no | |
googleplus_handle | no | |
title | no | |
website | no | |
telephone | no | |
alternate_phone_number | no | |
blog | no | |
alternate_email | no | |
linkedin_handle | no | |
ucdepartment | no | This field expects the first part to be the college designation (see config/college_and_department.yml), and the second part to be the department (can be multiple words) |
None of the fields for users are multi-valued