API docs by Redocly

Journals (1.0.0)

Download OpenAPI specification:

Journal entries, tags and statistics for client self-reflection

apis

apis_journal_create

Creates, updates, or soft-deletes a Journal entry.

POST — Creates a new Journal record. Sets the creation timestamp dynamically and returns the new journalid (HTTP 201). If an existing record is found by userloginname the existing journalid is returned (HTTP 200) instead.

PUT /{journalid}/ — Partially or fully updates an existing Journal record and refreshes update_timestamp. Returns the journalid (HTTP 200).

DELETE /{journalid}/ — Soft-deletes the journal by setting is_deleted=True.

Uses JournalCreateUpdateSerializer for writes and JournalGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
Request Body schema:
userid
integer or null
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

apis_journal_update

Creates, updates, or soft-deletes a Journal entry.

POST — Creates a new Journal record. Sets the creation timestamp dynamically and returns the new journalid (HTTP 201). If an existing record is found by userloginname the existing journalid is returned (HTTP 200) instead.

PUT /{journalid}/ — Partially or fully updates an existing Journal record and refreshes update_timestamp. Returns the journalid (HTTP 200).

DELETE /{journalid}/ — Soft-deletes the journal by setting is_deleted=True.

Uses JournalCreateUpdateSerializer for writes and JournalGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Request Body schema:
userid
integer or null
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

apis_journal_destroy

Creates, updates, or soft-deletes a Journal entry.

POST — Creates a new Journal record. Sets the creation timestamp dynamically and returns the new journalid (HTTP 201). If an existing record is found by userloginname the existing journalid is returned (HTTP 200) instead.

PUT /{journalid}/ — Partially or fully updates an existing Journal record and refreshes update_timestamp. Returns the journalid (HTTP 200).

DELETE /{journalid}/ — Soft-deletes the journal by setting is_deleted=True.

Uses JournalCreateUpdateSerializer for writes and JournalGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

apis_journals_sessionid_retrieve

Retrieves all journal entries associated with a given chat sessionId. Send the sessionId as a URL path parameter. Returns the journal list via JournalGetSerializer.

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_journals_sessionid_retrieve_2

Retrieves all journal entries associated with a given chat sessionId. Send the sessionId as a URL path parameter. Returns the journal list via JournalGetSerializer.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

apis_journals_userid_retrieve

Retrieves all journal entries for a given userId, sorted by most recent first. The response includes each journal's associated tags. Send the userId as a URL path parameter. Returns 204 if no journals exist.

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_journals_userid_retrieve_2

Retrieves all journal entries for a given userId, sorted by most recent first. The response includes each journal's associated tags. Send the userId as a URL path parameter. Returns 204 if no journals exist.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

apis_journals_userid_date_create

Returns all journal entries for a user within a date or datetime range, ordered most recent first.

POST — Accepts "userid", "fromdate", and "todate" in the request body. Both date values can be either a date string ("YYYY-MM-DD") or a full ISO datetime ("YYYY-MM-DDTHH:MM:SS"). Date-only values are normalised to midnight for fromdate and 23:59:59 for todate to include the full day. Returns 204 if no journals exist in the range.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>
userid
integer or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z",
  • "userid": 0
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z",
  • "userid": 0
}

apis_journals_userloginname_retrieve

Retrieves all journal entries for a user identified by their userLoginName. Filters the Journal table via a related-field lookup on "userid__userloginname". Send the userLoginName as a URL path parameter. Returns the full journal list via JournalGetSerializer.

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_journals_userloginname_retrieve_2

Retrieves all journal entries for a user identified by their userLoginName. Filters the Journal table via a related-field lookup on "userid__userloginname". Send the userLoginName as a URL path parameter. Returns the full journal list via JournalGetSerializer.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

apis_journalstats_userid_create

Returns a daily journal count for a user within a date range.

POST — Accepts "userid", "fromdate" (YYYY-MM-DD), and "todate" (YYYY-MM-DD) in the request body. Queries all journals within the inclusive date range, groups them by calendar date using pandas, and returns a list of {"journaldate": ..., "count": ...} records under the "journalstats" key. Returns 204 if no journals exist in the range.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
userid
integer or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "userid": 0,
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

apis_journaltag_create

Creates, updates, or soft-deletes a Journaltag entry.

POST — Creates a new tag record and returns the journaltagid.

PUT /{journaltagid}/ — Updates an existing tag record.

DELETE /{journaltagid}/ — Soft-deletes the tag by setting is_deleted=True.

Uses JournalTagCreateSerializer for writes and JournalTagGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
Request Body schema:
journalid
integer or null
tagtypeid
integer or null
tagdescription
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "journalid": 0,
  • "tagtypeid": 0,
  • "tagdescription": "string"
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "tagtypeid": 0,
  • "tagdescription": "string"
}

apis_journaltag_update

Creates, updates, or soft-deletes a Journaltag entry.

POST — Creates a new tag record and returns the journaltagid.

PUT /{journaltagid}/ — Updates an existing tag record.

DELETE /{journaltagid}/ — Soft-deletes the tag by setting is_deleted=True.

Uses JournalTagCreateSerializer for writes and JournalTagGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
path Parameters
journaltagid
required
integer

A unique integer value identifying this journaltag.

Request Body schema:
journalid
integer or null
tagtypeid
integer or null
tagdescription
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "journalid": 0,
  • "tagtypeid": 0,
  • "tagdescription": "string"
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "tagtypeid": 0,
  • "tagdescription": "string"
}

apis_journaltag_destroy

Creates, updates, or soft-deletes a Journaltag entry.

POST — Creates a new tag record and returns the journaltagid.

PUT /{journaltagid}/ — Updates an existing tag record.

DELETE /{journaltagid}/ — Soft-deletes the tag by setting is_deleted=True.

Uses JournalTagCreateSerializer for writes and JournalTagGetSerializer for reads.

Authorizations:
cookieAuthbasicAuth
path Parameters
journaltagid
required
integer

A unique integer value identifying this journaltag.

Responses

apis_journaltag_journalid_create

Creates a new Journaltag and retrieves all tags for a given journalId.

POST — Creates a new Journaltag record, sets create_timestamp and update_timestamp, and returns the journaltagid (HTTP 201).

GET /{journalId}/ — Returns all active tags associated with the given journalId via JournalTagGetSerializer.

Authorizations:
cookieAuthbasicAuthNone

Responses