Locations

All Locations

You can get a list of all the locations of a campaign by using the following endpoint.

{warning} Don't forget that all endpoints documented here need to be prefixed with 1.0/campaigns/{campaign.id}/.

Method URI Headers
GET/HEAD locations Default

URL Parameters

The list of returned entities can be filtered. The available filters are available here

Results

{
    "data": [
        {
            "id": 1,
            "name": "Mordor",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "has_custom_image": false,
            "is_destroyed": true,
            "is_private": true,
            "location_id": null,
            "entity_id": 5,
            "tags": [],
            "created_at":  "2019-01-30T00:01:44.000000Z",
            "created_by": 1,
            "updated_at":  "2019-08-29T13:48:54.000000Z",
            "updated_by": 1,
            "location_id": 4,
            "type": "Kingdom"
        }
    ]
}

Location

To get the details of a single location, use the following endpoint.

Method URI Headers
GET/HEAD locations/{location.id} Default

Results

{
    "data": {
        "id": 1,
        "name": "Mordor",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "has_custom_image": false,
        "is_destroyed": true,
        "is_private": true,
        "location_id": null,
        "entity_id": 5,
        "tags": [],
        "created_at":  "2019-01-30T00:01:44.000000Z",
        "created_by": 1,
        "updated_at":  "2019-08-29T13:48:54.000000Z",
        "updated_by": 1,
        "location_id": 4,
        "type": "Kingdom"
    }

}

Create a Location

To create a location, use the following endpoint.

Method URI Headers
POST locations Default

Body

Parameter Type Detail
name string (Required) Name of the location
entry string The html description of the location
type string Type of location
location_id integer The parent location id (where this location is located)
tags array Array of tag ids
is_destroyed boolean If the location is destroyed
is_private boolean If the location is only visible to admin members of the campaign
entity_image_uuid string Gallery image UUID for the entity image
entity_header_uuid string Gallery image UUID for the entity header (limited to premium campaigns)

Results

{success} Code 200 with JSON body of the new location.

Update a Location

To update a location, use the following endpoint.

Method URI Headers
PUT/PATCH locations/{location.id} Default

Body

The same body parameters are available as for when creating a location.

Results

{success} Code 200 with JSON body of the updated location.

Delete a Location

To delete a location, use the following endpoint.

Method URI Headers
DELETE locations/{location.id} Default

Results

{success} Code 200 with JSON.