Map
Map_MapStats
Request
GET /api/v1/map/mapstats?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_EntityTypes
Allows access to all species currently available in the simulation.
Request
GET /api/v1/map/entitytypes?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_Entities
Allows access to all entities currently available in the simulation.
Request
GET /api/v1/map/entities?authtoken&authtokentype[&entityTypes&states]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| entityTypes | array | A list of user type names that will be used to filter the response. |
|
| states | array | A list of Animal states that will be used to filter the response. |
|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_GetDimension
Returns the dimension of the world, in blocks.
Request
GET /api/v1/map/dimension?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_LayerList
List Layer Names.
Request
GET /api/v1/map/layerList?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_MakeMapJSON
One request to get all required web map data.
Request
GET /api/v1/map/map.json?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_WaterLevel
Get water height.
Request
GET /api/v1/map/waterLevel?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
Map_GetProperty
Request
GET /api/v1/map/property?authtoken&authtokentypeParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *authtoken | string | Eco user authentication token. |
|
| *authtokentype | string | Eco user authentication token type. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |