Skip to main content

Markers (restricted)

The /markers/ routes return marker entities, which represent real-world point-of-interests with just enough data te be displayed on a map.

Some markers are built and contain the icon and skin fields. If those fields are missing, then the marker is considered constructible (aka: not built ).

info

Only the buildings built this season (this month, in Neopolis) are considered built. This means that when a new season starts in Neopolis, all markers return to the constructible state.

caution

The /markers/ endpoints are restricted for internal use only, both for read and write. They cannot be accessed via a public API token.

Get markers within a Radius​

GET /markers/findByRadius?lat=45.766750&lng=4.844647&radius=500&season=1
Example Response

{
    "status": "ok",
    "data": [
      {
        "id": "PLACE_ID",
        "land_id": "LAND_ID",
        "latlng": {
              "latitude": 45.768223,
              "longitude": 4.845756
        },
        "icon": 10, // undefined if is_built is false
        "skin": "SKIN_ID", // undefined if is_built is false
        "is_built": true
      },
      (...)
    ]
}

Update a marker's information​

This endpoint is used to update the marker's information: wheter is it built or not this season, the icon and the skin.

PUT /markers/update

{
  "id": "MY_PLACE_ID",
  "season": 1, // used to know in which Neopolis' season the marker was built
  "icon": 10,
  "skin": "SKIN_ID" // use an empty string as default
}
Example Response

{
    "status": "ok",
}

Remove a marker's information​

This endpoint is used to remove an endpoint's information. In Neopolis, this is useful when a building has been sold to the bank, and returns to the constructible state.

Note that the marker is not deleted, only it's built state.

PUT /markers/remove

{
  "id": "MY_PLACE_ID",
}
Example Response

{
    "status": "ok",
}