Return Structs

Used to return a newly created sub-account’s ID and username.

Returned by: POST /api/v3/user/add

See UserController.addHandler(_:data:).

An announcement to display to all users.

Returned by:

• GET /api/v3/notification/announcements
• GET /api/v3/notification/announcement/ID for admins/THO only.

Used to obtain a list of board games.

Each year there’s a list of boardgames published that’ll be brought onboard for the games library. The board game data is produced by running a script that pulls game data from http://boardgamegeek.com‘s API and merging it with the games library table.

Games in the library may not match anything in BGG’s database (or we can’t find a match), so all the BGG fields are optional.

Returned by:

• GET /api/v3/boardgames (inside BoardgameResponseData)
• GET /api/v3/boardgames/:boardgameID
• GET /api/v3/boardgames/expansions/:boardgameID

See BoardgameController.getBoardgames(_:), BoardgameController.getExpansions(_:).

Wraps an array of BoardgameData with info needed to paginate the result set.

Returned by:

• GET /api/v3/boardgames

Used to return the ID and title of a Category.

Returned by:

• GET /api/v3/forum/categories
• GET /api/v3/forum/catgories/ID

See ForumController.categoriesHandler(_:)

Used to return a newly created account’s ID, username and recovery key.

Returned by: POST /api/v3/user/create

See UserController.createHandler(_:data:).

Used to obtain the current user’s ID, username and logged-in status.

Returned by: GET /api/v3/user/whoami

See UserController.whoamiHandler(_:).

Used to obtain an event’s details.

Returned by:

• GET /api/v3/events
• GET /api/v3/events/favorites

See EventController.eventsHandler(_:), EventController.favoritesHandler(_:).

Used to return a FriendlyFez‘s data.

Returned by these methods, with members set to nil.

• POST /api/v3/fez/ID/join
• POST /api/v3/fez/ID/unjoin
• GET /api/v3/fez/joined
• GET /api/v3/fez/open
• GET /api/v3/fez/owner
• POST /api/v3/fez/ID/user/ID/add
• POST /api/v3/fez/ID/user/ID/remove
• POST /api/v3/fez/ID/cancel

Returned by these methods, with members populated.

• GET /api/v3/fez/ID
• POST /api/v3/fez/create
• POST /api/v3/fez/ID/post
• POST /api/v3/fex/ID/post/ID/delete See FezController.createHandler(_:data:), FezController.joinHandler(_:), FezController.unjoinHandler(_:), FezController.joinedHandler(_:) FezController.openhandler(_:), FezController.ownerHandler(_:), FezController.userAddHandler(_:), FezController.userRemoveHandler(_:), FezController.cancelHandler(_:).

Used to return a FezPost‘s data.

Returned by:

• GET /api/v3/fez/ID
• POST /api/v3/fez/ID/post
• POST /api/v3/fez/ID/post/ID/delete

See: FezController.fezHandler(_:), FezController.postAddHandler(_:data:), FezController.postDeleteHandler(_:).

Used to return the contents of a Forum.

Returned by:

• POST /api/v3/forum/categories/ID/create
• GET /api/v3/forum/ID
• GET /api/v3/events/ID/forum

See ForumController.forumCreateHandler(_:data:), ForumController.forumHandler(_:), EventController.eventForumHandler(_:).

Used to return the ID, title and status of a Forum.

Returned by:

• GET /api/v3/forum/categories/ID
• GET /api/v3/forum/owner
• GET /api/v3/user/forums
• GET /api/v3/forum/favorites

See ForumController.categoryForumsHandler(_:), ForumController.ownerHandler(_:), ForumController.forumMatchHandler(_:), `ForumController.favoritesHandler(_:).

Used to obtain the contents of a UserNote for display in a non-profile-viewing context.

Returned by:

• GET /api/v3/user/notes
• GET /api/v3/users/ID/note
• POST /api/v3/user/note

See UserController.notesHandler(_:), UserController.noteHandler(_:data:).

Used to return a ForumPost‘s data.

Returned by:

• POST /api/v3/forum/ID/create
• POST /api/v3/forum/post/ID/update
• POST /api/v3/forum/post/ID/image
• POST /api/v3/forum/post/ID/image/remove
• GET /api/v3/forum/ID/search/STRING
• GET /api/v3/forum/post/search/STRING
• POST /api/v3/forum/post/ID/laugh
• POST /api/v3/forum/post/ID/like
• POST /api/v3/forum/post/ID/love
• POST /api/v3/forum/post/ID/unreact
• GET /api/v3/forum/bookmarks
• GET /api/v3/forum/likes
• GET /api/v3/forum/mentions
• GET /api/v3/forum/posts
• GET /api/v3/forum/post/hashtag/#STRING

See ForumController.postCreateHandler(_:data:), ForumController.postUpdateHandler(_:data:), ForumController.imageHandler(_:data:), ForumController.imageRemoveHandler(_:), ForumController.forumSearchHandler(_:), ForumController.postSearchHandler(_:) ForumController.postLaughHandler(_:), ForumController.postLikeHandler(_:) ForumController.postLoveHandler(_:), ForumController.postUnreactHandler(_:), ForumController.bookmarksHandler(_:), ForumCOntroller.likesHandler(_:), ForumController.mentionsHandler(_:), ForumController.postsHandler(_:), ForumController.postHashtagHandler(_:).

Used to return a ForumPost‘s data with full user LikeType info.

Returned by: GET /api/v3/forum/post/ID

See ForumController.postHandler(_:).

Used to return a user’s public profile contents. For viewing/editing a user’s own profile, see UserProfileData.

Returned by: GET /api/v3/users/ID/profile

See UsersController.profileHandler(_:).

Used to return a token string for use in HTTP Bearer Authentication.

Clients can use the userID field to validate the user that logged in matches the user they thiought was logging in. This guards against a situation where one user changes their username to the previous username value of another user. A client using /client/user/updates/since could end up associating a login with the wrong User because they were matching on username instead of userID. That is, a user picks a username and logs in with their own password. Their client has a (out of date) stored User record, for a different user, that had the same username.

Returned by:

• POST /api/v3/auth/login
• POST /api/v3/auth/recovery

See AuthController.loginHandler(_:) and AuthController.recoveryHandler(_:data:).

Used to return a Twarrt‘s data.

Returned by:

• POST /api/v3/twitarr/create
• POST /api/v3/twitarr/ID/update
• POST /api/v3/twitarr/ID/image
• POST /api/v3/twitarr/ID/image/remove
• POST /api/v3/twitarr/ID/laugh
• POST /api/v3/twitarr/ID/like
• POST /api/v3/twitarr/ID/love
• POST /api/v3/twitarr/ID/unreact
• POST /api/v3/twitarr/ID/reply
• GET /api/v3/twitarr/bookmarks
• GET /api/v3/twitarr/likes
• GET /api/v3/twitarr/mentions
• GET /api/v3/twitarr/
• GET /api/v3/twitarr/barrel/ID
• GET /api/v3/twitarr/hashtag/#STRING
• GET /api/v3/twitarr/search/STRING
• GET /api/v3/twitarr/user
• GET /api/v3/twitarr/user/ID

See TwitarrController.twarrtCreateHandler(_:data:), TwitarrController.twarrtUpdateHandler(_:data:) TwitarrController. imageHandler(_:data:), TwitarrController.imageRemoveHandler(_:) TwitarrController.twarrtLaughHandler(_:), TwitarrController.twarrtLikeHandler(_:), TwitarrController.twarrtLoveHandler(_:), TwitarrController.twarrtUnreactHandler(_:), TwitarrController.replyHandler(_:data:), TwitarrController.bookmarksHandler(_:), TwitarrController.likesHandler(_:), TwitarrController.mentionsHandler(_:), TwitarrController.twarrtsHandler(_:), TwitarrController.twarrtsBarrelHandler(_:), TwitarrController.twarrtsHashtagHandler(_:), TwitarrController.twarrtsSearchHandler(_:), TwitarrController.twarrtsUserHandler(_:), TwitarrController.userHandler(_:).

Used to return a Twarrt‘s data with full user LikeType info.

Returned by: GET /api/v3/twitarr/ID

See TwitarrController.twarrtHandler(_:).

Used to obtain a user’s current header information (name and image) for attributed content.

Returned by:

• GET /api/v3/users/ID/header
• GET /api/v3/client/user/headers/since/DATE

See UsersController.headerHandler(_:), ClientController.userHeadersHandler(_:).

Used to broad search for a user based on any of their name fields.

Returned by:

• GET /api/v3/users/match/allnames/STRING
• GET /api/v3/client/usersearch

See UsersController.matchAllNamesHandler(_:), ClientController.userSearchHandler(_:).