Skip to content

User endpoint

Daniel López Guimaraes edited this page Aug 21, 2023 · 7 revisions

Methods

POST user/send_message

This method sends a message from a list of predefined messages to another user. If the message was previously sent to the user, the already existing message will be reordered as the most recent message.

Parameters

Field Notes
id Account ID the message is being sent to.
tI Numeric message type.

Response

Type Field Notes
bool success If the request has been successful.

GET user/favorites

This method looks up the list of favorites of a user. The returned list is limited to 20 entries at a time ordered by newest favorite. If you want to list more, a "next" entry with a timestamp will be provided to get older entries.

Parameters

Field Notes
id Account ID to look up.
s Timestamp to limit the list to entries before this date (defaults to 0).

Response

Type Field Notes
array<UserInfo> items List of users who are liked by the selected user (limited to 20 entries at a time).
string next Optional. Numeric Unix timestamp to look up the missing entries on the list (if none are missing, this is set to 0).
bool ok If the request has been successful.
string count Numeric total count of favorites.

GET user/visitors

This method looks up the list of users that have visited another user with user/visit. The returned list is limited to 20 entries at a time ordered by newest visitor. If you want to list more, a "next" entry with a timestamp will be provided to get older entries.

Parameters

Field Notes
id Account ID to look up.
s Timestamp to limit the list to entries before this date (defaults to 0).

Response

Type Field Notes
array<UserInfo> items List of users who have visited the selected user (limited to 20 entries at a time).
string next Optional. Numeric Unix timestamp to look up the missing entries on the list (if none are missing, this is set to 0).
bool ok If the request has been successful.

GET user/likers

This method looks up the list of likers of a user. The returned list is limited to 20 entries at a time ordered by newest liker. If you want to list more, a "next" entry with a timestamp will be provided to get older entries.

Parameters

Field Notes
id Account ID to look up.
s Timestamp to limit the list to entries before this date (defaults to 0).

Response

Type Field Notes
array<UserInfo> items List of users who have liked the selected user (limited to 20 entries at a time).
string next Optional. Numeric Unix timestamp to look up the missing entries on the list.
bool ok If the request has been successful.
string count Numeric total count of favorites.

POST user/visit

This method registers a visit to the specified user and returns the user's save state for handling the visit.

Parameters

Field Notes
id Account ID to visit.

Response

Type Field Notes
int version Version the last save the user made.
int revision Revision the last save the user made.
string state Object of the current save state of the user as a string.
int i Account ID of the user.
string n Nickname of the user.
string nF Number of favorites of the user.
string nL Number of likers of the user.
int iL Bool telling if the client's account likes the user as an integer.
int lM Bool telling if the user likes the client's account as an integer.
bool success If the request has been successful.

POST user/like

This method registers a like to the specified user from your account.

Parameters

Field Notes
id Account ID to like.

Response

Type Field Notes
bool success If the request has been successful.
int nL Updated number of likes of the user.
int lM Bool telling if the user likes the client's account as an integer.

POST user/unlike

This method unregisters a like to the specified user from your account.

Parameters

Field Notes
id Account ID to unlike.

Response

Type Field Notes
bool success If the request has been successful.
int nL Updated number of likes of the user.
int lM Bool telling if the user likes the client's account as an integer.

GET user/game_sessions

This method looks up the list of game sessions of the client's account. The returned list is divided in "pages" and the number of sessions per page is determined by a parameter set by the client. Although the client hardcodes these parameters to 1 page and 100 sessions per page, the server limits the sessions per page to a maximum of 25.

It's also worth noting that the client creates the parameters wrong, as the game ID and the page number aren't divided properly (notice the missing &):

http://app.pou.me/ajax/user/game_sessions?id=98&g=8p=1&pP=10&_a=1&_c=1&_v=4&_r=256

Instead of:

http://app.pou.me/ajax/user/game_sessions?id=98&g=8&p=1&pP=10&_a=1&_c=1&_v=4&_r=256

Parameters

Field Notes
id Account ID of the client's account.
g Game ID for game sessions.
p Page number.
pP Game sessions per page.

Response

Type Field Notes
array<GameSessionInfo> items List of game sessions limited to the number of sessions per page.
int page Page number.
int perPage Game sessions per page.
bool ok If the request has been successful.
array<Notification> unclaimedNotifications Optional. Unclaimed awards.

POST user/play

This method creates a new game session on the selected game with the provided account ID as an opponent.

Parameters

Field Notes
id Account ID as opponent.
g Game ID.
v Game version? Always 1.

Response

Type Field Notes
int i Game session ID.
int mI Number of my turn.
int t Turn count (starts at 1).
int tO Number of current turn.
int lT Unix timestamp of creation of game session.
bool ok If the request has been successful.
array<Notification> unclaimedNotifications Optional. Unclaimed awards.

GET user/messages

This method looks up the list of messages that have been posted to the specified user. The returned list is limited to 20 entries at a time ordered by newest message. If you want to list more, a "next" entry with a timestamp will be provided to get older entries.

Parameters

Field Notes
id Account ID to look up.
s Timestamp to limit the list to entries before this date (defaults to 0).

Response

Type Field Notes
array<UserMessage> items List of messages to the selected user (limited to 20 entries at a time).
string next Optional. Numeric Unix timestamp to look up the missing entries on the list (if none are missing, this is set to 0).
bool ok If the request has been successful.

Objects

UserMessage

This object stores a message that a user has sent to another.

Type Field Notes
string sI Numeric account ID of sender.
string sN Sender nickname.
string sMinI Object holding the Pou data of the sender as a string.
int tI Message type.