Skip to content

Crawlers JSON Structure

Thibault Ehrhart edited this page Nov 27, 2020 · 6 revisions

Schema

All the crawlers share a common structure:

Property Description
id Unique ID of the record.
url URL to the record's page.
fields Array of label-value properties.
images Array of images.

The property fields is an array of objects which contain informations about the record (eg. name, description, dimensions, ...). The basic structure of a field is:

Property Description
label Label of the field.
value Single value for this field.
values Array of values for this field.

The structure of the property images is:

Property Description
id Unique ID of the image.
url Direct URL to the image.
title (Optional) Title of the image
description (Optional) Description of the image
author (Optional) Author/Photographer of the image
license (Optional) License string for this image

Example:

{
  "id": "<record id>",
  "url": "<record url>",
  "fields": [{
    "label": "field1",
    "value": "value1",
  }, {
    "label": "field2",
    "values": ["value1", "value2", "value3"]
  }],
  "images": [{
    "id": "image1",
    "url": "http://example.org/image1.jpg"
  }]
}

Crawlers specific structure

Some crawlers have extra informations which cannot be mapped to the fields property.

imatex

{
  "bibliography": ["...", "...", "..."],
  "expositions": ["...", "...", "..."],
  "otherPieces": [{
    "image": {
      "id": "0000003473",
      "url": "http://..."
    },
    "registerNumber": "2979",
    "dimensions": "22,5 x 17,5"
  }],
}

les-arts-decoratifs

This crawler has an extra field property named type.

{
  "fields": [{
    "type": "...",
    "label": "...",
    "values": ["..."]
  }]
}

risd-museum

{
  "publications": [{
    "url": "https://risdmuseum.org/art-design/projects-publications/publications/selected-works",
    "title": "Selected Works",
    "subtitle": ""
  }],
  "exhibitions": [{
    "url": "https://risdmuseum.org/exhibitions-events/exhibitions/insnared-flowers-i-fall-grass",
    "title": "“Insnared with flowers, I fall on grass\"",
    "date": "June 10, 2014 - March 8, 2015",
    "blurb": "With the establishment of its colonial trade center in Goa, India, in the early 16th century, Portugal was flooded with imported Indian luxury textiles, which left a distinct mark on furnishings such as this marriage quilt, or colcha. Abounding with painstakingly embroidered carnations and scrolling vines on a silk ground, it was either made in India for the Portuguese market or crafted in Portugal as a version of the Indian originals. The artisans who made this piece substituted the carnation—a flower indigenous to the Mediterranean—for a lotus-blossom motif that would have been more familiar to the Asian market."
  }, {
    "url": "https://risdmuseum.org/exhibitions-events/exhibitions/recent-acquisitions-4",
    "title": "Recent Acquisitions",
    "date": "February 18 - April 16, 2000",
    "blurb": "Once in a while, the Museum has the opportunity to purchase a masterpiece of great beauty. This 18th-century quilt, embroidered by women either in Portugal or in India for the Portuguese market, is just such an object. Quilts had been popular in Portugal since the 16th century, but the 18th century was the \"golden age\" of these embroideries. They were indispensable items in a bride's trousseau at all social levels, and examples exist from both rural and urban Portugal. This coverlet is of great elegance, made in silk instead of the more commonly used linen.  \nRISD's quilt is especially important because its source is known: it came from the collection of Portuguese Comandante Ernesto Vilhena, which was formed in the mid-20th century and sold in 1995. Several colchas from this collection are in the Museu Nacional de Arte Antiga in Lisbon, Portugal. In addition to its beauty, the coverlet gives an insight into the lives of Portuguese women in the 18th century, whose descendents are numerous in our own community today."
  }]
}
Clone this wiki locally