User
User object
Properties
id
string
Unique ID of the user
name
string
Name of the user
string
User email address
permissions
[String]
An array of strings defining what the user has permissions to.
Create Password
POST /user/:userId/key/:userKey
Create password for user to activate the account.
Request Body
password
string
New user password
confirmPassword
string
Confirmation password
Response Body
success
true
Always '{success: true}' if no error
Get Token
POST /user/token
Retrieve token for user authorization
Request Body
string
User email address
password
string
User password
Response Body
token
string
JWT for user authorization
Get User
GET /user
User Authorization Required
Retrieve data for a single user
Response Body
Album
User album containing a grouping of photos
Properties
name
string
Name of the album
user
string
ID of the user to which the album belongs
description
string
A description of the album
photos
[object]
An array of objects that contain data for album photographs
photos.file
string
File name of the file for lookup
photos.description
string
Description of the photo
photos.created
date
Date/Time photo was added to album
created
date
Date/Time album was created
Get Albums
GET /album/:userId
Get all albums for a specific user
Response Body
Create Album
POST /album
User Auth Required
Create a new user album
Request Body
name
string
Name for the album
description
string (optional)
Optional description of the album
Response Body
Update Album
PUT /album/:albumId
User Auth Required (Album)
Update an album name or description
Request Body
name
String (optional)
New name for the album
description
String (optional)
New description for the album
Response Body
Delete Album
DELETE /album/:albumId
User Auth Required (Album)
Delete an album and all of its photos
Response Body
success
true
Always '{success: true}' if no error.
Add Images
POST /album/:albumId/image
User Auth Required (Album)
Add one or more images to an album. Requires Multipart Form
Request Body
images
File or [File]
One or more files to upload
Response Body
Delete Image
DELETE /album/:albumId/image/:imageId
User Auth Required (Album)
Remove an image from an album
Response Body
Update Image
PUT /album/:albumId/image/:imageId
User Auth Required (Album)
Update the description on a single image.
Request Body
description
String
The description to add/update to the image.