Skip to main content

BookExternalIdDto

External ID from a metadata provider (plugin, epub, pdf, manual)

bookIdstring<uuid>required

Book ID

Example: 550e8400-e29b-41d4-a716-446655440001
createdAtstring<date-time>required

When the external ID was created

Example: 2024-01-01T00:00:00Z
externalIdstringrequired

External ID value from the source (ISBN, OLID, etc.)

Example: OL123456W
externalUrlstring | nullnullable

URL to the external source (if available)

Example: https://openlibrary.org/works/OL123456W
idstring<uuid>required

External ID record ID

Example: 550e8400-e29b-41d4-a716-446655440070
lastSyncedAtstring,null<date-time>nullable

When the metadata was last synced from this source

Example: 2024-01-15T10:30:00Z
metadataHashstring | nullnullable

Hash of the last fetched metadata (for change detection)

sourcestringrequired

Source identifier (e.g., "plugin:openlibrary", "epub", "pdf", "manual")

Example: plugin:openlibrary
updatedAtstring<date-time>required

When the external ID was last updated

Example: 2024-01-15T10:30:00Z
BookExternalIdDto
{
"bookId": "550e8400-e29b-41d4-a716-446655440001",
"createdAt": "2024-01-01T00:00:00Z",
"externalId": "OL123456W",
"externalUrl": "https://openlibrary.org/works/OL123456W",
"id": "550e8400-e29b-41d4-a716-446655440070",
"lastSyncedAt": "2024-01-15T10:30:00Z",
"metadataHash": "string",
"source": "plugin:openlibrary",
"updatedAt": "2024-01-15T10:30:00Z"
}