Maps Directory

Description

This request will return a directory of the maps that have been played in WGL during the current season.

URI api.fantasywgl.com/request/{API_KEY}/dir_maps/
Request Method GET, POST

Parameters

Parameter Required Type Default Description
lang FALSE string en-us Language code. See Languages for details.
search FALSE string null Map name search string. Minimum length: 3 characters.

Response

Meta Information

Field Type Description
count integer Number of maps included in the response

Data

Field Type Description
id string The map identifier; used for file names, organization.
name string Localized display name of the map.
battles integer The number of battles played in WGL on the map

Errors

Full List
Code Message Description
622 INVALID_SEARCH The search parameter was not valid. It could have been too short or of the wrong format.
623 NO_SEARCH_RESULTS There were results found based on the value sent in the search parameter.
<?xml version="1.0"?>
<response>
  <status>ok</status>
  <requestDetails>
    <key>demo</key>
    <request>dir_maps</request>
    <output>xml</output>
    <apiKeyAlias>Hyp's Test Environment</apiKeyAlias>
  </requestDetails>
  <meta>
    <count>9</count>
  </meta>
  <data>
    <map>
      <id>35_steppes</id>
      <name>Steppes</name>
      <battles>97</battles>
    </map>
    <map>
      <id>05_prohorovka</id>
      <name>Prokhorovka</name>
      <battles>74</battles>
    </map>
    <map>
      <id>18_cliff</id>
      <name>Cliff</name>
      <battles>71</battles>
    </map>
    <map>
      <id>04_himmelsdorf</id>
      <name>Himmelsdorf</name>
      <battles>69</battles>
    </map>
    <map>
      <id>08_ruinberg</id>
      <name>Ruinberg</name>
      <battles>60</battles>
    </map>
    <map>
      <id>10_hills</id>
      <name>Mines</name>
      <battles>57</battles>
    </map>
    <map>
      <id>11_murovanka</id>
      <name>Murovanka</name>
      <battles>41</battles>
    </map>
    <map>
      <id>95_lost_city</id>
      <name>Ghost Town</name>
      <battles>38</battles>
    </map>
    <map>
      <id>28_desert</id>
      <name>Sand River</name>
      <battles>14</battles>
    </map>
  </data>
</response>
{
	"status": "ok",
	"requestDetails": {
		"key": "demo",
		"request": "dir_maps",
		"output": "json",
		"apiKeyAlias": "Hyp's Test Environment"
	},
	"meta": {
		"count": 9
	},
	"data": [
		{
			"id": "35_steppes",
			"name": "Steppes",
			"battles": "97"
		},
		{
			"id": "05_prohorovka",
			"name": "Prokhorovka",
			"battles": "74"
		},
		{
			"id": "18_cliff",
			"name": "Cliff",
			"battles": "71"
		},
		{
			"id": "04_himmelsdorf",
			"name": "Himmelsdorf",
			"battles": "69"
		},
		{
			"id": "08_ruinberg",
			"name": "Ruinberg",
			"battles": "60"
		},
		{
			"id": "10_hills",
			"name": "Mines",
			"battles": "57"
		},
		{
			"id": "11_murovanka",
			"name": "Murovanka",
			"battles": "41"
		},
		{
			"id": "95_lost_city",
			"name": "Ghost Town",
			"battles": "38"
		},
		{
			"id": "28_desert",
			"name": "Sand River",
			"battles": "14"
		}
	]
}