View source for API/Village


[[API|Back to API]]

This API page describes the endpoints under api.retromc.org/api/v1/village.

== GET api.retromc.org/api/v1/village/getVillageList ==

=== Description ===
This endpoint retrieves a list of villages along with their owner information.

=== HTTP Method ===
<code>GET</code>

=== Request Parameters ===
None.

=== Response Format ===
* '''villages''' (array): A list of villages. Each village object contains:
** '''owner''' (string): The UUID of the village owner.
** '''name''' (string): The name of the village.
** '''uuid''' (string): The UUID of the village.

=== Example Response ===
<pre>
{
  "villages": [
    {
      "owner": "8fa8f70d-eb7d-4743-b0ad-837cdfb69f4e",
      "name": "netherlogin",
      "uuid": "00a53536-3a77-40ba-a539-f867bbbe9f7c"
    },
    {
      "owner": "43640a41-9800-4b62-9244-c5834d440aaa",
      "name": "Chunkview",
      "uuid": "01686cb0-28ff-4096-a610-0622615c2d7a"
    },
    {
      "owner": "07f3c6d2-f500-42f7-847c-4a895cff844e",
      "name": "New_Zealand",
      "uuid": "019896e3-90c2-4195-bfcb-6938342f79c8"
    },
    {
      "owner": "74c68e1e-7a04-4052-8009-8b3db955369e",
      "name": "Wondaria",
      "uuid": "01d1385d-fe53-49f3-8ecd-7bb07ce8d7cf"
    },
    {
      "owner": "eca8c74c-849e-4aaa-b844-56d91b3cf5f3",
      "name": "Thornrun",
      "uuid": "0220284c-39dd-490b-886d-29b4af39714d"
    }
  ],
  "error": false
}
</pre>

== GET api.retromc.org/api/v1/village/getVillage ==

=== Description ===
Retrieves detailed information about a specific village by its UUID, including owner, assistants, members, spawn location, balance, creation time, flags, and the total number of claims.

=== HTTP Method ===
<code>GET</code>

=== Request Parameters ===
* '''uuid''' (required, string): The UUID of the village to retrieve information about.

=== Response Format ===
* '''owner''' (string): The UUID of the village owner.
* '''assistants''' (array of strings): UUIDs of the village assistants.
* '''found''' (boolean): Indicates if the village was found.
* '''spawn''' (object): The spawn location of the village with:
** '''world''' (string): The name of the world.
** '''x''' (int): X coordinate.
** '''y''' (int): Y coordinate.
** '''z''' (int): Z coordinate.
* '''creationTime''' (int): Unix timestamp of when the village was created.
* '''balance''' (int): The current balance of the village.
* '''members''' (array of strings): UUIDs of the village members.
* '''name''' (string): The name of the village.
* '''flags''' (object): Various boolean flags related to village settings such as:
** '''MEMBERS_CAN_INVITE''' (boolean): Whether members can invite others.
** '''RANDOM_CAN_ALTER''' (boolean): Whether random players can alter the village.
** '''MOBS_CAN_SPAWN''' (boolean): Whether mobs can spawn in the village.
** '''ASSISTANT_CAN_WITHDRAW''' (boolean): Whether assistants can withdraw from the village balance.
** '''MOB_SPAWNER_BYPASS''' (boolean): Whether the mob spawner bypass is enabled.
* '''claims''' (int): The number of claims the village has.
* '''error''' (boolean): Indicates whether there was an error processing the request.
* '''uuid''' (string): The UUID of the village.

=== Example Response ===
<pre>
{
  "owner": "413e630d-d87a-4cb7-adaf-01af67d014b2",
  "assistants": [
    "d9700caa-8dab-4561-bfaa-707de4246966",
    "413e630d-d87a-4cb7-adaf-01af67d014b2",
    "795b6cec-195d-4645-8d5c-6ff32053f529",
    "9ce02968-72c0-41a1-a9f6-d4651ef31ba9",
    "db7db941-6923-4855-a879-1ae655c16122",
    "f03e6b30-95a6-4cba-bda5-23140593424b",
    "6f07f480-9de3-4fdd-b81e-8780e3aed9cb",
    "30b7d93e-acfb-4727-8c39-7a6d451ccb95",
    "d311182e-d1c3-4076-a8de-1908e8333c8d",
    "bb4d79b2-1bac-42c8-9a7b-16433fce0fd5",
    "977ee282-508c-4e1f-9a7a-1d0fff81fd36",
    "d251776a-9df6-49ce-8b38-a59d7b2dc9ee"
  ],
  "found": true,
  "spawn": {
    "world": "retromc",
    "x": -924,
    "y": 74,
    "z": -1186
  },
  "creationTime": 1640995200,
  "balance": 10,
  "members": [
    "7ba8a59d-e970-4313-897d-975e617d9ac3",
    "9286cb50-31d6-4ba2-a8dc-67607815bf32",
    "fc88334d-32af-43e2-bfdf-83390ab7e5b1",
    "e8fee250-1bd8-4805-8cd2-6157bed9aa98",
    "0cb288a6-4824-475b-b69f-7ae09dd50973",
    "e202faa0-ff11-4659-982b-4f4ed69f3705",
    "d9700caa-8dab-4561-bfaa-707de4246966",
    "933fecc8-7214-4e64-8310-562af20e88cc",
    "47e67e0f-de3c-4916-b87b-265bd7f9d2df",
    "413e630d-d87a-4cb7-adaf-01af67d014b2",
    "123f3c41-ef29-48ff-889f-799a67e17869",
    "6f07f480-9de3-4fdd-b81e-8780e3aed9cb",
    "33bb0ee0-322e-4031-83b0-ddec86238e0d",
    "71041fce-4cc6-4e44-aa49-07c7bff8b5a3",
    "eed3b061-63c1-47be-9c5c-233e0b9c2a27",
    "3a3c3c97-025c-4ed8-9727-ac0e3d65ed7f",
    "95d46a84-1f6c-469e-8409-8add12db858f",
    "23e6b46f-622f-4316-b7e8-3d44a54f759a",
    "5800fc63-db7c-4607-b150-6b356ba66f76",
    "0036b691-2099-4d89-84db-65f7518d39d1",
    "cb7d5351-54b2-4ff5-b57e-f3429ab95cd2",
    "5aa96969-84c4-450c-b20a-0244ed713739",
    "a86a7805-98e9-4f5a-8578-6680c0bd5c1e",
    "985b9366-cdc1-45c2-aa7b-cd6a0837e47f",
    "514ddc28-b81f-4035-9624-e8dbd9962310",
    "62bec40f-e65a-41cb-a444-fbfc611a42ef",
    "2dee7884-ccde-4cc4-ae5e-ca2d12d67696"
  ],
  "name": "Kekistan",
  "flags": {
    "MEMBERS_CAN_INVITE": false,
    "RANDOM_CAN_ALTER": false,
    "MOBS_CAN_SPAWN": false,
    "ASSISTANT_CAN_WITHDRAW": false,
    "MOB_SPAWNER_BYPASS": false
  },
  "claims": 10795,
  "error": false,
  "uuid": "87ffd0aa-cc0b-47ba-9794-1ad690369612"
}
</pre>