API Design

Service Type Discussion

Connector Level

Basic Connector Architecture Notes Connectors are supported by data stores that are historical and archival. This means that they include all records as atomic and immutable entries, with 'edits' and 'deletes' being stored as additional entries that reference the target entity in the store, rather than modifying or deleting it in place. Additionally, the data in the store is preserved in a non-compressed and easily accessible format, such that the data will remain accessible via multiple means as technologies evolve over the years.

Records in a collection should always support the following fields on each record:

• Record ID
• Timestamp
• Source
• Reference ID (only if 'edit' or 'delete')
• Document Body

Basic Connector API Methods Within the flow of the Locker, Connectors will primarily serve Collections as data sources, and the exposed methods reflect that pattern.

• /getAll: Retrieve all records, in chronological order.
• /getID: Retrieve a specific record, and any records that reference it.
• /getSince: Retrieve all records since either a Timestamp or ID argument.
• /getCurrent: Retrieve a consolidated set of records with all edits or deletes applied to the set.

Collection Level