Provides some simple methods to manipulate users' addresses and preferred SMS numbers.
Each endpoint is authenticated using an Alma JWT passed as the jwt
query parameter.
Method | Path | Description | Notes |
---|---|---|---|
GET | / | Returns the user's Home and Alternative addresses |
|
PUT | / | Adds or updates the user's Alternative address and makes it the preferred address |
Address data is passed in the body |
DELETE | / | Removes the user's Alternative address and makes the Home address the preferred address |
|
GET | /sms | Returns the user's preferred SMS number, or null if they have not set one | |
PUT | /sms | Adds or updates the user's preferred SMS number | Number is passed as the sms query parameter |
DELETE | /sms | Removes the preferred SMS flag from the user's phone numbers |
Copyright University of Pittsburgh.
Freely licensed for reuse under the MIT License.