gameId

That parameters describe game that we are interested in

roomId

Room number

short

Data returned by that function can be either in short of long form

access

If set we use access field from room configuration – when admins check is not checked only requests with valid access code will get extra data about admins in the room

That function returns eg, for query room_info_players(game27,0,0)

room_info_players =
        {
                ret = 1
                count = 1
                tbl =
                {
                        0 =
                        {
                                name = wwylon1972
                                state = 0
                        }
                }
        }

And for for query: action= room_info_players(game27,0,1)

 room_info_players =
        {
                ret = 1
                count = 1
                tbl = 0 wwylon1972
        }

player

Login of player

gameId

That parameters describe game that we are interested in

ranking

Set tit to 1 to get ranking change

ladder

Set tit to 1 to get ladder change

short

Short format of returned ranking/ladder date

That function returns eg, for query room_info_players(game27,0,0)

player_results =
        {
                ret = 1
                tbl =
                {
                        RF =
                        {
                                desc = Rating
                                val = 0
                        }
                        games_completed =
                        {
                                desc = Games Completed
                                val = 0
                        }
                        games_abandoned =
                        {
                                desc = Games Abandoned
                                val = 0
                        }
                        wins =
                        {
                                desc = Wins
                                val = 0
                        }
                        loses =
                        {
                                desc = Loses
                                val = 0
                        }
                        streak =
                        {
                                desc = Streak
                                val = 0
                        }
                        max_break =
                        {
                                desc = Max Break
                                val = 0
                        }
                }
                ranking_count = 9
                ranking = 5034|5049|4987|4974|4961|4948|4948|4961|4948
                ladder_count = 9
                ladder = 3|3|3|3|3|3|3|2|3

player

Login of player

gameId

That parameters describe game that we are interested in

start

Start from that position

count

Get so much fields

That function returns eg, for player_archive(Object,game27,0,3)

player_archive =
        {
                ret = 1
                count = 3
                tbl =
                {
                        0 =
                        {
                                date_end = 2004-01-24 22:29:37
                                game_time = 14
                                login = Object;samuel
                                winner = 0;1
                                rating = 0;0
                                ladder = 0;0
                                rated_game = 0
                                end_mode = resign
                                max_break = 0;0
                                old_rating = 0;0
                                old_ladder = 0;0
                        }
                        1 =
                        {
                                date_end = 2004-01-24 22:26:47
                                game_time = 71
                                login = Object;bromba
                                winner = 0;1
                                rating = 0;0
                                ladder = 0;0
                                rated_game = 0
                                end_mode = resign
                                max_break = 0;1
                                old_rating = 0;0
                                old_ladder = 0;0
                        }
                        2 =
                        {
                                date_end = 2004-01-09 11:55:22
                                game_time = 124
                                login = Besti;Object
                                winner = 1;0
                                rating = 0;0
                                ladder = 0;0
                                rated_game = 0
                                end_mode = disconnect
                                max_break = 0;0
                                old_rating = 0;0
                                old_ladder = 0;0
                        }
                }
        }

player

Login of player

gameId

That parameters describe game that we are interested in

sort

How should we sort results

start

Start from that position

count

Get so much fields

opponent

Name of the opponent that we look for

That function returns eg, for player_opponents(Object,game22,,0,10)

player_opponents =
        {
                ret = 1
                count = 3
                start = 0
                tbl =
                {
                        0 =
                        {
                                login2 = bromba
                                w = 5
                                l = 1
                                d = 0
                        }
                        1 =
                        {
                                login2 = nexti
                                w = 1
                                l = 0
                                d = 0
                        }
                        2 =
                        {
                                login2 = samuel
                                w = 6
                                l = 24
                                d = 0
                        }
                }
        }

gameId

That parameters describe game that we are interested in

filter

That field will be used to limit searches to one kind of rooms.

Eg. we can fetch only rooms with admin. 

You can use following params: priv, admin, name of languages(eg. English), type of player, vip.

These options can be joined with |.! signs.

| - logical or eg. admin|priv will fetch data for private or rooms with admins.

! – logical not eg.!admin will fetch data for private or rooms with admins,

. – logical and eg admin.vip will return all games that are for vip and has admins.

Examples

Vip – vip rooms

!vip – remaining(not vip rooms)

private – private rooms

!private – not private (public) rooms

You can also add additional terms eg.

!private.vip – not private rooms for vip

!private.!vip – not private rooms for not vip (other players)

!private.!vip.admin – not private rooms for not vip with admin

!private.!vip.!admin – not private rooms for not vip without admin

You can go even further if you use |

Eg.

!private.vip.admin|private – not private rooms for vip with admin + all private rooms.

fields

That parameters describe games that we want to get. In that way we can optimize query. Available queries:

Sort

Returned table can be sorted by different parameters (remember that only by one of returned parameters. Eg: When we sort game by players|name – we will get data sorted first by number of players and then by name. If before sort field there is ! – we reverse sort. Eg.  !players|name will first sort descending by number of players and than by game name.

That function returns eg, for query room_info(game27,admin,*):

room_info =
        {
                ret = 1
                count = 4
                tbl =
                {
                        0 =
                        {
                                id = 0
                                name = Best Friends
                                status = admin
                                players = 2
                                max = 100
                        }
                        1 =
                        {
                                id = 1
                                name = Pool Party
                                status = admin
                                players = 0
                                max = 100
                        }
                        2 =
                        {
                                id = 2
                                name = The Deep End
                                status = admin
                                players = 0
                                max = 100
                        }
                        3 =
                        {
                                id = 3
                                name = Dust In The Wind
                                status = admin
                                players = 0
                                max = 100
                        }
                }
        }

gameId

That parameters describe game that we are interested in

secondary

That parameter is used by some games:

·         In single word games it is used to select language,

·         In solitaires – to select variant,

·         In pinballs – to select mode

·         In jungle hunter – to select room

count

How many record do we want to retrieve

start

From that position we want to start

sortBy

Rankings for most games (except solitaires,pinballs and jungle hunter) can be sorted by different param. You can select here used param. Eg. if for snooker you will use RF – rankings will be sorted descending by ranking, if you use !RF – rankings will be sorted ascending by ranking.

That function returns eg, for query ranking(game4,0):

         ranking =
        {
                ret = 1
                desc =
                {
                        rating =
                        {
                                0 = R
                                1 = Rating
                        }
                        games_completed =
                        {
                                0 = GC
                                1 = Games Completed
                        }
                        games_abandoned =
                        {
                                0 = GA
                                1 = Games Abandoned
                        }
                        wins =
                        {
                                0 = W
                                1 = Wins
                        }
                        loses =
                        {
                                0 = L
                                1 = Loses
                        }
                }
                count = 3
                ranking =
                {
                        0 =
                        {
                                playerId = 372
                                login = Object
                                rating = 4991
                                games_completed = 6
                                games_abandoned = 1
                                wins = 0
                                loses = 6
                        }
                        1 =
                        {
                                playerId = 375
                                login = bromba
                                rating = 4984
                                games_completed = 1
                                games_abandoned = 1
                                wins = 0
                                loses = 1
                        }
                        2 =
                        {
                                playerId = 373
                                login = samuel
                                rating = 4935
                                games_completed = 6
                                games_abandoned = 4
                                wins = 5
                                loses = 1
                        }
                }
        }

gameId

That parameters describe game that we are interested in

name

Name(login) of searched user.

sortBy

Rankings for most games (except solitaires,pinballs and jungle hunter) can be sorted by different param. You can select here used param. Eg. if for snooker you will use RF – rankings will be sorted descending by ranking, if you use !RF – rankings will be sorted ascending by ranking.

That function returns eg, for query action= ranking_find(game4,bromba)

        ranking_find =
        {
                ret = 1
                pos = 2
        }