As we've established, the provided documents detail standards and processes but do not explicitly define API response structures. This structure is derived based on the description of the "Listing" resource and the detailed information about the listing's purpose and use in the reconciliation process as described in the ACQUA standards. The primary purpose of accessing Listing Details via this endpoint is stated as being "for reconciliation purposes", meaning the response must provide the necessary information for operators or auditors to compare what was captured against what was expected based on the listing.
Endpoint: Get Listing Details HTTP Method: GET Path: /listings/{listingId} Purpose: To allow camera operators or project managers to access the details of the listing for reconciliation purposes.
JSON Response Body Structure (application/json):
The response body provides the details of a specific listing, including its overall identifying information and the list of items that were expected to be captured according to the listing, along with any relevant status or notes from the reconciliation process.
{
  "listingId": "string", // Unique identifier for the listing (Derived for identification)
  "title": "string", // The title or main description of the collection or project covered by the listing (e.g., "Michigan Births 1850-1875" [11])
  "archive": "string", // The name or identifier of the archive where the original documents are located (Derived from context, implied by the archive standards)
  "issuedDate": "string", // The date the listing was created or finalized (ISO 8601 format) (Derived from the process of creating listings before capture [2, 7])
  "status": "string", // The current status of the listing's reconciliation process (e.g., "Open", "In Progress", "Completed", "Exception Granted") (Derived/Inferred from the reconciliation process [4, 10] and exceptions [12])
  "notes": "string", // Any overall notes or comments about the listing or the reconciliation process (Derived/Inferred based on need for documentation)
  "listedItems": [ // An array of objects, each representing a specific volume, record, or item expected to be captured according to this listing [2, 3, 7, 8]
    {
      "itemIdentifier": "string", // A unique identifier for this specific item as listed (Derived/Inferred for structured data)
      "listingDescription": "string", // A textual description of the item as it appears in the original listing (e.g., "Volume 3", "File Box 14, Folder A-C") [3, 8]
      "recordType": "string", // The type of record expected (e.g., "Birth certificate", "Marriage registers") [13, 14]
      "startDate": "string", // The start date associated with the item, if applicable (e.g., "1870") [15]
      "endDate": "string", // The end date associated with the item, if applicable (e.g., "1875") [15]
      "volume": "string", // The volume number, if applicable [16]
      "expectedCount": "number", // The estimated or expected number of images for this item (Derived/Inferred, useful for reconciliation)
      "reconciliationStatus": "string", // The status of this specific item during the reconciliation process (e.g., "Pending Capture", "Captured", "Missing - Not Available", "Found - Not on Listing", "Duplicate Found") (Derived/Inferred based on the operator's reconciliation actions [4, 10])
      "reconciliationNotes": "string", // Notes recorded by the operator or auditor during reconciliation specifically for this item [4, 10]
      "capturedFolderId": "string", // The identifier of the folder where this item was captured, if applicable (References the /folders resource) (Derived/Inferred, links listing item to captured output)
      "capturedSequenceNumber": "number" // The sequence number or starting image number within the captured folder for this item, if applicable (Derived/Inferred, useful for navigation)
    }
    // ... potentially more listed item objects
  ]
}
Field Descriptions:
•
listingId (string): A unique identifier for the overall listing. This allows the system to retrieve and manage specific listings [Derived].
•
title (string): The title or general description of the material covered by the listing.
•
archive (string): Identification of the physical location (archive) of the original documents referenced in the listing [Derived].
•
issuedDate (string): The date the listing was formally created or issued, important for tracking project timelines [Derived].
•
status (string): The overall status of the reconciliation effort for this listing. This reflects whether the process is underway or completed [Derived/Inferred].
•
notes (string): General notes about the listing itself or the reconciliation project [Derived/Inferred].
•
listedItems (array of objects): This is the core of the response, representing the items (volumes, records, files) that were expected to be found and captured according to the listing.
◦
itemIdentifier (string): A unique ID for the specific item within the listing [Derived/Inferred].
◦
listingDescription (string): The literal description of the item as it appears in the original listing document.
◦
recordType (string): The category or type of record for this item.
◦
startDate (string): The starting date covered by the item, if applicable.
◦
endDate (string): The ending date covered by the item, if applicable.
◦
volume (string): The volume number or identifier for this item, if part of a series.
◦
expectedCount (number): An estimate of the number of images anticipated for this item [Derived/Inferred].
◦
reconciliationStatus (string): The outcome of the reconciliation process for this specific item. The operator updates this (e.g., "Captured" if found and imaged, "Missing" if expected but not found) [Derived/Inferred from the reconciliation methodology].
◦
reconciliationNotes (string): Specific notes added by the operator or auditor during the reconciliation process for this particular item.
◦
capturedFolderId (string): A reference to the digital folder (/folders/{folderId}) containing the captured images for this item, if successfully captured [Derived/Inferred].
◦
capturedSequenceNumber (number): If the item is captured as part of a larger folder or starts at a specific point within a folder, this indicates the starting image sequence number [Derived/Inferred].
Real Example Data (application/json):
This example shows the response for a listing of records from a specific archive, including details for several expected volumes and their current reconciliation status.
{
  "listingId": "LST-ARCHIVE-001-20241101",
  "title": "Wayne County, Michigan - Birth Records (1850-1875)",
  "archive": "Michigan State Archive",
  "issuedDate": "2024-10-15T08:00:00Z",
  "status": "In Progress",
  "notes": "Listing approved for capture project P2024-MI-005.",
  "listedItems": [
    {
      "itemIdentifier": "ITEM-LST-001-VOL1",
      "listingDescription": "Volume 1 - Births 1850-1855",
      "recordType": "Birth certificate",
      "startDate": "1850",
      "endDate": "1855",
      "volume": "1",
      "expectedCount": 450,
      "reconciliationStatus": "Captured", // Operator marked this as captured
      "reconciliationNotes": "Captured as folder 004784308. Appears complete.",
      "capturedFolderId": "004784308",
      "capturedSequenceNumber": 1
    },
    {
      "itemIdentifier": "ITEM-LST-001-VOL2",
      "listingDescription": "Volume 2 - Births 1856-1860",
      "recordType": "Birth certificate",
      "startDate": "1856",
      "endDate": "1860",
      "volume": "2",
      "expectedCount": 480,
      "reconciliationStatus": "Missing - Not Available", // Operator couldn't find it
      "reconciliationNotes": "Archivist stated volume 2 was temporarily recalled for exhibit. Will attempt recapture later if available.",
      "capturedFolderId": null, // Not captured
      "capturedSequenceNumber": null
    },
    {
      "itemIdentifier": "ITEM-LST-001-VOL3",
      "listingDescription": "Volume 3 - Births 1861-1865",
      "recordType": "Birth certificate",
      "startDate": "1861",
      "endDate": "1865",
      "volume": "3",
      "expectedCount": 510,
      "reconciliationStatus": "Pending Capture", // Not yet attempted
      "reconciliationNotes": null,
      "capturedFolderId": null,
      "capturedSequenceNumber": null
    },
     {
      "itemIdentifier": "ITEM-LST-001-VOL4",
      "listingDescription": "Volume 4 - Births 1866-1870",
      "recordType": "Birth certificate",
      "startDate": "1866",
      "endDate": "1870",
      "volume": "4",
      "expectedCount": 530,
      "reconciliationStatus": "Captured", // Operator marked as captured
      "reconciliationNotes": "Captured as folder 004784309. Notes about torn pages captured in folder metadata.",
      "capturedFolderId": "004784309",
      "capturedSequenceNumber": 1
    }
  ]
}
This response structure aligns with the process flow where operators use the listing to guide capture and reconcile against the expected items, recording outcomes and notes for each listed item. It provides the necessary detail for managing the completeness standard section of the ACQUA guidelines related to listings.