Kanka logo Kanka

Journals


All Journals

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

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

Method Endpoint Headers
GET/HEAD journals Default

Results

{
    "data": [
        {
            "id": 3,
            "name": "Session 2 - Descent into the Abyss",
            "entry": "\n<p>Lorem Ipsum</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": true,
            "entity_id": 42,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 18:19:47.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": null,
            "updated_at": {
                "date": "2018-09-20 09:17:41.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "character_id": 11,
            "date": "2017-11-02",
            "type": "Session"
        }
    ]
}

Journal

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

Method Endpoint Headers
GET/HEAD journals/{journal.id} Default

Results

{
    "data": {
        "id": 3,
        "name": "Session 2 - Descent into the Abyss",
        "entry": "\n<p>Lorem Ipsum</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "is_private": true,
        "entity_id": 42,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 18:19:47.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": null,
        "updated_at": {
            "date": "2018-09-20 09:17:41.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "character_id": 11,
        "date": "2017-11-02",
        "type": "Session"
    }

}

Create a Journal

To create a journal, use the following endpoint.

Method Endpoint Headers
POST journals Default

Body

Parameter Type Detail
name string (Required) Name of the journal
type string The journal's type
date string The date of the session
character_id string The "author" of the journal
tags array Array of tag ids
is_private boolean If the journal is only visible to admin members of the campaign
image stream Stream to file uploaded to the journal
image_url string URL to a picture to be used for the journal

Results

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

Update a Journal

To update a journal, use the following endpoint.

Method Endpoint Headers
PUT/PATCH journals/{journal.id} Default

Body

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

Results

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

Delete a Journal

To delete a journal, use the following endpoint.

Method Endpoint Headers
DELETE journals/{journal.id} Default

Results

{success} Code 200 with JSON.