Diaries

Overview

Diaries are a structured, user-driven log of notes in relation to a given entity. For example, a running series of notes relating to management of a policy transaction (such as a cancellation and the reasons for it, or notes of conversations with the insured), could be captured in a series of diary entries.

Policies, Quotes, and Policy Transactions currently support diaries, and other entities will be enabled for diaries in the future.

Diary Entries

The primary diary element is called a Diary Entry. For each of the supported entity types, a series of entries can be created. Each is timestamped and can be given an optional category value.

Diary entries are referred to by either a locator (which is specific to a given diary entry) or a referenceLocator (such as a quote or policy locator) which will indicate all the diary entries for that entity. The endpoints Fetch Latest Diary Entry By Locator or Fetch Latest Diary Entries By Reference are used for these two types of retrieval. The former will return a single diary entry, and the latter can return multiple entries.

Revisioning

When a diary entry for an entity is updated with the Update Diary endpoint, old entries are not removed. Rather, they remain accessible with the Fetch All Diary Entries By Locator endpoint. To see only the latest entries, use either the Fetch Latest Diary Entry By Locator or Fetch Latest Diary Entries By Reference endpoints.

Discard

Diary entries may be discarded, which means they will no longer be available except by direct reference by locator.

Note

The discard function will discard the entry as a whole, including all revisions. To keep the entry, you may want to simply update it, which will exclude the existing entry from the “latest” fetch endpoints.