REST API

The Rest API for Ryandw11 Images.

The API returns ImageObjects and UserObjects.

Ping

GET https://img.ryandw11.com/api/v1/ping

Check if the Ryandw11 Images service is online.

200: OK Pong

pong

Get Images

GET https://img.ryandw11.com/api/v1/images

Get a list of images from Ryandw11 Images. Note: Not all images are obtained at once. A page system is used to restrict the amount of data at once. The default amount of images per page is 30, but you can obtain up to 100 at a time.

Query Parameters

Name	Type	Description
imgCount	number	The number of images to obtain. (Default 30)
pge	number	The current page for images. (Default 1)
title	string	Only get images that match the provided titles.

200 This returns the following if successful:

{
    "error": false,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalImageCount": number,
    "images": [ImageObject]
}

400 An error was discovered in your request.

{
    "error": true, 
    "error_message": String, 
    "images": []
}

User Images

GET https://img.ryandw11.com/api/v1/images/:user

Get the images for a certain user. (Note: Unlisted images cannot be obtained).

Path Parameters

Name	Type	Description
user	string	The UUID of the user to obtain images for.

Query Parameters

Name	Type	Description
imgCount	string	The number of images to obtain. (Default 30)
title	string	Only get images that match the provided titles.
pge	number	The page number of the page of images.

200 Returns the following if successful:

{
    "error": false,
    "uuid": String,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalImageCount": number,
    "images": [ImageObject]
}

400 An error was discovered in your request.

{
    "error": true, 
    "error_message": String, 
    "images": []
}

Get Users

GET https://img.ryandw11.com/api/v1/users

Get a list of users. Like the images, this is a paged list. Note: Admin users will not be returned.

Query Parameters

Name	Type	Description
userCount	number	The number of users to display per page. (Default 30)
username	string	Display users that match the username requirement.
pge	number	The page number for the users.

200 Returns the following if successful:

{
    "error": false,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalUserCount": number,
    "users": [UserObject]
}

400 An error was discovered in your request.

{
    "error": true, 
    "error_message": String, 
    "users": []
}