Difference between revisions of "Server List Filters"
m |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Category:API]] | ||
| + | |||
'''Implementation Status:''' [[API_Implementation_Statuses#Under Development|Under Development]]<br/> | '''Implementation Status:''' [[API_Implementation_Statuses#Under Development|Under Development]]<br/> | ||
(WIP) | (WIP) | ||
| Line 4: | Line 6: | ||
full (bool)<br> | full (bool)<br> | ||
empty (bool)<br> | empty (bool)<br> | ||
| − | IPAddress<br> | + | IPAddress (string)<br> |
| − | IPv4Address<br> | + | IPv4Address (string)<br> |
| − | IPv6Address<br> | + | IPv6Address (string)<br> |
port (int)<br> | port (int)<br> | ||
| − | gameMode (int)<br> | + | gameMode (string)<br> |
| − | mostCurrentPlayers<br> | + | currentPlayers (int)<br> |
| − | leastCurrentPlayers<br> | + | maxPlayers (int)<br> |
| − | mostMaxPlayers<br> | + | mostCurrentPlayers (int)<br> |
| − | leastMaxPlayers<br> | + | leastCurrentPlayers (int)<br> |
| − | build<br> | + | mostMaxPlayers (int)<br> |
| + | leastMaxPlayers (int)<br> | ||
| + | build (int)<br> | ||
current (bool)<br> | current (bool)<br> | ||
lastUpdated (ISO date)<br> | lastUpdated (ISO date)<br> | ||
| Line 23: | Line 27: | ||
nameContains (string, partial match)<br> | nameContains (string, partial match)<br> | ||
name (string)<br> | name (string)<br> | ||
| − | description (string)<br> | + | description (string - this is a bit silly, this probably won't be implemented)<br> |
descriptionContains (string, partial match)<br> | descriptionContains (string, partial match)<br> | ||
| + | All booleans are represented as 0/1<br> | ||
| + | All data types can be negated with ! preceeding the value - e.g. /servers/currentPlayers/!0 (same as /servers/empty/0) | ||
| + | |||
| + | |||
| + | The filters are concatenated together in the request URI to form an AND filter. There is no mechanism for an OR filter, you need to make multiple queries and join the resulting sets yourself. | ||
| − | + | https://api.kag2d.com/servers/full/0/empty/0 | |
Latest revision as of 21:48, 14 June 2012
Implementation Status: Under Development
(WIP)
full (bool)
empty (bool)
IPAddress (string)
IPv4Address (string)
IPv6Address (string)
port (int)
gameMode (string)
currentPlayers (int)
maxPlayers (int)
mostCurrentPlayers (int)
leastCurrentPlayers (int)
mostMaxPlayers (int)
leastMaxPlayers (int)
build (int)
current (bool)
lastUpdated (ISO date)
firstSeen (ISO date)
connectable (bool)
password (bool)
preferAF (bool)
gold (bool)
nameContains (string, partial match)
name (string)
description (string - this is a bit silly, this probably won't be implemented)
descriptionContains (string, partial match)
All booleans are represented as 0/1
All data types can be negated with ! preceeding the value - e.g. /servers/currentPlayers/!0 (same as /servers/empty/0)
The filters are concatenated together in the request URI to form an AND filter. There is no mechanism for an OR filter, you need to make multiple queries and join the resulting sets yourself.
