Skip to main content

ScanStatusDto

Scan status response

booksFoundintegerrequired

Number of books found/created

Possible values: >= 0

Example: 750
completedAtstring,null<date-time>nullable

When the scan completed (if finished)

Example: 2024-01-15T10:45:00Z
errorsstring[]required

List of errors encountered during scan

filesProcessedintegerrequired

Number of files processed so far

Possible values: >= 0

Example: 750
filesTotalintegerrequired

Total number of files discovered

Possible values: >= 0

Example: 1500
libraryIdstring<uuid>required

Library ID being scanned

Example: 550e8400-e29b-41d4-a716-446655440000
seriesFoundintegerrequired

Number of series found/created

Possible values: >= 0

Example: 45
startedAtstring<date-time>required

When the scan started

Example: 2024-01-15T10:30:00Z
statusstringrequired

Current status of the scan (scanning, completed, failed)

Example: scanning
ScanStatusDto
{
"booksFound": 750,
"completedAt": "2024-01-15T10:45:00Z",
"errors": [
"string"
],
"filesProcessed": 750,
"filesTotal": 1500,
"libraryId": "550e8400-e29b-41d4-a716-446655440000",
"seriesFound": 45,
"startedAt": "2024-01-15T10:30:00Z",
"status": "scanning"
}